javascript
1.0.0
Uma abordagem bastante razoável para JavaScript
Observação : este guia pressupõe que você esteja usando o Babel e exige que você use o babel-preset-airbnb ou equivalente. Ele também pressupõe que você esteja instalando shims/polyfills em seu aplicativo, com airbnb-browser-shims ou equivalente.
Este guia também está disponível em outros idiomas. Veja a tradução
Outros guias de estilo
1.1 Primitivos : Ao acessar um tipo primitivo você trabalha diretamente em seu valor.
stringnumberbooleannullundefinedsymbolbigint const foo = 1 ;
let bar = foo ;
bar = 9 ;
console . log ( foo , bar ) ; // => 1, 91.2 Complexo : Ao acessar um tipo complexo você trabalha em uma referência ao seu valor.
objectarrayfunction const foo = [ 1 , 2 ] ;
const bar = foo ;
bar [ 0 ] = 9 ;
console . log ( foo [ 0 ] , bar [ 0 ] ) ; // => 9, 9⬆ voltar ao topo
2.1 Use const para todas as suas referências; evite usar var . eslint: prefer-const , no-const-assign
Por que? Isso garante que você não possa reatribuir suas referências, o que pode levar a bugs e código de difícil compreensão.
// bad
var a = 1 ;
var b = 2 ;
// good
const a = 1 ;
const b = 2 ; 2.2 Se você precisar reatribuir referências, use let em vez de var . eslint: no-var
Por que?
lettem escopo de bloco em vez de escopo de função comovar.
// bad
var count = 1 ;
if ( true ) {
count += 1 ;
}
// good, use the let.
let count = 1 ;
if ( true ) {
count += 1 ;
} 2.3 Observe que let e const têm escopo de bloco, enquanto var tem escopo de função.
// 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 No c a b número. Isso ocorre porque a têm escopo de bloco, enquanto c tem escopo da função b o contém.
⬆ voltar ao topo
3.1 Use a sintaxe literal para criação de objetos. eslint: no-new-object
// bad
const item = new Object ( ) ;
// good
const item = { } ;3.2 Use nomes de propriedades computadas ao criar objetos com nomes de propriedades dinâmicas.
Por que? Eles permitem definir todas as propriedades de um objeto em um só lugar.
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 Use a abreviação do método de objeto. 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 Use a abreviação do valor da propriedade. eslint: object-shorthand
Por que? É mais curto e descritivo.
const lukeSkywalker = 'Luke Skywalker' ;
// bad
const obj = {
lukeSkywalker : lukeSkywalker ,
} ;
// good
const obj = {
lukeSkywalker ,
} ;3.5 Agrupe suas propriedades abreviadas no início da declaração do seu objeto.
Por que? É mais fácil saber quais propriedades estão usando a abreviatura.
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 Apenas cite propriedades que sejam identificadores inválidos. eslint: quote-props
Por que? Em geral consideramos subjetivamente mais fácil de ler. Ele melhora o realce de sintaxe e também é otimizado mais facilmente por muitos mecanismos JS.
// bad
const bad = {
'foo' : 3 ,
'bar' : 4 ,
'data-blah' : 5 ,
} ;
// good
const good = {
foo : 3 ,
bar : 4 ,
'data-blah' : 5 ,
} ; 3.7 Não chame métodos Object.prototype diretamente, como hasOwnProperty , propertyIsEnumerable e isPrototypeOf . eslint: no-prototype-builtins
Por que? Esses métodos podem ser obscurecidos pelas propriedades do objeto em questão - considere
{ hasOwnProperty: false }- ou o objeto pode ser um objeto nulo (Object.create(null)). Em navegadores modernos que suportam ES2022, ou com um polyfill como https://npmjs.com/object.hasown,Object.hasOwntambém pode ser usado como uma alternativa aObject.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 Prefira a sintaxe de propagação de objeto em vez de Object.assign para objetos de cópia superficial. Use a sintaxe do parâmetro rest do objeto para obter um novo objeto com certas propriedades omitidas. 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 }⬆ voltar ao topo
4.1 Use a sintaxe literal para criação de array. eslint: no-array-constructor
// bad
const items = new Array ( ) ;
// good
const items = [ ] ;4.2 Use Array#push em vez de atribuição direta para adicionar itens a um array.
const someStack = [ ] ;
// bad
someStack [ someStack . length ] = 'abracadabra' ;
// good
someStack . push ( 'abracadabra' ) ; 4.3 Use array spreads ... para copiar arrays.
// 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 Para converter um objeto iterável em um array, use spreads ... em vez de Array.from
const foo = document . querySelectorAll ( '.foo' ) ;
// good
const nodes = Array . from ( foo ) ;
// best
const nodes = [ ... foo ] ; 4.5 Use Array.from para converter um objeto semelhante a um array em um array.
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 Use Array.from em vez de spread ... para mapear iteráveis, pois evita a criação de um array intermediário.
// bad
const baz = [ ... foo ] . map ( bar ) ;
// good
const baz = Array . from ( foo , bar ) ; 4.7 Use instruções de retorno em retornos de chamada de métodos de array. Não há problema em omitir o retorno se o corpo da função consistir em uma única instrução retornando uma expressão sem efeitos colaterais, seguindo 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 Use quebras de linha após abrir colchetes de array e antes de fechar colchetes de array, se um array tiver múltiplas linhas
// 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 ,
] ;⬆ voltar ao topo
5.1 Use a desestruturação de objetos ao acessar e usar múltiplas propriedades de um objeto. eslint: prefer-destructuring
Por que? A desestruturação evita a criação de referências temporárias para essas propriedades e o acesso repetitivo ao objeto. O acesso repetido a objetos cria código mais repetitivo, requer mais leitura e cria mais oportunidades para erros. A desestruturação de objetos também fornece um único local de definição da estrutura do objeto que é usada no bloco, em vez de exigir a leitura de todo o bloco para determinar o que é usado.
// 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 Use desestruturação de array. 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 Use a desestruturação de objetos para vários valores de retorno, não a desestruturação de array.
Por que? Você pode adicionar novas propriedades ao longo do tempo ou alterar a ordem das coisas sem interromper os sites de chamada.
// 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 ) ;⬆ voltar ao topo
6.1 Use aspas simples '' para strings. eslint: 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 Strings que fazem com que a linha ultrapasse 100 caracteres não devem ser escritas em múltiplas linhas usando concatenação de strings.
Por que? Strings quebradas são difíceis de trabalhar e tornam o código menos pesquisável.
// 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 Ao construir strings programaticamente, use strings de modelo em vez de concatenação. eslint: prefer-template template-curly-spacing
Por que? As strings de modelo fornecem uma sintaxe legível e concisa com novas linhas adequadas e recursos de interpolação de strings.
// 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() em uma string; isso abre muitas vulnerabilidades. eslint: no-eval 6.5 Não escape desnecessariamente caracteres em strings. eslint: no-useless-escape
Por que? Barras invertidas
