Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Доработает кодгайд под новые JavaScript-критерии #70

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions temp/1-cycle-exit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Циклы не работают дольше чем нужно, а количество их вызовов минимизировано.

Неправильно:

```js
apartments.forEach((it, index) => {
if (index < 3) {
render(it);
}
});
```

Правильно:

```js
for (let i = 0; i < Math.min(apartments.length, 3); i++) {
render(apartments[i]);
}
```

## Почему нужно соблюдать этот критерий?

Лишняя работа?
84 changes: 84 additions & 0 deletions temp/1-variable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
# Переменные названы по-английски, в единственном числе

<!-- Папки, файлы тоже надо включить -->
<!-- Посмотреть критерий у HTML -->

<!-- Выделить сокращения в отдельный критерий -->

К переменным относятся свойства классов и объектов, параметры функций. Словосочетания допустимы:

```js
const mascotName = 'Кекс';

const rectangle = {
width: 10,
length: 3,
height: 5
};

function calculateRectangleSquare (width, length) {
return width * length;
}
```

Для длинных слов можно использовать общепринятые сокращения: `cb` для единственного параметра-колбэка, `evt` для объектов события `Event`, `err` для объектов ошибок `Error`, `src`, `img`, `btn` и так далее.

Допускается использование «своих» сокращений, если они будут понятны проверяющему без объяснений.

_Например,_ сокращённое название `calcRectSquare` вместо `calculateRectangleSquare`:

```js
function calcRectSquare (width, length) {
return width * length;
}
```

Слова `calculate` и `Rectangle` сокращены до `calc` и `Rect` соответственно. Но что делает функция по-прежнему понятно, а название стало короче.

А вот попытки сократить название функции ещё нарушат критерий, потому что сокращения вроде `calcRSquare`, `calcRectSq`, `cRectSquare` или `cRS` нельзя однозначно разгадать.

**Обратите внимание,** в циклах и цикличных методах можно использовать однобуквенные переменные `i`, `j`, `k`, `l` для индексов.

## Почему нужно соблюдать этот критерий?

Сперва про английский язык. Всё просто — это стандарт. Разработчики во всём мире используют английский язык. Вы можете «встать в позу» и в своём проекте использовать транслит, код будет работать, но коллеги не оценят. В особенности иностранные коллеги. Если вы пока не знаете английский язык, пользуйтесь онлайн-переводчиком. Это нормально.

Теперь о сокращениях. Код читают программисты, компьютер лишь выполняет его. Все эти «читаемые имена» переменных нужны людям, и код вы пишете для людей. Относитесь к требованиями по именованию как к грамматике языка программирования. То, как разработчик следуюет требованиям, показывает насколько он образован.

Сравните транслит:

```js
const kvadrat = {
dlina: 10,
shirina: 3,
visota: 5
};

function poschitatPloschadKvadrata (dlina, shirina) {
return dlina * shirina;
}
```

С английским языком:

```js
const rectangle = {
width: 10,
length: 3,
height: 5
};

function calcRectSquare (width, length) {
return width * length;
}
```

Какой код проще читать? Думаю, ответ очевиден.

А теперь представьте, что разработчик не только пишет транслитом, но и сокращает имена: `pschttPlschdKvdrt`... Б-р-р.

Поначалу требования могут казаться странными. Это пройдёт, как только вам нужно будет разобраться в чужом коде, который игнорирует все требования. А разработчики гораздо чаще читают код, чем пишут. Причём чужой.

---

Правило «если сокращения будут понятны проверяющему без объяснений» не означает, что можно завернуть код студента по критерию, потому что вы привыкли использовать другое сокращение или полную форму слова. Если вам понятно, что кроется за именем переменной, критерий соблюдён.
39 changes: 39 additions & 0 deletions temp/2-collection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Переменные, содержащие коллекции, именуются во множественном числе

Неправильно:

```js
const age = [12, 40, 22, 7];
const name = ['Иван', 'Петр', 'Мария', 'Алексей'];

const wizard = {
name: 'Гендальф',
friend: ['Саурон', 'Фродо', 'Бильбо']
};

const listItem = document.querySelectorAll('ul li');
```

Правильно:

```js
const ages = [12, 40, 22, 7];
const names = ['Иван', 'Петр', 'Мария', 'Алексей'];

const wizard = {
name: 'Гендальф',
friends: ['Саурон', 'Фродо', 'Бильбо']
};

const listItems = document.querySelectorAll('ul li');
```

