eslint-config-aurora
v1.0.1
Published
A shareable ESLint config created with readability and productivity in mind.
Downloads
40
Maintainers
Readme
eslint-config-aurora
Standard JavaScript, but with opinionated changes.
Changed rules
| Rule | Old | New | Why |
|----------|-----------|-----------|---------|
|space-before-function-paren|['error', 'always']
|['error',{'anonymous': 'always', 'named': 'never', 'asyncArrow': 'always' }]
| Spacing before named function parenthesis is just unusual. |
Changes the function parenthesis spacing rule to disallow spaces for named functions but continue to require them for anonymous and asyncArrow functions.
function name(arg) { ... } // ✓ ok now, previously forced a space
| Rule | Old | New | Why |
|----------|-----------|-----------|---------|
|comma-dangle|['error', 'never']
|['warn', 'multiline']
| Trailing commas allow for quicker additions to lists from cold starts.
Changes the dangling comma rule to be a warning instead of an error and expect them on the last element or property which is on a different line of comma separated values.
var obj = {
message: 'hello', // ✓ ok now, previously an error
}
Usage
Install:
yarn add --dev eslint-config-aurora
or
npm install --save-dev eslint-config-aurora
Create or edit .eslintrc.json
:
{
"extends": "aurora"
}
ESLint + Prettier
This ESLint config is designed to work alongside our shareable Prettier config: @auroradigital/prettier-config.