README.md

Nata.house JavaScript Style Guide

Nosso style guide é baseado no Airbnb's. Com algumas alterações.

Instalando

$ yarn add @natahouse/eslint-config

Para incluir no projeto, crie o arquivo .eslintrc com a seguinte config:

{
  "extends": ["@natahouse"]
}

Regras adicionadas

Ponto e vírgula

Ponto e vírgula não precisa serem usadas. motivo

Errado:

const nata = 'house';

Certo:

const nata = 'house'

Quebras de linha dentro de parênteses de função

Errado:

hello(nata,
  house)

Certo:

hello(
  nata,
  house,
)

Vírgula em array, object multiline, menos em parâmetros de funções

Errado:

const array = [1, 2, 3,]

Certo:

const array = [1, 2, 3]

Errado:

const array = [
  1,
  2,
  3
]

Certo:

const array = [
  1,
  2,
  3,
]

Errado:

const obj = {
  a: 1,
  b: 2,
  c: 3
}

Certo:

const obj = {
  a: 1,
  b: 2,
  c: 3,
}

Vírgula em parâmetros pode causar erros

Errado:

Object.assign(
  {},
  b,
  c,
)

Certo:

Object.assign(
  {},
  b,
  c
)

Comprimento de linha

90 caracteres, incluindo espaços.

Parâmetros máximos na definição da função

Máximo 3 parâmetros

Errado:

const nata = (arg1, arg2, arg3, arg4, arg5, arg6, arg7) => ...

Certo:

const nata = (arg1, arg2, arg3) => ...

Múltiplas linhas vazias

Errado:

const a = 'hello nata.house'


console.log(a)

Certo:

const a = 'hello nata.house'

console.log(a)

Contribuindo

Sinta-se a vontade para abrir uma PR