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, you need to install @babel/core, @babel/eslint-parser and @babel/plugin-proposal-decorators:

# with npm
npm install eslint @babel/core @babel/eslint-parser @babel/plugin-proposal-decorators --save-dev

# or with yarn
yarn add eslint @babel/core @babel/eslint-parser @babel/plugin-proposal-decorators -D

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.

Contributors

License

This project is licensed under the MIT License.