@sec/eslint-config-bmp

ESLint Configs for bizhub MarketPlace projects

Setup

In order to install this package, you must be authenticated as a paid member of the @sec organization. This can be done by adding your authentication token to your .npmrc file as described at https://docs.npmjs.com/private-modules/ci-server-config.

NOTE: If installing globally, you will need to add the authentication token to the /usr/etc/npmrc file as well.

To use this config, you will need to install several packages using the following command (it is recommended to install these packages globally):

[sudo] npm i -g eslint babel-eslint eslint-plugin-react @sec/eslint-config-bmp

NOTE: eslint-plugin-react is only required when using the react config.

Usage

This package provides three different configs that can be used with ESLint: es5 (default), es6, and react.

To use the default config, add the following line to the .eslintrc.json file in the root directory of your project:

"extends": "@sec/bmp"

The es6 and react configs can be used by extending "@sec/bmp/es6" and "@sec/bmp/react" respectively.

The react config specifies es6 parser options by default. Therefore, it is not necessary to also extend the es6 config when using the react config.

Ensure that you have library and minified files ignored in .eslintignore and then test ESLint by running the following command from the root directory of your project:

eslint --ext js,jsx .

For more information on ESLint configuration, please see http://eslint.org/docs/user-guide/configuring.