README
@octetstream/eslint-config
AirBnb-based ESlint config, tweaked for my needs.
Installation
pnpm add --dev @octetstream/eslint-config eslint
Usage
Create an .eslintrc.json
at the root of your project and add the following content:
{
"extends": [
"@octetstream"
]
}
Rules
This section contains the list of rules that I changed comparad to AirBnb config.
- Never use the semicolon, until it's necessary:
semi
// Good 👍
const string = "On Soviet Moon landscape see binoculars through you!"
const doSomething = () => {}; // Good, because the next expression starts with an array declaration, but does not have an assignment
["SIGTERM", "SIGINT"].forEach(signal => process.on(signal, () => { process.exitCode = 0 }))
// Bad 👎
const number = 42;
const person = {
firstName: "Luke",
lastName: "Skywalker"
};
- Use double quotes by default.
quotes
// Good 👍
const firstString = "Just a string with double quotes."
const secondString = "This string contains \"escaped quotes\" in it."
const thirdString = 'This string also contains "quotes" in it.'
const fourthString = `Use template literal only if you need ${interpolation}.`
// Bad 👎
const fifthString = 'Do not use signle quotes for strings.'
const sixthString = `Do not use template literal without interpolation.`
- Prefer
const
overlet
if assigned value is not meant to be changed. Avoidvar
. Useconst
in destructuring only if none of values are meant to be changed.prefer-const
// Good 👍
const number = 42
let string = "Initial string value"
string = "Updated string value"
// Bad 👎
var someVariable = 451