@scentregroup/eslint-config

Scentre Group ESLint Config

This package contains Scentre Group's ESLint configuration.

Usage

1. Run yarn add eslint babel-eslint eslint-plugin-compat eslint-plugin-import eslint-plugin-eslint-comments eslint-plugin-jsx-a11y eslint-plugin-prettier eslint-plugin-promise eslint-plugin-react eslint-plugin-jest eslint-plugin-filenames @scentregroup/eslint-config --dev
2. Run touch .eslintrc.js
3. Extend @scentregroup/eslint-config, i.e. add the following to .eslintrc.js:

module.exports = {
  extends: ['@scentregroup/eslint-config']
}

1. Add a lint:js task to scripts in package.json: eslint '**/*.js'

Development

If you would like to try out the repository locally:

1. Run git clone [e-mail]:ScentreGroup/javascript_config.git
2. cd javascript_config/eslint-config
3. Create a global link to this repository via yarn link
4. In the repository you would like to test, run yarn link @scentregroup/eslint-config.
5. You can then proceed as per the Usage section.

Contents

This configuration file itself extends recommended presets in:

• eslint
• eslint-plugin-compat
• eslint-plugin-import
• eslint-plugin-promise
• eslint-plugin-eslint-comments
• eslint-plugin-prettier
• eslint-plugin-react
• eslint-plugin-jsx-a11y