eslint-config-ww

An ESLint shareable config package for all your JS projects

This package is an extension of Airbnb's ESLint config. The rules are fine-tuned according to White Widget team's preferences. Use this as the default linter in all your JS projects.

Installation

Install eslint and other peer dependencies first:

$ yarn add --dev eslint eslint-plugin-import eslint-config-airbnb eslint-plugin-jsx-a11y eslint-plugin-react

Install the main config:

$ yarn add --dev git+ssh://[email protected]:whitewidget/research/web/eslint-config-ww.git

Usage

Once the main config package is installed, use it in your .eslintrc file by specifying ww in extends. You may want to add more rules depending on your project.

{
  "extends": "ww",
  "rules": {
    // include project-specific rules here
  }
}

For more info, see the Javascript Style Guide.

Contributing / Testing

If you're making rule modifications to this config, use test/playground.js then run npm test to test your changes. It will validate index.js, test/test.js and test/playground.js and will return failed assertions if an ESLint rule is violated.

Future Work

• Autoformatter
• Customized React rules