eslint-config-seekingalpha-base

eslint-config-seekingalpha-base

This package includes the shareable ESLint config used by SeekingAlpha.

Installation

Install ESlint and all Peer Dependencies with NPM:

npm install eslint@"^5.6.0" eslint-plugin-array-func@"^3.0.0" eslint-plugin-import@"^2.14.0" eslint-plugin-jsdoc@"^3.8.0" eslint-plugin-no-use-extend-native@"^0.3.12" eslint-plugin-promise@"^4.0.1" eslint-plugin-unicorn@"^6.0.1" --save-dev

or Yarn:

yarn add --dev eslint@^5.6.0 eslint-plugin-array-func@^3.0.0 eslint-plugin-import@^2.14.0 eslint-plugin-jsdoc@^3.8.0 eslint-plugin-no-use-extend-native@^0.3.12 eslint-plugin-promise@^4.0.1 eslint-plugin-unicorn@^6.0.1

Install SeekingAlpha shareable ESLint:

npm install eslint-config-seekingalpha-base --save-dev

For Yarn:

yarn add --dev eslint-config-seekingalpha-base

Usage

This shareable config includes all ESLint rules including ECMAScript 6 features and set of legacy rules. We also extend our configuration with following plugins:

• eslint-plugin-import
• eslint-plugin-array-func
• eslint-plugin-jsdoc
• eslint-plugin-no-use-extend-native
• eslint-plugin-promise
• eslint-plugin-unicorn

We expose three configurations:

• seekingalpha-base - exports all avaliable ESLint rules and all rules of plugins above.
• seekingalpha-base/browser - exports only browser related rules for ESLint and mentioned plugins. It also sets browser as default environment.
• seekingalpha-base/node - exports only Node.js related rules for ESLint and mentioned plugins. It also sets node as default environment.

Simply extend the .eslintrc.js in your project with relevant configuration:

// for seekingalpha-base
{
  extends: [
    'seekingalpha-base'
  ]
}  

// for seekingalpha-base/browser
{
  extends: [
    'seekingalpha-base/browser'
  ]
}

// for seekingalpha-base/node
{
  extends: [
    'seekingalpha-base/node'
  ]
}

License

MIT © SeekingAlpha