eslint-config-amercier

My personal collection of all-in-one ESLint shareable configs. Most of them are based on Airbnb Javascript and Prettier, with additional plugins and configs.

All-in-one?

Unlike most ESLint shareable configs, which declare peer dependencies, this NPM package declares all its included ESLint plugins and configs as dependencies directly. This design choice is intentional, in order to simplify its usage to the minimum (ESLint's extends field).

Installation

Prerequisites:

• Node.js 8+, npm 3+.
• ESLint 5+

npm install --save-dev eslint
npm install --save-dev eslint-config-amercier

Base configs

Every base config is designed with the following Prettier options in mind:

{
  "singleQuote": true,
  "trailingComma": "all"
}

amercier/create-react-app

Config for projects generated with Create React App.

Usage

{
  "root": true,
  "extends": ["amercier/create-react-app"]
}

Included configs and plugins

• eslint-config-airbnb
• eslint-plugin-react – recommended
• eslint-plugin-more – recommended, minus more/no-window
• eslint-plugin-jsx-a11y – recommended
• eslint-plugin-unicorn – recommended + exceptions
• eslint-plugin-prettier – recommended
• eslint-plugin-jest – recommended + style + more rules
• eslint-plugin-jsdoc-strict – no exceptions
• eslint-plugin-eslint-comments – recommended
• eslint-config-prettier – prettier + prettier/react + prettier/unicorn

See create-react-app config for more details.

amercier/vue-cli

Config for projects generated with Vue CLI.

Usage

{
  "root": true,
  "extends": ["amercier/vue-cli"]
}

Included configs and plugins

• @vue/eslint-config-airbnb
• @vue/eslint-config-prettier
• eslint-plugin-vue – recommended + more rules
• eslint-plugin-strict-vue – all rules
• eslint-plugin-more – recommended, minus more/no-window
• eslint-plugin-unicorn – recommended + exceptions
• eslint-plugin-jest – recommended + style + more rules
• eslint-plugin-jsdoc-strict – no exceptions
• eslint-plugin-eslint-comments – recommended

See vue-cli config for more details.

Opt-in configs

This configs can be added to any base config. Each of them are independent and can be combined.

amercier/with/flowtype

Add support for Flow.

Usage

Example with amercier/create-react-app:

{
  "root": true,
  "extends": ["amercier/create-react-app", "amercier/with-flowtype"]
}

Included configs and plugins

• eslint-config-flowtype-strict - no exceptions
• eslint-config-prettier – prettier/flowtype

See with/flowtype config for more details.

amercier/with/redux

Add support for Redux.

Usage

Example with amercier/create-react-app:

{
  "root": true,
  "extends": ["amercier/create-react-app", "amercier/with-redux"]
}

Included configs and plugins

• eslint-plugin-react-redux – recommended, minus react-redux/prefer-separate-component-file + exceptions

See with/redux config for more details.

amercier/with/redux-saga

Add support for redux-saga.

Usage

Example with amercier/create-react-app and amercier/with/redux:

{
  "root": true,
  "extends": [
    "amercier/create-react-app",
    "amercier/with-redux",
    "amercier/with-redux-saga"
  ]
}

Included configs and plugins

• eslint-plugin-redux-saga – all + exceptions

See with/redux-saga config for more details.

Contributing

Please read guidelines for contributing.

License

This ESLint config was created using eslint-config-template