javascript
1.0.0
Наиболее разумный подход к JavaScript
Примечание . В этом руководстве предполагается, что вы используете Babel, и вам необходимо использовать Babel-preset-airbnb или его эквивалент. Также предполагается, что вы устанавливаете прокладки/полифиллы в свое приложение с помощью airbnb-browser-shims или его эквивалента.
Это руководство доступно и на других языках. См. перевод
Другие руководства по стилю
1.1 Примитивы . Когда вы получаете доступ к примитивному типу, вы работаете непосредственно с его значением.
stringnumberbooleannullundefinedsymbolbigint const foo = 1 ;
let bar = foo ;
bar = 9 ;
console . log ( foo , bar ) ; // => 1, 91.2 Комплекс : при доступе к сложному типу вы работаете со ссылкой на его значение.
objectarrayfunction 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
Почему? Это гарантирует, что вы не сможете переназначать ссылки, что может привести к ошибкам и затруднению понимания кода.
// bad
var a = 1 ;
var b = 2 ;
// good
const a = 1 ;
const b = 2 ; 2.2 Если вам необходимо переназначить ссылки, используйте let вместо var . эслинт: no-var
Почему?
letимеет область действия блока, а не функции, какvar.
// bad
var count = 1 ;
if ( true ) {
count += 1 ;
}
// good, use the let.
let count = 1 ;
if ( true ) {
count += 1 ;
} 2.3 Обратите внимание, что и let , и const действуют на уровне блоков, тогда как var — на уровне функций.
// const and let only exist in the blocks they are defined in.
{
let a = 1 ;
const b = 1 ;
var c = 1 ;
}
console . log ( a ) ; // ReferenceError
console . log ( b ) ; // ReferenceError
console . log ( c ) ; // Prints 1 В приведенном выше коде вы можете видеть, что ссылка на a и b приведет к ошибке ReferenceError, а c содержит число. Это связано с тем, что a и b имеют область действия блока, а область действия c ограничена содержащей функцией.
⬆ вернуться наверх
3.1. Используйте буквальный синтаксис для создания объектов. eslint: no-new-object
// bad
const item = new Object ( ) ;
// good
const item = { } ;3.2. Используйте вычисленные имена свойств при создании объектов с динамическими именами свойств.
Почему? Они позволяют определить все свойства объекта в одном месте.
function getKey ( k ) {
return `a key named ${ k } ` ;
}
// bad
const obj = {
id : 5 ,
name : 'San Francisco' ,
} ;
obj [ getKey ( 'enabled' ) ] = true ;
// good
const obj = {
id : 5 ,
name : 'San Francisco' ,
[ getKey ( 'enabled' ) ] : true ,
} ; 3.3. Используйте сокращение метода объекта. eslint: object-shorthand
// bad
const atom = {
value : 1 ,
addValue : function ( value ) {
return atom . value + value ;
} ,
} ;
// good
const atom = {
value : 1 ,
addValue ( value ) {
return atom . value + value ;
} ,
} ; 3.4. Используйте сокращенное обозначение значения свойства. eslint: object-shorthand
Почему? Оно более краткое и описательное.
const lukeSkywalker = 'Luke Skywalker' ;
// bad
const obj = {
lukeSkywalker : lukeSkywalker ,
} ;
// good
const obj = {
lukeSkywalker ,
} ;3.5 Сгруппируйте сокращенные свойства в начале объявления объекта.
Почему? С помощью сокращенной записи проще определить, какие свойства используются.
const anakinSkywalker = 'Anakin Skywalker' ;
const lukeSkywalker = 'Luke Skywalker' ;
// bad
const obj = {
episodeOne : 1 ,
twoJediWalkIntoACantina : 2 ,
lukeSkywalker ,
episodeThree : 3 ,
mayTheFourth : 4 ,
anakinSkywalker ,
} ;
// good
const obj = {
lukeSkywalker ,
anakinSkywalker ,
episodeOne : 1 ,
twoJediWalkIntoACantina : 2 ,
episodeThree : 3 ,
mayTheFourth : 4 ,
} ; 3.6 Цитируйте только те свойства, которые являются недействительными идентификаторами. эслинт: quote-props
Почему? В целом мы считаем, что субъективно его легче читать. Он улучшает подсветку синтаксиса, а также его легче оптимизировать многими JS-движками.
// bad
const bad = {
'foo' : 3 ,
'bar' : 4 ,
'data-blah' : 5 ,
} ;
// good
const good = {
foo : 3 ,
bar : 4 ,
'data-blah' : 5 ,
} ; 3.7 Не вызывайте методы Object.prototype напрямую, такие как hasOwnProperty , propertyIsEnumerable и isPrototypeOf . eslint: no-prototype-builtins
Почему? Эти методы могут быть затенены свойствами рассматриваемого объекта — рассмотрите
{ hasOwnProperty: false }— или объект может быть нулевым объектом (Object.create(null)). В современных браузерах, поддерживающих ES2022, или с полифилом, например https://npmjs.com/object.hasown,Object.hasOwnтакже можно использовать в качестве альтернативыObject.prototype.hasOwnProperty.call.
// bad
console . log ( object . hasOwnProperty ( key ) ) ;
// good
console . log ( Object . prototype . hasOwnProperty . call ( object , key ) ) ;
// better
const has = Object . prototype . hasOwnProperty ; // cache the lookup once, in module scope.
console . log ( has . call ( object , key ) ) ;
// best
console . log ( Object . hasOwn ( object , key ) ) ; // only supported in browsers that support ES2022
/* or */
import has from 'has' ; // https://www.npmjs.com/package/has
console . log ( has ( object , key ) ) ;
/* or */
console . log ( Object . hasOwn ( object , key ) ) ; // https://www.npmjs.com/package/object.hasown 3.8. Для поверхностного копирования объектов отдавайте предпочтение синтаксису расширения объектов, а не Object.assign . Используйте синтаксис параметра rest объекта, чтобы получить новый объект с опущенными определенными свойствами. eslint: prefer-object-spread
// very bad
const original = { a : 1 , b : 2 } ;
const copy = Object . assign ( original , { c : 3 } ) ; // this mutates `original` ಠ_ಠ
delete copy . a ; // so does this
// bad
const original = { a : 1 , b : 2 } ;
const copy = Object . assign ( { } , original , { c : 3 } ) ; // copy => { a: 1, b: 2, c: 3 }
// good
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
// bad
const items = new Array ( ) ;
// good
const items = [ ] ;4.2. Используйте Array#push вместо прямого присваивания для добавления элементов в массив.
const someStack = [ ] ;
// bad
someStack [ someStack . length ] = 'abracadabra' ;
// good
someStack . push ( 'abracadabra' ) ; 4.3. Используйте развороты массивов ... для копирования массивов.
// bad
const len = items . length ;
const itemsCopy = [ ] ;
let i ;
for ( i = 0 ; i < len ; i += 1 ) {
itemsCopy [ i ] = items [ i ] ;
}
// good
const itemsCopy = [ ... items ] ; 4.4 Чтобы преобразовать итерируемый объект в массив, используйте спреды ... вместо Array.from
const foo = document . querySelectorAll ( '.foo' ) ;
// good
const nodes = Array . from ( foo ) ;
// best
const nodes = [ ... foo ] ; 4.5. Используйте Array.from для преобразования объекта, подобного массиву, в массив.
const arrLike = { 0 : 'foo' , 1 : 'bar' , 2 : 'baz' , length : 3 } ;
// bad
const arr = Array . prototype . slice . call ( arrLike ) ;
// good
const arr = Array . from ( arrLike ) ; 4.6. Используйте Array.from вместо распространения ... для сопоставления итераций, поскольку это позволяет избежать создания промежуточного массива.
// bad
const baz = [ ... foo ] . map ( bar ) ;
// good
const baz = Array . from ( foo , bar ) ; 4.7. Используйте операторы return в обратных вызовах методов массива. Можно пропустить возврат, если тело функции состоит из одного оператора, возвращающего выражение без побочных эффектов, в соответствии с 8.2. eslint: array-callback-return
// good
[ 1 , 2 , 3 ] . map ( ( x ) => {
const y = x + 1 ;
return x * y ;
} ) ;
// good
[ 1 , 2 , 3 ] . map ( ( x ) => x + 1 ) ;
// bad - no returned value means `acc` becomes undefined after the first iteration
[ [ 0 , 1 ] , [ 2 , 3 ] , [ 4 , 5 ] ] . reduce ( ( acc , item , index ) => {
const flatten = acc . concat ( item ) ;
} ) ;
// good
[ [ 0 , 1 ] , [ 2 , 3 ] , [ 4 , 5 ] ] . reduce ( ( acc , item , index ) => {
const flatten = acc . concat ( item ) ;
return flatten ;
} ) ;
// bad
inbox . filter ( ( msg ) => {
const { subject , author } = msg ;
if ( subject === 'Mockingbird' ) {
return author === 'Harper Lee' ;
} else {
return false ;
}
} ) ;
// good
inbox . filter ( ( msg ) => {
const { subject , author } = msg ;
if ( subject === 'Mockingbird' ) {
return author === 'Harper Lee' ;
}
return false ;
} ) ;4.8 Используйте разрывы строк после открытия скобок массива и перед закрытием скобок массива, если массив состоит из нескольких строк.
// bad
const arr = [
[ 0 , 1 ] , [ 2 , 3 ] , [ 4 , 5 ] ,
] ;
const objectInArray = [ {
id : 1 ,
} , {
id : 2 ,
} ] ;
const numberInArray = [
1 , 2 ,
] ;
// good
const arr = [ [ 0 , 1 ] , [ 2 , 3 ] , [ 4 , 5 ] ] ;
const objectInArray = [
{
id : 1 ,
} ,
{
id : 2 ,
} ,
] ;
const numberInArray = [
1 ,
2 ,
] ;⬆ вернуться наверх
5.1. Используйте деструктуризацию объекта при доступе и использовании нескольких свойств объекта. eslint: prefer-destructuring
Почему? Деструктуризация избавляет вас от создания временных ссылок на эти свойства и от повторного доступа к объекту. Повторный доступ к объектам создает больше повторяющегося кода, требует больше чтения и создает больше возможностей для ошибок. Деструктуризация объектов также обеспечивает единый сайт определения структуры объекта, которая используется в блоке, вместо того, чтобы требовать чтения всего блока, чтобы определить, что используется.
// bad
function getFullName ( user ) {
const firstName = user . firstName ;
const lastName = user . lastName ;
return ` ${ firstName } ${ lastName } ` ;
}
// good
function getFullName ( user ) {
const { firstName , lastName } = user ;
return ` ${ firstName } ${ lastName } ` ;
}
// best
function getFullName ( { firstName , lastName } ) {
return ` ${ firstName } ${ lastName } ` ;
} 5.2. Используйте деструктуризацию массива. eslint: prefer-destructuring
const arr = [ 1 , 2 , 3 , 4 ] ;
// bad
const first = arr [ 0 ] ;
const second = arr [ 1 ] ;
// good
const [ first , second ] = arr ;5.3. Используйте деструктуризацию объекта для нескольких возвращаемых значений, а не деструктуризацию массива.
Почему? Вы можете со временем добавлять новые свойства или изменять порядок действий, не нарушая при этом сайты вызовов.
// bad
function processInput ( input ) {
// then a miracle occurs
return [ left , right , top , bottom ] ;
}
// the caller needs to think about the order of return data
const [ left , __ , top ] = processInput ( input ) ;
// good
function processInput ( input ) {
// then a miracle occurs
return { left , right , top , bottom } ;
}
// the caller selects only the data they need
const { left , top } = processInput ( input ) ;⬆ вернуться наверх
6.1 Используйте одинарные '' для строк. эслинт: quotes
// bad
const name = "Capt. Janeway" ;
// bad - template literals should contain interpolation or newlines
const name = `Capt. Janeway` ;
// good
const name = 'Capt. Janeway' ;6.2 Строки, длина которых превышает 100 символов, не следует записывать в несколько строк с использованием конкатенации строк.
Почему? С разорванными строками неудобно работать, и код становится менее доступным для поиска.
// bad
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.' ;
// bad
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.' ;
// good
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
Почему? Строки шаблонов предоставляют читабельный и лаконичный синтаксис с правильными символами новой строки и функциями интерполяции строк.
// bad
function sayHi ( name ) {
return 'How are you, ' + name + '?' ;
}
// bad
function sayHi ( name ) {
return [ 'How are you, ' , name , '?' ] . join ( ) ;
}
// bad
function sayHi ( name ) {
return `How are you, ${ name } ?` ;
}
// good
function sayHi ( name ) {
return `How are you, ${ name } ?` ;
}eval() для строки; это открывает слишком много уязвимостей. эслинт: no-eval 6.5 Не экранируйте символы в строках без необходимости. эслинт: no-useless-escape
Почему? обратная косая черта