**Обратите внимание,** что слово `data` — это множественное число от слова `datum`, поэтому его использование в качестве имени переменной для массива корректно.

## Почему нужно соблюдать этот критерий?

Коллекции в JavaScript можно перебирать в циклах. Если правило соблюдается, удобно понять, что по переменной можно ситерироваться, даже не глядя в место объявления:

```js
listItems.forEach(() => {});
```
32 changes: 32 additions & 0 deletions temp/2-useless-condition.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# В проекте не должно быть избыточных проверок

Например, если заранее известно, что функция всегда принимает числовой параметр, то не следует проверять его на существование.

Неправильно:

```js
const isPositiveNumber = (myNumber) => {
if (typeof myNumber === 'undefined') {
throw new Error('Parameter is not defined');
}
return myNumber > 0;
};

isPositiveNumber(15);
isPositiveNumber(-30);
```

Правильно:

```js
const isPositiveNumber = (myNumber) => {
return myNumber > 0;
};

isPositiveNumber(15);
isPositiveNumber(-30);
```

## Почему нужно соблюдать этот критерий?

Лишняя работа?
67 changes: 67 additions & 0 deletions temp/3-function.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Функции именуются с глагола

Название функции или метода должно быть глаголом и соответствовать действию, которое выполняет функция или метод. Например, можно использовать глагол `get` для функций и методов, которые что-то возвращают.

Неправильно:

```js
const action = function (names) {
names.forEach((name) => {
console.log(name);
});
};

const wizard = {
name: 'Гендальф',
action() {
console.log('Стреляю файрболлом!');
}
};

const randomNumber = () => Math.random();
```

Правильно:

```js
const printNames = function (names) {
names.forEach((name) => {
console.log(name);
});
};

const wizard = {
name: 'Гендальф',
shoot() {
console.log('Стреляю файрболлом!');
}
};

const getRandomNumber = () => Math.random();
```

_Кстати,_ функции-предикаты — функции, которые возвращают булево значение — удобно именовать по схеме «`is` + признак»:

```js
function checkValueToNull(value) { // правильно
return value === null;
}

function isNull(value) { // тоже правильно
return value === null;
}
```

Предикаты, которые нельзя назвать с `is`, можно именовать с `has`:

```js
function hasOddNumber(values) {
return values.some(() => {});
}
```

**Важно!** Из правила существуют исключения: геттеры и сеттеры, редьюсеры.

## Почему нужно соблюдать этот критерий?

Отличие функции от обычной переменной, что функцию можно вызвать. Удобно, когда это понятно из названия, и не нужно искать объявление.
23 changes: 23 additions & 0 deletions temp/3-useless-typecheck.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Отсутствуют лишние приведения и проверки типов

Если заранее известно, что в переменной число, то нет смысла превращать переменную в число `parseInt(myNumber)`. То же касается и избыточной проверки булевой переменной.

Неправильно:

```js
if (booleanValue === true) {
console.log('It\'s true!');
}
```

Правильно:

```js
if (booleanValue) {
console.log('It\'s true!');
}
```

## Почему нужно соблюдать этот критерий?

Лишняя работа?
14 changes: 14 additions & 0 deletions temp/4-constant.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Константы записываются в нотации `UPPER_SNAKE_CASE`

Слова разделяются подчёркиваниями:

```js
const MAX_HEIGHT = 400;
const EARTH_RADIUS = 6370;
```

**Обратите внимание,** константа - это постоянное значение, а не всё, что объявлено через `const`.

## Почему нужно соблюдать этот критерий?

Константы показывают, что значение переменной не изменяется по ходу выполнения программы. Надёжно и удобно знать это заранее.
33 changes: 33 additions & 0 deletions temp/4-simplify.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Условия упрощены

Если функция возвращает булево значение, не используется `if..else` с лишними `return`.

Неправильно:

```js
const equals = (firstValue, secondValue) => {
if (firstValue === secondValue) {
return true;
} else {
return false;
}
};
```

Правильно:

```js
const equals = (firstValue, secondValue) => {
return firstValue === secondValue;
};
```

Идеально:

```js
const equals = (firstValue, secondValue) => firstValue === secondValue;
```

## Почему нужно соблюдать этот критерий?

Так принято?
Loading