eslint-config-peopledoc

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']

Ember Test:

extends: ['peopledoc/ember-test']

ES5 only

extends: ['peopledoc/es5']

Prettier

extends: ['peopledoc/prettier']

Formatting Code

We recommend to use prettier-eslint in order to format it with prettier (why?) then fix issue with eslint --fix:

./node_modules/.bin/prettier-eslint --list-different --single-quote {app,config,mirage,server,tests}/{**/,}*.js

Once you have review change you can write them with

./node_modules/.bin/prettier-eslint --write --single-quote {app,config,mirage,server,tests}/{**/,}*.js

:bulb: We recommend to add a custom format script to your package.json so you can run npm format.

License

This project is licensed under the MIT License.