/eslint-plugin-crb

Primary LanguageJavaScriptMIT LicenseMIT

CRB ESLint Plugin

Installation

npm install --save-dev eslint-plugin-crb

Usage

Extend one or more of the presets depending on the nature of the package:

// .eslintrc.json
{
  "extends": [
    "plugin:crb/general",
    "plugin:crb/tests",
    "plugin:crb/react"
  ]
}

Presets

general

The majority of the rules concerning JavaScript. Should usually be used at the root of the package.

tests

Test-specific configuration and rules. Should be used within the test directory.

react

React and JSX-specific configuration and rules.

Dependencies

Due to a limitation in how ESLint plugins work, your package needs to install the ESLint plugins that this plugin depends on:

If using the tests preset:

npm install --save-dev eslint-plugin-mocha

If using the react preset:

npm install --save-dev @babel/eslint-parser eslint-plugin-react

License

This project is licensed under the terms of the MIT license.