README
eslint-config-peopledoc
JavaScript linting rules for PeopleDoc.
Installation
In your project, remove exisiting ESLint's plugins or configuration, then:
# with npm
npm install --save-dev eslint-config-peopledoc
# or with yarn
yarn add eslint-config-peopledoc --dev
If you add this configuration to a project using Ember 3.12+, you need to install babel-eslint
:
# with npm
npm install --save-dev babel-eslint
# or with yarn
yarn add babel-eslint --dev
Usage
In your project, edit your eslint
configuration to extend peopledoc
ESLint config:
module.exports = {
root: true,
extends: ['peopledoc'],
rules: {}
}
Preset configurations are available for:
Vanilla JS:
extends: ['peopledoc']
Ember Application:
extends: ['peopledoc/ember']
Ember Addon:
extends: ['peopledoc/ember-addon']
ES5 only
extends: ['peopledoc/es5']
Prettier
extends: ['peopledoc/prettier']
Formatting Code
We recommend to use eslint . --fix
.
License
This project is licensed under the MIT License.