Руководство по написанию JavaScript кода от Airbnb() {
Наиболее разумный подход к написанию JavaScript кода
![Gitter](https://badges.gitter.im/Join Chat.svg)
- Типы
- Ссылки
- Объекты
- Массивы
- Деструктуризация
- Строки
- Функции
- Стрелочные функции
- Классы и конструкторы
- Модули
- Итераторы и генераторы
- Свойства
- Переменные
- Подъем
- Операторы сравнения и равенства
- Блоки
- Комментарии
- Пробелы
- Запятые
- Точки с запятой
- Приведение типов
- Соглашение об именовании
- Аксессоры
- События
- jQuery
- ECMAScript 5 Совместимость
- ECMAScript 6+ (ES 2015+) Стили
- Тестирование
- Производительность
- Ресурсы
- В реальном мире
- Переводы
- Руководство по этому руководству
- Пообщаться о JS с разработчиками Airbnb
- Помощники
- Лицензия
-
1.1 Простые типы: Когда вы взаимодействуете с простым типом, вы напрямую работаете с его значением.
string
number
boolean
null
undefined
const foo = 1; let bar = foo; bar = 9; console.log(foo, bar); // => 1, 9
-
1.2 Сложные типы: Когда вы взаимодействуете со сложными типом, вы работаете с ссылкой на его значение.
object
array
function
const foo = [1, 2]; const bar = foo; bar[0] = 9; console.log(foo[0], bar[0]); // => 9, 9
-
2.1 Используйте
const
для всех ваших ссылок; избегайтеvar
. eslint:prefer-const
,no-const-assign
Почему? Это гарантирует, что вы не сможете переназначить ваши ссылки, которые могут привести к ошибкам и к усложнению понимания кода.
// плохо var a = 1; var b = 2; // хорошо const a = 1; const b = 2;
-
2.2 Если вам необходимо переназначить ссылки, используйте
let
вместоvar
. eslint:no-var
jscs:disallowVar
Почему? Область видимости
let
— блок, уvar
— функция.// плохо var count = 1; if (true) { count += 1; } // хорошо, используйте let. let count = 1; if (true) { count += 1; }
-
2.3 Помните, что у
let
иconst
блочная область видимости.// const и let существуют только в том блоке, в котором они определены { let a = 1; const b = 1; } console.log(a); // ReferenceError console.log(b); // ReferenceError
-
3.1 Для создания объекта используйте литеральную нотацию. eslint:
no-new-object
// плохо const item = new Object(); // хорошо const item = {};
-
3.2 Используйте вычисляемые имена свойств, когда создаете объекты с динамическими именами свойств.
Почему? Они позволяют вам определить все свойства объекта в одном месте.
function getKey(k) { return `a key named ${k}`; } // плохо const obj = { id: 5, name: 'San Francisco', }; obj[getKey('enabled')] = true; // хорошо const obj = { id: 5, name: 'San Francisco', [getKey('enabled')]: true, };
-
3.3 Используйте сокращенную запись метода объекта. eslint:
object-shorthand
jscs:requireEnhancedObjectLiterals
// плохо const atom = { value: 1, addValue: function (value) { return atom.value + value; }, }; // хорошо const atom = { value: 1, addValue(value) { return atom.value + value; }, };
-
3.4 Используйте сокращенную запись свойств объекта. eslint:
object-shorthand
jscs:requireEnhancedObjectLiterals
Почему? Это короче и понятнее.
const lukeSkywalker = 'Luke Skywalker'; // плохо const obj = { lukeSkywalker: lukeSkywalker, }; // хорошо const obj = { lukeSkywalker, };
-
3.5 Группируйте ваши сокращенные записи свойств в начале объявления объекта.
Почему? Проще сказать какие свойства используют сокращенную форму записи.
const anakinSkywalker = 'Anakin Skywalker'; const lukeSkywalker = 'Luke Skywalker'; // плохо const obj = { episodeOne: 1, twoJediWalkIntoACantina: 2, lukeSkywalker, episodeThree: 3, mayTheFourth: 4, anakinSkywalker, }; // хорошо const obj = { lukeSkywalker, anakinSkywalker, episodeOne: 1, twoJediWalkIntoACantina: 2, episodeThree: 3, mayTheFourth: 4, };
- 3.6 Только недопустимые идентификаторы помещаются в кавычки. eslint:
quote-props
jscs:disallowQuotedKeysInObjects
Почему? В целом мы считаем, что это субъективно легче читать. Это улучшает подсветку синтаксиса, а также облегчает оптимизацию для многих JS движков.
// плохо
const bad = {
'foo': 3,
'bar': 4,
'data-blah': 5,
};
// хорошо
const good = {
foo: 3,
bar: 4,
'data-blah': 5,
};
- 3.7 Не вызывать напрямую методы
Object.prototype
, а такжеhasOwnProperty
,propertyIsEnumerable
, иisPrototypeOf
.
Почему? These methods may be shadowed by properties on the object in question - consider
{ hasOwnProperty: false }
- or, the object may be a null object (Object.create(null)
).
// плохо
console.log(object.hasOwnProperty(key));
// хорошо
console.log(Object.prototype.hasOwnProperty.call(object, key));
// отлично
const has = Object.prototype.hasOwnProperty; // Кэшируем запрос в рамках модуля.
/* или */
import has from 'has';
…
console.log(has.call(object, key));
- 3.8 Выбирайте spread оператор вместо
Object.assign
для поверхностного копирования объектов. Используйте rest оператор, чтобы получить новый объект с некоторыми опущенными свойствами.
// очень плохо
const original = { a: 1, b: 2 };
const copy = Object.assign(original, { c: 3 }); // эта переменная изменяет `original` ಠ_ಠ
delete copy.a; // если делать так
// плохо
const original = { a: 1, b: 2 };
const copy = Object.assign({}, original, { c: 3 }); // copy => { a: 1, b: 2, c: 3 }
// хорошо
const original = { a: 1, b: 2 };
const copy = { ...original, c: 3 }; // copy => { a: 1, b: 2, c: 3 }
const { a, ...noA } = copy; // noA => { b: 2, c: 3 }
-
4.1 Для создания массива используйте литеральную нотацию. eslint:
no-array-constructor
// плохо const items = new Array(); // хорошо const items = [];
-
4.2 Для добавления элемента в массив используйте Array#push вместо прямого присваивания.
const someStack = []; // плохо someStack[someStack.length] = 'abracadabra'; // хорошо someStack.push('abracadabra');
-
4.3 Для копирования массивов используйте оператор расширения
...
.// плохо const len = items.length; const itemsCopy = []; let i; for (i = 0; i < len; i += 1) { itemsCopy[i] = items[i]; } // хорошо const itemsCopy = [...items];
-
4.4 Чтобы преобразовать массиво-подобный объект в массив, используйте Array.from.
const foo = document.querySelectorAll('.foo'); const nodes = Array.from(foo);
-
4.5 Используйте операторы return внутри функций обратного вызова в методах массива. Нормально пропускать
return
, если тело функции состоит из одной инструкции 8.2. eslint:array-callback-return
// хорошо [1, 2, 3].map((x) => { const y = x + 1; return x * y; }); // хорошо [1, 2, 3].map(x => x + 1); // плохо const flat = {}; [[0, 1], [2, 3], [4, 5]].reduce((memo, item, index) => { const flatten = memo.concat(item); flat[index] = flatten; }); // хорошо const flat = {}; [[0, 1], [2, 3], [4, 5]].reduce((memo, item, index) => { const flatten = memo.concat(item); flat[index] = flatten; return flatten; }); // плохо inbox.filter((msg) => { const { subject, author } = msg; if (subject === 'Mockingbird') { return author === 'Harper Lee'; } else { return false; } }); // хорошо inbox.filter((msg) => { const { subject, author } = msg; if (subject === 'Mockingbird') { return author === 'Harper Lee'; } return false; });
-
5.1 При обращении или использовании нескольких свойств объекта используйте деструктивное присваивание объекта. jscs:
requireObjectDestructuring
Почему? Деструктуризация сохраняет вас от создания временных ссылок для этих свойств.
// плохо function getFullName(user) { const firstName = user.firstName; const lastName = user.lastName; return `${firstName} ${lastName}`; } // хорошо function getFullName(user) { const { firstName, lastName } = user; return `${firstName} ${lastName}`; } // отлично function getFullName({ firstName, lastName }) { return `${firstName} ${lastName}`; }
-
5.2 Используйте деструктивное присваивание массивов. jscs:
requireArrayDestructuring
const arr = [1, 2, 3, 4]; // плохо const first = arr[0]; const second = arr[1]; // хорошо const [first, second] = arr;
-
5.3 Используйте деструктивное присваивание объекта для множества возвращаемых значений, но не делайте тоже с массивами. jscs:
disallowArrayDestructuringReturn
Почему? Вы можете добавить новые свойства через некоторое время или изменить порядок без последствий.
// плохо function processInput(input) { // затем происходит чудо return [left, right, top, bottom]; } // При вызове нужно подумать о порядке возвращаемых данных const [left, __, top] = processInput(input); // хорошо function processInput(input) { // затем происходит чудо return { left, right, top, bottom }; } // При вызове выбираем только необходимые данные const { left, top } = processInput(input);
-
6.1 Используйте одинарные кавычки
''
для строк. eslint:quotes
jscs:validateQuoteMarks
// плохо const name = "Capt. Janeway"; // плохо - литерал шаблонной строки должен содержать интерполяцию или переводы строк const name = `Capt. Janeway`; // хорошо const name = 'Capt. Janeway';
-
6.2 Строки, у которых в строчке содержится более 100 символов, не пишутся на нескольких строчках с использованием конкатенации.
Почему? Работать с разбитыми строками неудобно и это делает код трудным для поиска.
// плохо const errorMessage = 'This is a super long error that was thrown because \ of Batman. When you stop to think about how Batman had anything to do \ with this, you would get nowhere \ fast.'; // плохо const errorMessage = 'This is a super long error that was thrown because ' + 'of Batman. When you stop to think about how Batman had anything to do ' + 'with this, you would get nowhere fast.'; // хорошо const errorMessage = 'This is a super long error that was thrown because of Batman. When you stop to think about how Batman had anything to do with this, you would get nowhere fast.';
-
6.3 При создании строки программным путем, используйте шаблонные строки вместо конкатенации. eslint:
prefer-template
template-curly-spacing
jscs:requireTemplateStrings
Почему? Шаблонные строки дают вам читабельность, лаконичный синтаксис с правильными символами перевода строк и функциями интерполяции строки.
// плохо function sayHi(name) { return 'How are you, ' + name + '?'; } // плохо function sayHi(name) { return ['How are you, ', name, '?'].join(); } // плохо function sayHi(name) { return `How are you, ${ name }?`; } // хорошо function sayHi(name) { return `How are you, ${name}?`; }
- 6.4 Never use
eval()
on a string, it opens too many vulnerabilities.
-
6.5 Не используйте необязательные экранирующие символы в строках. eslint:
no-useless-escape
Почему? Обрытные косые черты ухудшают читабельность, поэтом они должны присутствовать только при необходимости.
// плохо const foo = '\'this\' \i\s \"quoted\"'; // хорошо const foo = '\'this\' is "quoted"'; const foo = `my name is '${name}'`;
-
7.1 Используйте функциональное выражение вместо объявлений функций. eslint:
func-style
jscs:requireFunctionDeclarations
Почему? Function declarations are hoisted, which means that it’s easy - too easy - to reference the function before it is defined in the file. This harms readability and maintainability. If you find that a function’s definition is large or complex enough that it is interfering with understanding the rest of the file, then perhaps it’s time to extract it to its own module! Don’t forget to name the expression - anonymous functions can make it harder to locate the problem in an Error's call stack. (Discussion)
// плохо const foo = function () { }; // плохо function foo() { } // хорошо const foo = function bar() { };
-
7.2 Оборачивайте в скобки самовызывающиеся функции. eslint:
wrap-iife
jscs:requireParenthesesAroundIIFE
Почему? An immediately invoked function expression is a single unit - wrapping both it, and its invocation parens, in parens, cleanly expresses this. Note that in a world with modules everywhere, you almost never need an IIFE.
// immediately-invoked function expression (IIFE) (function () { console.log('Welcome to the Internet. Please follow me.'); }());
- 7.3 Никогда не объявляйте фукнции в нефункциональном блоке (if, while, etc). Вместо это присвойте функцию переменной. Браузеры позволяют выполнить ваш код, но все они интерпретируют его по-разному. eslint:
no-loop-func
-
7.4 Примечание: ECMA-262 определяет блок как список инструкций. Объявление функции не является инструкцией. Подробнее в документе ECMA-262.
// плохо if (currentUser) { function test() { console.log('Nope.'); } } // хорошо let test; if (currentUser) { test = () => { console.log('Yup.'); }; }
-
7.5 Никогда не называйте параметр
arguments
. Он будет более приоритетным над объектомarguments
, который доступен для каждой функции.// плохо function nope(name, options, arguments) { // ...stuff... } // хорошо function yup(name, options, args) { // ...stuff... }
-
7.6 Никогда не используйте
arguments
, вместо этого используйте оператор расширения eslint:prefer-rest-params
Почему?
...
явно говорит о том, какие именно аргументы вы хотите вытащить. Кроме того, аргументы оператора расширения являются настоящим массивом, а не массиво-подобным какarguments
.// плохо function concatenateAll() { const args = Array.prototype.slice.call(arguments); return args.join(''); } // хорошо function concatenateAll(...args) { return args.join(''); }
-
7.7 Используйте синтаксис записи аргументов по умолчанию, а не изменяйте аргументы функции.
// очень плохо function handleThings(opts) { // Нет! Мы не должны изменять аргументы функции. // Плохо вдвойне: если переменная opts будет ложной, то ей присвоится пустой объект, а не то что // вы хотели. Это приведет к коварным ошибкам. opts = opts || {}; // ... } // все еще плохо function handleThings(opts) { if (opts === void 0) { opts = {}; } // ... } // хорошо function handleThings(opts = {}) { // ... }
-
7.8 Избегайте побочных эффектов с параметрами по умолчанию.
Почему? They are confusing to reason about.
var b = 1; // плохо function count(a = b++) { console.log(a); } count(); // 1 count(); // 2 count(3); // 3 count(); // 3
-
7.9 Всегда вставляйте последними параметры по умолчанию.
// плохо function handleThings(opts = {}, name) { // ... } // хорошо function handleThings(name, opts = {}) { // ... }
-
7.10 Никогда не используйте конструктор функций для создания новых функий. eslint:
no-new-func
Почему? Создание функции в таком духе вычисляет строку подобно eval(), из-за чего открываются уязвимости.
// плохо var add = new Function('a', 'b', 'return a + b'); // всё ещё плохо var subtract = Function('a', 'b', 'return a - b');
-
7.11 Оступы при определении функции. eslint:
space-before-function-paren
space-before-blocks
Почему? Хорошая консистенция, и вам не надо будет добавлять или удалять пробел добавления или удаления имя.
// плохо const f = function(){}; const g = function (){}; const h = function() {}; // хорошо const x = function () {}; const y = function a() {};
-
7.12 Никогда не изменяйте параметры. eslint:
no-param-reassign
Почему? Манипуляция объектами приходящие в параметры может вызывать нежелательные побочные эффекты в вызывающей функции.
// плохо function f1(obj) { obj.key = 1; }; // хорошо function f2(obj) { const key = Object.prototype.hasOwnProperty.call(obj, 'key') ? obj.key : 1; };
-
7.13 Никогда не перезначайте параметры. eslint:
no-param-reassign
Почему? Переназначенные параметры могут привести к неожиданному поведению, особенно при обращении к
arguments
. Это также может вызывать проблемы оптимизации, особенно в V8.// плохо function f1(a) { a = 1; } function f2(a) { if (!a) { a = 1; } } // хорошо function f3(a) { const b = a || 1; } function f4(a = 1) { }
-
7.14 Предпочитайте использовать оператор расширения
...
при вызове вариативной функции. eslint:prefer-spread
Почему? Это чище, вам не нужно предоставлять контекст, и не так просто составить
new
сapply
.// плохо const x = [1, 2, 3, 4, 5]; console.log.apply(console, x); // хорошо const x = [1, 2, 3, 4, 5]; console.log(...x); // плохо new (Function.prototype.bind.apply(Date, [null, 2016, 08, 05])); // хорошо new Date(...[2016, 08, 05]);
-
7.15 Функции с многострочним определением или запуском, должны содержать отступы как и другие многострочные списки в этом руководстве: с каждым элементом на отдельной строке, с запятой в конце.
// плохо function foo(bar, baz, quux) { // body } // хорошо function foo( bar, baz, quux, ) { // body } // плохо console.log(foo, bar, baz); // хорошо console.log( foo, bar, baz, );
-
8.1 Когда вам необходимо использовать функциональное выражение (например, как анонимную функцию), используйте стрелочную функцию. eslint:
prefer-arrow-callback
,arrow-spacing
jscs:requireArrowFunctions
Почему? Таким образом создаётся функция, которая выполняется в контексте
this
, которая обычно мы хотим, а также это более короткий синтаксис.Почему бы и нет? Если у вас есть довольно сложная функция, вы можете переместить её логику внутрь собственного объявления.
// плохо [1, 2, 3].map(function (x) { const y = x + 1; return x * y; }); // хорошо [1, 2, 3].map((x) => { const y = x + 1; return x * y; });
-
8.2 Если тело функции состоит из одного выражения, то опустите фигурные скобки и используйте неявное возвращение. В противном случае, сохраните фигурные скобки и используйте оператор
return
. eslint:arrow-parens
,arrow-body-style
jscs:disallowParenthesesAroundArrowParam
,requireShorthandArrowFunctions
Почему? Синтаксический сахар. Это читается лучше, когда несколько функций соединены вместе.
// плохо [1, 2, 3].map(number => { const nextNumber = number + 1; `A string containing the ${nextNumber}.`; }); // хорошо [1, 2, 3].map(number => `A string containing the ${number}.`); // хорошо [1, 2, 3].map((number) => { const nextNumber = number + 1; return `A string containing the ${nextNumber}.`; }); // хорошо [1, 2, 3].map((number, index) => ({ [index]: number }));
-
8.3 В случае, если выражение располагается на нескольких строках, то необходимо обернуть его в скобки для лучшей читаемости.
Почему? Это четко показывает, где функция начинается и где заканчивается.
// плохо ['get', 'post', 'put'].map(httpMethod => Object.prototype.hasOwnProperty.call( httpMagicObjectWithAVeryLongName, httpMethod ) ); // хорошо ['get', 'post', 'put'].map(httpMethod => ( Object.prototype.hasOwnProperty.call( httpMagicObjectWithAVeryLongName, httpMethod ) ));
-
8.4 Если ваша функция принимает один аргумент и не использует фигурные скобки, то опустите круглые скобки. В противном случае, всегда оборачивайте аргументы скобками. eslint:
arrow-parens
jscs:disallowParenthesesAroundArrowParam
Почему? Меньше визуального беспорядка.
// плохо [1, 2, 3].map((x) => x * x); // хорошо [1, 2, 3].map(x => x * x); // хорошо [1, 2, 3].map(number => ( `A long string with the ${number}. It’s so long that we don’t want it to take up space on the .map line!` )); // плохо [1, 2, 3].map(x => { const y = x + 1; return x * y; }); // хорошо [1, 2, 3].map((x) => { const y = x + 1; return x * y; });
-
8.5 Избегайте запутанной стрелочной функции (
=>
) с операторами сравнения (<=
,>=
). eslint:no-confusing-arrow
// плохо const itemHeight = item => item.height > 256 ? item.largeSize : item.smallSize; // плохо const itemHeight = (item) => item.height > 256 ? item.largeSize : item.smallSize; // хорошо const itemHeight = item => (item.height > 256 ? item.largeSize : item.smallSize); // хорошо const itemHeight = (item) => { const { height, largeSize, smallSize } = item; return height > 256 ? largeSize : smallSize; };
-
9.1 Always use
class
. Avoid manipulatingprototype
directly.Почему?
class
syntax is more concise and easier to reason about.// плохо function Queue(contents = []) { this.queue = [...contents]; } Queue.prototype.pop = function () { const value = this.queue[0]; this.queue.splice(0, 1); return value; }; // хорошо class Queue { constructor(contents = []) { this.queue = [...contents]; } pop() { const value = this.queue[0]; this.queue.splice(0, 1); return value; } }
-
9.2 Use
extends
for inheritance.Почему? It is a built-in way to inherit prototype functionality without breaking
instanceof
.// плохо const inherits = require('inherits'); function PeekableQueue(contents) { Queue.apply(this, contents); } inherits(PeekableQueue, Queue); PeekableQueue.prototype.peek = function () { return this._queue[0]; } // хорошо class PeekableQueue extends Queue { peek() { return this._queue[0]; } }
-
9.3 Methods can return
this
to help with method chaining.// плохо Jedi.prototype.jump = function () { this.jumping = true; return true; }; Jedi.prototype.setHeight = function (height) { this.height = height; }; const luke = new Jedi(); luke.jump(); // => true luke.setHeight(20); // => undefined // хорошо class Jedi { jump() { this.jumping = true; return this; } setHeight(height) { this.height = height; return this; } } const luke = new Jedi(); luke.jump() .setHeight(20);
-
9.4 It's okay to write a custom toString() method, just make sure it works successfully and causes no side effects.
class Jedi { constructor(options = {}) { this.name = options.name || 'no name'; } getName() { return this.name; } toString() { return `Jedi - ${this.getName()}`; } }
-
9.5 Classes have a default constructor if one is not specified. An empty constructor function or one that just delegates to a parent class is unnecessary. eslint:
no-useless-constructor
// плохо class Jedi { constructor() {} getName() { return this.name; } } // плохо class Rey extends Jedi { constructor(...args) { super(...args); } } // хорошо class Rey extends Jedi { constructor(...args) { super(...args); this.name = 'Rey'; } }
-
9.6 Avoid duplicate class members. eslint:
no-dupe-class-members
Почему? Duplicate class member declarations will silently prefer the last one - having duplicates is almost certainly a bug.
// плохо class Foo { bar() { return 1; } bar() { return 2; } } // хорошо class Foo { bar() { return 1; } } // хорошо class Foo { bar() { return 2; } }
-
10.1 Always use modules (
import
/export
) over a non-standard module system. You can always transpile to your preferred module system.Почему? Modules are the future, let's start using the future now.
// плохо const AirbnbStyleGuide = require('./AirbnbStyleGuide'); module.exports = AirbnbStyleGuide.es6; // ok import AirbnbStyleGuide from './AirbnbStyleGuide'; export default AirbnbStyleGuide.es6; // отлично import { es6 } from './AirbnbStyleGuide'; export default es6;
-
10.2 Do not use wildcard imports.
Почему? This makes sure you have a single default export.
// плохо import * as AirbnbStyleGuide from './AirbnbStyleGuide'; // хорошо import AirbnbStyleGuide from './AirbnbStyleGuide';
-
10.3 And do not export directly from an import.
Почему? Although the one-liner is concise, having one clear way to import and one clear way to export makes things consistent.
// плохо // filename es6.js export { es6 as default } from './AirbnbStyleGuide'; // хорошо // filename es6.js import { es6 } from './AirbnbStyleGuide'; export default es6;
-
10.4 Only import from a path in one place. eslint:
no-duplicate-imports
Почему? Having multiple lines that import from the same path can make code harder to maintain.
// плохо import foo from 'foo'; // … some other imports … // import { named1, named2 } from 'foo'; // хорошо import foo, { named1, named2 } from 'foo'; // хорошо import foo, { named1, named2, } from 'foo';
-
10.5 Do not export mutable bindings. eslint:
import/no-mutable-exports
Почему? Mutation should be avoided in general, but in particular when exporting mutable bindings. While this technique may be needed for some special cases, in general, only constant references should be exported.
// плохо let foo = 3; export { foo } // хорошо const foo = 3; export { foo }
-
10.6 In modules with a single export, prefer default export over named export. eslint:
import/prefer-default-export
// плохо export function foo() {} // хорошо export default function foo() {}
-
10.7 Put all
import
s above non-import statements. eslint:import/first
Почему? Since
import
s are hoisted, keeping them all at the top prevents surprising behavior.// плохо import foo from 'foo'; foo.init(); import bar from 'bar'; // хорошо import foo from 'foo'; import bar from 'bar'; foo.init();
-
10.8 Multiline imports should be indented just like multiline array and object literals.
Почему? The curly braces follow the same indentation rules as every other curly brace block in the style guide, as do the trailing commas.
// плохо import {longNameA, longNameB, longNameC, longNameD, longNameE} from 'path'; // хорошо import { longNameA, longNameB, longNameC, longNameD, longNameE, } from 'path';
-
10.9 Disallow Webpack loader syntax in module import statements. eslint:
import/no-webpack-loader-syntax
Почему? Since using Webpack syntax in the imports couples the code to a module bundler. Prefer using the loader syntax in
webpack.config.js
.// плохо import fooSass from 'css!sass!foo.scss'; import barCss from 'style!css!bar.css'; // хорошо import fooSass from 'foo.scss'; import barCss from 'bar.css';
-
11.1 Не используйте итераторы. Применяйте функции высшего порядка вместо таких циклов как
for-in
илиfor-of
. eslint:no-iterator
no-restricted-syntax
Почему? Это обеспечивает соблюдение нашего правила об иммутабельности. Работать с чистыми функциями, которые возвращают значение, лучше для понимания, чем с функциями с побочными эффектами.
Используйте
map()
/every()
/filter()
/find()
/findIndex()
/reduce()
/some()
/ ... для итерации по массивам, аObject.keys()
/Object.values()
/Object.entries()
для создания массивов, с помощью которых можно итерироваться по объектам.const numbers = [1, 2, 3, 4, 5]; // плохо let sum = 0; for (let num of numbers) { sum += num; } sum === 15; // хорошо let sum = 0; numbers.forEach(num => sum += num); sum === 15; // отлично (используйте силу функций) const sum = numbers.reduce((total, num) => total + num, 0); sum === 15; // плохо const increasedByOne = []; for (let i = 0; i < numbers.length; i++) { modified.push(numbers[i] + 1); } // хорошо const increasedByOne = []; numbers.forEach(num => modified.push(num + 1)); // отлично (продолжайте в том же духе) const increasedByOne = numbers.map(num => num + 1);
-
11.2 Не используйте пока генераторы.
Почему? Они не очень хорошо транспилируются в ES5.
-
11.3 Если все-таки необходимо использовать генераторы, или вы не обратили внимания на наш совет, убедитесь, что
*
у функции генератора расположена должным образом. eslint:generator-star-spacing
Почему?
function
и*
являются частью одного и того же ключевого слова.*
не является модификатором дляfunction
,function*
является уникальной конструкцией, отличной отfunction
.// плохо function * foo() { } const bar = function * () { } const baz = function *() { } const quux = function*() { } function*foo() { } function *foo() { } // очень плохо function * foo() { } const wat = function * () { } // хорошо function* foo() { } const foo = function* () { }
-
12.1 Use dot notation when accessing properties. eslint:
dot-notation
jscs:requireDotNotation
const luke = { jedi: true, age: 28, }; // плохо const isJedi = luke['jedi']; // хорошо const isJedi = luke.jedi;
-
12.2 Use bracket notation
[]
when accessing properties with a variable.const luke = { jedi: true, age: 28, }; function getProp(prop) { return luke[prop]; } const isJedi = getProp('jedi');
-
13.1 Always use
const
to declare variables. Not doing so will result in global variables. We want to avoid polluting the global namespace. Captain Planet warned us of that. eslint:no-undef
prefer-const
// плохо superPower = new SuperPower(); // хорошо const superPower = new SuperPower();
-
13.2 Use one
const
declaration per variable. eslint:one-var
jscs:disallowMultipleVarDecl
Почему? It's easier to add new variable declarations this way, and you never have to worry about swapping out a
;
for a,
or introducing punctuation-only diffs. You can also step through each declaration with the debugger, instead of jumping through all of them at once.// плохо const items = getItems(), goSportsTeam = true, dragonball = 'z'; // плохо // (compare to above, and try to spot the mistake) const items = getItems(), goSportsTeam = true; dragonball = 'z'; // хорошо const items = getItems(); const goSportsTeam = true; const dragonball = 'z';
-
13.3 Group all your
const
s and then group all yourlet
s.Почему? This is helpful when later on you might need to assign a variable depending on one of the previous assigned variables.
// плохо let i, len, dragonball, items = getItems(), goSportsTeam = true; // плохо let i; const items = getItems(); let dragonball; const goSportsTeam = true; let len; // хорошо const goSportsTeam = true; const items = getItems(); let dragonball; let i; let length;
-
13.4 Assign variables where you need them, but place them in a reasonable place.
Почему?
let
andconst
are block scoped and not function scoped.// плохо - unnecessary function call function checkName(hasName) { const name = getName(); if (hasName === 'test') { return false; } if (name === 'test') { this.setName(''); return false; } return name; } // хорошо function checkName(hasName) { if (hasName === 'test') { return false; } const name = getName(); if (name === 'test') { this.setName(''); return false; } return name; }
-
13.5 Don't chain variable assignments.
Почему? Chaining variable assignments creates implicit global variables.
// плохо (function example() { // JavaScript interprets this as // let a = ( b = ( c = 1 ) ); // The let keyword only applies to variable a; variables b and c become // global variables. let a = b = c = 1; }()); console.log(a); // undefined console.log(b); // 1 console.log(c); // 1 // хорошо (function example() { let a = 1; let b = a; let c = a; }()); console.log(a); // undefined console.log(b); // undefined console.log(c); // undefined // the same applies for `const`
-
13.6 Avoid using unary increments and decrements (++, --). eslint
no-plusplus
Почему? Per the eslint documentation, unary increment and decrement statements are subject to automatic semicolon insertion and can cause silent errors with incrementing or decrementing values within an application. It is also more expressive to mutate your values with statements like
num += 1
instead ofnum++
ornum ++
. Disallowing unary increment and decrement statements also prevents you from pre-incrementing/pre-decrementing values unintentionally which can also cause unexpected behavior in your programs.// плохо let array = [1, 2, 3]; let num = 1; num++; --num; let sum = 0; let truthyCount = 0; for(let i = 0; i < array.length; i++){ let value = array[i]; sum += value; if (value) { truthyCount++; } } // хорошо let array = [1, 2, 3]; let num = 1; num += 1; num -= 1; const sum = array.reduce((a, b) => a + b, 0); const truthyCount = array.filter(Boolean).length;
-
14.1
var
declarations get hoisted to the top of their scope, their assignment does not.const
andlet
declarations are blessed with a new concept called Temporal Dead Zones (TDZ). It's important to know why typeof is no longer safe.// we know this wouldn't work (assuming there // is no notDefined global variable) function example() { console.log(notDefined); // => throws a ReferenceError } // creating a variable declaration after you // reference the variable will work due to // variable hoisting. Note: the assignment // value of `true` is not hoisted. function example() { console.log(declaredButNotAssigned); // => undefined var declaredButNotAssigned = true; } // the interpreter is hoisting the variable // declaration to the top of the scope, // which means our example could be rewritten as: function example() { let declaredButNotAssigned; console.log(declaredButNotAssigned); // => undefined declaredButNotAssigned = true; } // using const and let function example() { console.log(declaredButNotAssigned); // => throws a ReferenceError console.log(typeof declaredButNotAssigned); // => throws a ReferenceError const declaredButNotAssigned = true; }
-
14.2 Anonymous function expressions hoist their variable name, but not the function assignment.
function example() { console.log(anonymous); // => undefined anonymous(); // => TypeError anonymous is not a function var anonymous = function () { console.log('anonymous function expression'); }; }
-
14.3 Named function expressions hoist the variable name, not the function name or the function body.
function example() { console.log(named); // => undefined named(); // => TypeError named is not a function superPower(); // => ReferenceError superPower is not defined var named = function superPower() { console.log('Flying'); }; } // the same is true when the function name // is the same as the variable name. function example() { console.log(named); // => undefined named(); // => TypeError named is not a function var named = function named() { console.log('named'); } }
-
14.4 Function declarations hoist their name and the function body.
function example() { superPower(); // => Flying function superPower() { console.log('Flying'); } }
-
For more information refer to JavaScript Scoping & Hoisting by Ben Cherry.
-
15.2 Conditional statements such as the
if
statement evaluate their expression using coercion with theToBoolean
abstract method and always follow these simple rules:- Objects evaluate to true
- Undefined evaluates to false
- Null evaluates to false
- Booleans evaluate to the value of the boolean
- Numbers evaluate to false if +0, -0, or NaN, otherwise true
- Strings evaluate to false if an empty string
''
, otherwise true
if ([0] && []) { // true // an array (even an empty one) is an object, objects will evaluate to true }
-
15.3 Use shortcuts for booleans, but explicit comparisons for strings and numbers.
// плохо if (isValid === true) { // ...stuff... } // хорошо if (isValid) { // ...stuff... } // плохо if (name) { // ...stuff... } // хорошо if (name !== '') { // ...stuff... } // плохо if (collection.length) { // ...stuff... } // хорошо if (collection.length > 0) { // ...stuff... }
- 15.4 For more information see Truth Equality and JavaScript by Angus Croll.
- 15.5 Use braces to create blocks in
case
anddefault
clauses that contain lexical declarations (e.g.let
,const
,function
, andclass
).
Почему? Lexical declarations are visible in the entire
switch
block but only get initialized when assigned, which only happens when itscase
is reached. This causes problems when multiplecase
clauses attempt to define the same thing.
eslint rules: no-case-declarations
.
```javascript
// плохо
switch (foo) {
case 1:
let x = 1;
break;
case 2:
const y = 2;
break;
case 3:
function f() {}
break;
default:
class C {}
}
// хорошо
switch (foo) {
case 1: {
let x = 1;
break;
}
case 2: {
const y = 2;
break;
}
case 3: {
function f() {}
break;
}
case 4:
bar();
break;
default: {
class C {}
}
}
```
-
15.6 Ternaries should not be nested and generally be single line expressions.
eslint rules:
no-nested-ternary
.// плохо const foo = maybe1 > maybe2 ? "bar" : value1 > value2 ? "baz" : null; // better const maybeNull = value1 > value2 ? 'baz' : null; const foo = maybe1 > maybe2 ? 'bar' : maybeNull; // отлично const maybeNull = value1 > value2 ? 'baz' : null; const foo = maybe1 > maybe2 ? 'bar' : maybeNull;
-
15.7 Avoid unneeded ternary statements.
eslint rules:
no-unneeded-ternary
.// плохо const foo = a ? a : b; const bar = c ? true : false; const baz = c ? false : true; // хорошо const foo = a || b; const bar = !!c; const baz = !c;
-
16.1 Use braces with all multi-line blocks.
// плохо if (test) return false; // хорошо if (test) return false; // хорошо if (test) { return false; } // плохо function foo() { return false; } // хорошо function bar() { return false; }
-
16.2 If you're using multi-line blocks with
if
andelse
, putelse
on the same line as yourif
block's closing brace. eslint:brace-style
jscs:disallowNewlineBeforeBlockStatements
// плохо if (test) { thing1(); thing2(); } else { thing3(); } // хорошо if (test) { thing1(); thing2(); } else { thing3(); }
-
17.1 Use
/** ... */
for multi-line comments.// плохо // make() returns a new element // based on the passed in tag name // // @param {String} tag // @return {Element} element function make(tag) { // ...stuff... return element; } // хорошо /** * make() returns a new element * based on the passed-in tag name */ function make(tag) { // ...stuff... return element; }
-
17.2 Use
//
for single line comments. Place single line comments on a newline above the subject of the comment. Put an empty line before the comment unless it's on the first line of a block.// плохо const active = true; // is current tab // хорошо // is current tab const active = true; // плохо function getType() { console.log('fetching type...'); // set the default type to 'no type' const type = this._type || 'no type'; return type; } // хорошо function getType() { console.log('fetching type...'); // set the default type to 'no type' const type = this._type || 'no type'; return type; } // also good function getType() { // set the default type to 'no type' const type = this._type || 'no type'; return type; }
-
17.3 Start all comments with a space to make it easier to read. eslint:
spaced-comment
// плохо //is current tab const active = true; // хорошо // is current tab const active = true; // плохо /** *make() returns a new element *based on the passed-in tag name */ function make(tag) { // ...stuff... return element; } // хорошо /** * make() returns a new element * based on the passed-in tag name */ function make(tag) { // ...stuff... return element; }
- 17.4 Prefixing your comments with
FIXME
orTODO
helps other developers quickly understand if you're pointing out a problem that needs to be revisited, or if you're suggesting a solution to the problem that needs to be implemented. These are different than regular comments because they are actionable. The actions areFIXME: -- need to figure this out
orTODO: -- need to implement
.
-
17.5 Use
// FIXME:
to annotate problems.class Calculator extends Abacus { constructor() { super(); // FIXME: shouldn't use a global here total = 0; } }
-
17.6 Use
// TODO:
to annotate solutions to problems.class Calculator extends Abacus { constructor() { super(); // TODO: total should be configurable by an options param this.total = 0; } }
-
18.1 Use soft tabs set to 2 spaces. eslint:
indent
jscs:validateIndentation
// плохо function foo() { ∙∙∙∙const name; } // плохо function bar() { ∙const name; } // хорошо function baz() { ∙∙const name; }
-
18.2 Place 1 space before the leading brace. eslint:
space-before-blocks
jscs:requireSpaceBeforeBlockStatements
// плохо function test(){ console.log('test'); } // хорошо function test() { console.log('test'); } // плохо dog.set('attr',{ age: '1 year', breed: 'Bernese Mountain Dog', }); // хорошо dog.set('attr', { age: '1 year', breed: 'Bernese Mountain Dog', });
-
18.3 Place 1 space before the opening parenthesis in control statements (
if
,while
etc.). Place no space between the argument list and the function name in function calls and declarations. eslint:keyword-spacing
jscs:requireSpaceAfterKeywords
// плохо if(isJedi) { fight (); } // хорошо if (isJedi) { fight(); } // плохо function fight () { console.log ('Swooosh!'); } // хорошо function fight() { console.log('Swooosh!'); }
-
18.4 Set off operators with spaces. eslint:
space-infix-ops
jscs:requireSpaceBeforeBinaryOperators
,requireSpaceAfterBinaryOperators
// плохо const x=y+5; // хорошо const x = y + 5;
-
18.5 End files with a single newline character. eslint:
eol-last
// плохо import { es6 } from './AirbnbStyleGuide'; // ... export default es6;
// плохо import { es6 } from './AirbnbStyleGuide'; // ... export default es6;↵ ↵
// хорошо import { es6 } from './AirbnbStyleGuide'; // ... export default es6;↵
-
18.6 Use indentation when making long method chains (more than 2 method chains). Use a leading dot, which emphasizes that the line is a method call, not a new statement. eslint:
newline-per-chained-call
no-whitespace-before-property
// плохо $('#items').find('.selected').highlight().end().find('.open').updateCount(); // плохо $('#items'). find('.selected'). highlight(). end(). find('.open'). updateCount(); // хорошо $('#items') .find('.selected') .highlight() .end() .find('.open') .updateCount(); // плохо const leds = stage.selectAll('.led').data(data).enter().append('svg:svg').classed('led', true) .attr('width', (radius + margin) * 2).append('svg:g') .attr('transform', `translate(${radius + margin},${radius + margin})`) .call(tron.led); // хорошо const leds = stage.selectAll('.led') .data(data) .enter().append('svg:svg') .classed('led', true) .attr('width', (radius + margin) * 2) .append('svg:g') .attr('transform', `translate(${radius + margin},${radius + margin})`) .call(tron.led); // хорошо const leds = stage.selectAll('.led').data(data);
-
18.7 Leave a blank line after blocks and before the next statement. jscs:
requirePaddingNewLinesAfterBlocks
// плохо if (foo) { return bar; } return baz; // хорошо if (foo) { return bar; } return baz; // плохо const obj = { foo() { }, bar() { }, }; return obj; // хорошо const obj = { foo() { }, bar() { }, }; return obj; // плохо const arr = [ function foo() { }, function bar() { }, ]; return arr; // хорошо const arr = [ function foo() { }, function bar() { }, ]; return arr;
-
18.8 Do not pad your blocks with blank lines. eslint:
padded-blocks
jscs:disallowPaddingNewlinesInBlocks
// плохо function bar() { console.log(foo); } // also bad if (baz) { console.log(qux); } else { console.log(foo); } // хорошо function bar() { console.log(foo); } // хорошо if (baz) { console.log(qux); } else { console.log(foo); }
-
18.9 Do not add spaces inside parentheses. eslint:
space-in-parens
jscs:disallowSpacesInsideParentheses
// плохо function bar( foo ) { return foo; } // хорошо function bar(foo) { return foo; } // плохо if ( foo ) { console.log(foo); } // хорошо if (foo) { console.log(foo); }
-
18.10 Do not add spaces inside brackets. eslint:
array-bracket-spacing
jscs:disallowSpacesInsideArrayBrackets
// плохо const foo = [ 1, 2, 3 ]; console.log(foo[ 0 ]); // хорошо const foo = [1, 2, 3]; console.log(foo[0]);
-
18.11 Add spaces inside curly braces. eslint:
object-curly-spacing
jscs:requireSpacesInsideObjectBrackets
// плохо const foo = {clark: 'kent'}; // хорошо const foo = { clark: 'kent' };
-
18.12 Avoid having lines of code that are longer than 100 characters (including whitespace). Note: per above, long strings are exempt from this rule, and should not be broken up. eslint:
max-len
jscs:maximumLineLength
Почему? This ensures readability and maintainability.
// плохо const foo = jsonData && jsonData.foo && jsonData.foo.bar && jsonData.foo.bar.baz && jsonData.foo.bar.baz.quux && jsonData.foo.bar.baz.quux.xyzzy; // плохо $.ajax({ method: 'POST', url: 'https://airbnb.com/', data: { name: 'John' } }).done(() => console.log('Congratulations!')).fail(() => console.log('You have failed this city.')); // хорошо const foo = jsonData && jsonData.foo && jsonData.foo.bar && jsonData.foo.bar.baz && jsonData.foo.bar.baz.quux && jsonData.foo.bar.baz.quux.xyzzy; // хорошо $.ajax({ method: 'POST', url: 'https://airbnb.com/', data: { name: 'John' }, }) .done(() => console.log('Congratulations!')) .fail(() => console.log('You have failed this city.'));
-
19.1 Leading commas: Nope. eslint:
comma-style
jscs:requireCommaBeforeLineBreak
// плохо const story = [ once , upon , aTime ]; // хорошо const story = [ once, upon, aTime, ]; // плохо const hero = { firstName: 'Ada' , lastName: 'Lovelace' , birthYear: 1815 , superPower: 'computers' }; // хорошо const hero = { firstName: 'Ada', lastName: 'Lovelace', birthYear: 1815, superPower: 'computers', };
-
19.2 Additional trailing comma: Yup. eslint:
comma-dangle
jscs:requireTrailingComma
Почему? This leads to cleaner git diffs. Also, transpilers like Babel will remove the additional trailing comma in the transpiled code which means you don't have to worry about the trailing comma problem in legacy browsers.
// плохо - git diff without trailing comma const hero = { firstName: 'Florence', - lastName: 'Nightingale' + lastName: 'Nightingale', + inventorOf: ['coxcomb chart', 'modern nursing'] }; // хорошо - git diff with trailing comma const hero = { firstName: 'Florence', lastName: 'Nightingale', + inventorOf: ['coxcomb chart', 'modern nursing'], };
// плохо const hero = { firstName: 'Dana', lastName: 'Scully' }; const heroes = [ 'Batman', 'Superman' ]; // хорошо const hero = { firstName: 'Dana', lastName: 'Scully', }; const heroes = [ 'Batman', 'Superman', ]; // плохо function createHero( firstName, lastName, inventorOf ) { // does nothing } // хорошо function createHero( firstName, lastName, inventorOf, ) { // does nothing } // хорошо (note that a comma must not appear after a "rest" element) function createHero( firstName, lastName, inventorOf, ...heroArgs ) { // does nothing } // плохо createHero( firstName, lastName, inventorOf ); // хорошо createHero( firstName, lastName, inventorOf, ); // хорошо (note that a comma must not appear after a "rest" element) createHero( firstName, lastName, inventorOf, ...heroArgs )
-
20.1 Yup. eslint:
semi
jscs:requireSemicolons
// плохо (function () { const name = 'Skywalker' return name })() // хорошо (function () { const name = 'Skywalker'; return name; }()); // хорошо, but legacy (guards against the function becoming an argument when two files with IIFEs are concatenated) ;(() => { const name = 'Skywalker'; return name; }());
- 21.1 Perform type coercion at the beginning of the statement.
-
21.2 Strings:
// => this.reviewScore = 9; // плохо const totalScore = this.reviewScore + ''; // invokes this.reviewScore.valueOf() // плохо const totalScore = this.reviewScore.toString(); // isn't guaranteed to return a string // хорошо const totalScore = String(this.reviewScore);
-
21.3 Numbers: Use
Number
for type casting andparseInt
always with a radix for parsing strings. eslint:radix
const inputValue = '4'; // плохо const val = new Number(inputValue); // плохо const val = +inputValue; // плохо const val = inputValue >> 0; // плохо const val = parseInt(inputValue); // хорошо const val = Number(inputValue); // хорошо const val = parseInt(inputValue, 10);
-
21.4 If for whatever reason you are doing something wild and
parseInt
is your bottleneck and need to use Bitshift for performance reasons, leave a comment explaining why and what you're doing.// хорошо /** * parseInt was the reason my code was slow. * Bitshifting the String to coerce it to a * Number made it a lot faster. */ const val = inputValue >> 0;
-
21.5 Note: Be careful when using bitshift operations. Numbers are represented as 64-bit values, but bitshift operations always return a 32-bit integer (source). Bitshift can lead to unexpected behavior for integer values larger than 32 bits. Discussion. Largest signed 32-bit Int is 2,147,483,647:
2147483647 >> 0 //=> 2147483647 2147483648 >> 0 //=> -2147483648 2147483649 >> 0 //=> -2147483647
-
21.6 Booleans:
const age = 0; // плохо const hasAge = new Boolean(age); // хорошо const hasAge = Boolean(age); // отлично const hasAge = !!age;
-
22.1 Avoid single letter names. Be descriptive with your naming. eslint:
id-length
// плохо function q() { // ...stuff... } // хорошо function query() { // ..stuff.. }
-
22.2 Use camelCase when naming objects, functions, and instances. eslint:
camelcase
jscs:requireCamelCaseOrUpperCaseIdentifiers
// плохо const OBJEcttsssss = {}; const this_is_my_object = {}; function c() {} // хорошо const thisIsMyObject = {}; function thisIsMyFunction() {}
-
22.3 Use PascalCase only when naming constructors or classes. eslint:
new-cap
jscs:requireCapitalizedConstructors
// плохо function user(options) { this.name = options.name; } const bad = new user({ name: 'nope', }); // хорошо class User { constructor(options) { this.name = options.name; } } const good = new User({ name: 'yup', });
-
22.4 Do not use trailing or leading underscores. eslint:
no-underscore-dangle
jscs:disallowDanglingUnderscores
Почему? JavaScript does not have the concept of privacy in terms of properties or methods. Although a leading underscore is a common convention to mean “private”, in fact, these properties are fully public, and as such, are part of your public API contract. This convention might lead developers to wrongly think that a change won't count as breaking, or that tests aren't needed. tl;dr: if you want something to be “private”, it must not be observably present.
// плохо this.__firstName__ = 'Panda'; this.firstName_ = 'Panda'; this._firstName = 'Panda'; // хорошо this.firstName = 'Panda';
-
22.5 Don't save references to
this
. Use arrow functions or Function#bind. jscs:disallowNodeTypes
// плохо function foo() { const self = this; return function () { console.log(self); }; } // плохо function foo() { const that = this; return function () { console.log(that); }; } // хорошо function foo() { return () => { console.log(this); }; }
-
22.6 A base filename should exactly match the name of its default export.
// file 1 contents class CheckBox { // ... } export default CheckBox; // file 2 contents export default function fortyTwo() { return 42; } // file 3 contents export default function insideDirectory() {} // in some other file // плохо import CheckBox from './checkBox'; // PascalCase import/export, camelCase filename import FortyTwo from './FortyTwo'; // PascalCase import/filename, camelCase export import InsideDirectory from './InsideDirectory'; // PascalCase import/filename, camelCase export // плохо import CheckBox from './check_box'; // PascalCase import/export, snake_case filename import forty_two from './forty_two'; // snake_case import/filename, camelCase export import inside_directory from './inside_directory'; // snake_case import, camelCase export import index from './inside_directory/index'; // requiring the index file explicitly import insideDirectory from './insideDirectory/index'; // requiring the index file explicitly // хорошо import CheckBox from './CheckBox'; // PascalCase export/import/filename import fortyTwo from './fortyTwo'; // camelCase export/import/filename import insideDirectory from './insideDirectory'; // camelCase export/import/directory name/implicit "index" // ^ supports both insideDirectory.js and insideDirectory/index.js
-
22.7 Use camelCase when you export-default a function. Your filename should be identical to your function's name.
function makeStyleGuide() { } export default makeStyleGuide;
-
22.8 Use PascalCase when you export a constructor / class / singleton / function library / bare object.
const AirbnbStyleGuide = { es6: { } }; export default AirbnbStyleGuide;
-
22.9 Acronyms and initialisms should always be all capitalized, or all lowercased.
Почему? Names are for readability, not to appease a computer algorithm.
// плохо import SmsContainer from './containers/SmsContainer'; // плохо const HttpRequests = [ // ... ]; // хорошо import SMSContainer from './containers/SMSContainer'; // хорошо const HTTPRequests = [ // ... ]; // отлично import TextMessageContainer from './containers/TextMessageContainer'; // отлично const Requests = [ // ... ];
- 23.1 Accessor functions for properties are not required.
-
23.2 Do not use JavaScript getters/setters as they cause unexpected side effects and are harder to test, maintain, and reason about. Instead, if you do make accessor functions, use getVal() and setVal('hello').
// плохо class Dragon { get age() { // ... } set age(value) { // ... } } // хорошо class Dragon { getAge() { // ... } setAge(value) { // ... } }
-
23.3 If the property/method is a
boolean
, useisVal()
orhasVal()
.// плохо if (!dragon.age()) { return false; } // хорошо if (!dragon.hasAge()) { return false; }
-
23.4 It's okay to create get() and set() functions, but be consistent.
class Jedi { constructor(options = {}) { const lightsaber = options.lightsaber || 'blue'; this.set('lightsaber', lightsaber); } set(key, val) { this[key] = val; } get(key) { return this[key]; } }
-
24.1 When attaching data payloads to events (whether DOM events or something more proprietary like Backbone events), pass a hash instead of a raw value. This allows a subsequent contributor to add more data to the event payload without finding and updating every handler for the event. For example, instead of:
// плохо $(this).trigger('listingUpdated', listing.id); ... $(this).on('listingUpdated', (e, listingId) => { // do something with listingId });
prefer:
// хорошо $(this).trigger('listingUpdated', { listingId: listing.id }); ... $(this).on('listingUpdated', (e, data) => { // do something with data.listingId });
-
25.1 Prefix jQuery object variables with a
$
. jscs:requireDollarBeforejQueryAssignment
// плохо const sidebar = $('.sidebar'); // хорошо const $sidebar = $('.sidebar'); // хорошо const $sidebarBtn = $('.sidebar-btn');
-
25.2 Cache jQuery lookups.
// плохо function setSidebar() { $('.sidebar').hide(); // ...stuff... $('.sidebar').css({ 'background-color': 'pink' }); } // хорошо function setSidebar() { const $sidebar = $('.sidebar'); $sidebar.hide(); // ...stuff... $sidebar.css({ 'background-color': 'pink' }); }
-
25.4 Use
find
with scoped jQuery object queries.// плохо $('ul', '.sidebar').hide(); // плохо $('.sidebar').find('ul').hide(); // хорошо $('.sidebar ul').hide(); // хорошо $('.sidebar > ul').hide(); // хорошо $sidebar.find('ul').hide();
- 26.1 Refer to Kangax's ES5 compatibility table.
- 27.1 This is a collection of links to the various ES6 features.
- Arrow Functions
- Classes
- Object Shorthand
- Object Concise
- Object Computed Properties
- Template Strings
- Destructuring
- Default Parameters
- Rest
- Array Spreads
- Let and Const
- Iterators and Generators
- Modules
-
27.2 Do not use TC39 proposals that have not reached stage 3.
Почему? They are not finalized, and they are subject to change or to be withdrawn entirely. We want to use JavaScript, and proposals are not JavaScript yet.
-
28.1 Yup.
function foo() { return true; }
- 28.2 No, but seriously:
- Whichever testing framework you use, you should be writing tests!
- Strive to write many small pure functions, and minimize where mutations occur.
- Be cautious about stubs and mocks - they can make your tests more brittle.
- We primarily use
mocha
at Airbnb.tape
is also used occasionally for small, separate modules. - 100% test coverage is a good goal to strive for, even if it's not always practical to reach it.
- Whenever you fix a bug, write a regression test. A bug fixed without a regression test is almost certainly going to break again in the future.
- On Layout & Web Performance
- String vs Array Concat
- Try/Catch Cost In a Loop
- Bang Function
- jQuery Find vs Context, Selector
- innerHTML vs textContent for script text
- Long String Concatenation
- Are Javascript functions like
map()
,reduce()
, andfilter()
optimized for traversing arrays? - Loading...
Learning ES6
- Draft ECMA 2015 (ES6) Spec
- ExploringJS
- ES6 Compatibility Table
- Comprehensive Overview of ES6 Features
Read This
Tools
- Code Style Linters
Other Style Guides
- Google JavaScript Style Guide
- jQuery Core Style Guidelines
- Principles of Writing Consistent, Idiomatic JavaScript
Other Styles
- Naming this in nested functions - Christian Johansen
- Conditional Callbacks - Ross Allen
- Popular JavaScript Coding Conventions on GitHub - JeongHoon Byun
- Multiple var statements in JavaScript, not superfluous - Ben Alman
Further Reading
- Understanding JavaScript Closures - Angus Croll
- Basic JavaScript for the impatient programmer - Dr. Axel Rauschmayer
- You Might Not Need jQuery - Zack Bloom & Adam Schwartz
- ES6 Features - Luke Hoban
- Frontend Guidelines - Benjamin De Cock
Books
- JavaScript: The Good Parts - Douglas Crockford
- JavaScript Patterns - Stoyan Stefanov
- Pro JavaScript Design Patterns - Ross Harmes and Dustin Diaz
- High Performance Web Sites: Essential Knowledge for Front-End Engineers - Steve Souders
- Maintainable JavaScript - Nicholas C. Zakas
- JavaScript Web Applications - Alex MacCaw
- Pro JavaScript Techniques - John Resig
- Smashing Node.js: JavaScript Everywhere - Guillermo Rauch
- Secrets of the JavaScript Ninja - John Resig and Bear Bibeault
- Human JavaScript - Henrik Joreteg
- Superhero.js - Kim Joar Bekkelund, Mads Mobæk, & Olav Bjorkoy
- JSBooks - Julien Bouquillon
- Third Party JavaScript - Ben Vinegar and Anton Kovalyov
- Effective JavaScript: 68 Specific Ways to Harness the Power of JavaScript - David Herman
- Eloquent JavaScript - Marijn Haverbeke
- You Don't Know JS: ES6 & Beyond - Kyle Simpson
Blogs
- JavaScript Weekly
- JavaScript, JavaScript...
- Bocoup Weblog
- Adequately Good
- NCZOnline
- Perfection Kills
- Ben Alman
- Dmitry Baranovskiy
- Dustin Diaz
- nettuts
Podcasts
This is a list of organizations that are using this style guide. Send us a pull request and we'll add you to the list.
- 4Catalyzer: 4Catalyzer/javascript
- Aan Zee: AanZee/javascript
- Adult Swim: adult-swim/javascript
- Airbnb: airbnb/javascript
- Apartmint: apartmint/javascript
- Ascribe: ascribe/javascript
- Avalara: avalara/javascript
- Avant: avantcredit/javascript
- Billabong: billabong/javascript
- Bisk: bisk/javascript
- Blendle: blendle/javascript
- Bonhomme: bonhommeparis/javascript
- Brainshark: brainshark/javascript
- Chartboost: ChartBoost/javascript-style-guide
- ComparaOnline: comparaonline/javascript
- Compass Learning: compasslearning/javascript-style-guide
- DailyMotion: dailymotion/javascript
- DoSomething: DoSomething/eslint-config
- Digitpaint digitpaint/javascript
- Ecosia: ecosia/javascript
- Evernote: evernote/javascript-style-guide
- Evolution Gaming: evolution-gaming/javascript
- EvozonJs: evozonjs/javascript
- ExactTarget: ExactTarget/javascript
- Expensify Expensify/Style-Guide
- Flexberry: Flexberry/javascript-style-guide
- Gawker Media: gawkermedia/javascript
- General Electric: GeneralElectric/javascript
- GoodData: gooddata/gdc-js-style
- Grooveshark: grooveshark/javascript
- How About We: howaboutwe/javascript
- Huballin: huballin/javascript
- HubSpot: HubSpot/javascript
- Hyper: hyperoslo/javascript-playbook
- InfoJobs: InfoJobs/JavaScript-Style-Guide
- Intent Media: intentmedia/javascript
- Jam3: Jam3/Javascript-Code-Conventions
- JeopardyBot: kesne/jeopardy-bot
- JSSolutions: JSSolutions/javascript
- KickorStick: kickorstick/javascript
- Kinetica Solutions: kinetica/javascript
- Lonely Planet: lonelyplanet/javascript
- M2GEN: M2GEN/javascript
- Mighty Spring: mightyspring/javascript
- MinnPost: MinnPost/javascript
- MitocGroup: MitocGroup/javascript
- ModCloth: modcloth/javascript
- Money Advice Service: moneyadviceservice/javascript
- Muber: muber/javascript
- National Geographic: natgeo/javascript
- National Park Service: nationalparkservice/javascript
- Nimbl3: nimbl3/javascript
- Nulogy: nulogy/javascript
- Orion Health: orionhealth/javascript
- OutBoxSoft: OutBoxSoft/javascript
- Peerby: Peerby/javascript
- Razorfish: razorfish/javascript-style-guide
- reddit: reddit/styleguide/javascript
- React: /facebook/react/blob/master/CONTRIBUTING.md#style-guide
- REI: reidev/js-style-guide
- Ripple: ripple/javascript-style-guide
- SeekingAlpha: seekingalpha/javascript-style-guide
- Shutterfly: shutterfly/javascript
- Springload: springload/javascript
- StratoDem Analytics: stratodem/javascript
- SteelKiwi Development: steelkiwi/javascript
- StudentSphere: studentsphere/javascript
- SysGarage: sysgarage/javascript-style-guide
- Syzygy Warsaw: syzygypl/javascript
- Target: target/javascript
- TheLadders: TheLadders/javascript
- The Nerdery: thenerdery/javascript-standards
- T4R Technology: T4R-Technology/javascript
- VoxFeed: VoxFeed/javascript-style-guide
- WeBox Studio: weboxstudio/javascript
- Weggo: Weggo/javascript
- Zillow: zillow/javascript
- ZocDoc: ZocDoc/javascript
This style guide is also available in other languages:
- Brazilian Portuguese: armoucar/javascript-style-guide
- Bulgarian: borislavvv/javascript
- Catalan: fpmweb/javascript-style-guide
- Chinese (Simplified): sivan/javascript-style-guide
- Chinese (Traditional): jigsawye/javascript
- French: nmussy/javascript-style-guide
- German: timofurrer/javascript-style-guide
- Italian: sinkswim/javascript-style-guide
- Japanese: mitsuruog/javascript-style-guide
- Korean: tipjs/javascript-style-guide
- Polish: mjurczyk/javascript
- Russian: uprock/javascript
- Spanish: paolocarrasco/javascript-style-guide
- Thai: lvarayut/javascript-style-guide
- Vietnam: giangpii/javascript-style-guide
- Find us on gitter.
(The MIT License)
Copyright (c) 2014-2016 Airbnb
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
We encourage you to fork this guide and change the rules to fit your team's style guide. Below, you may list some amendments to the style guide. This allows you to periodically update your style guide without having to deal with merge conflicts.