eslint-plugin-react-directives

eslint-plugin-react-directives

some rules for babel-plugin-react-directives.

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-react-directives:

$ npm install eslint-plugin-react-directives --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-react-directives globally.

Usage

There are two ways to configure it via .eslintrc:

{
  "plugins": [
    "react-directives"
  ],
  "rules": {
    "no-undef": "off",
    "no-unused-vars": "off",
    "react-directives/no-undef": "error",
    "react-directives/no-unused-vars": "error"
  }
}

or use the recommended rules:

{
  "extends": [
    "plugin:react-directives/recommended"
  ],
  "rules": {
    "no-undef": "off",
    "no-unused-vars": "off"
  }
}

Note: The rule react-directives/no-undef inherits from no-undef, the rule react-directives/no-unused-vars inherits from no-unused-vars, make sure the rules work, please turn them off.

Settings

If you have configured some options in babel-plugin-react-directives, add settings section to .eslintrc file.

{
  "settings": {
    "react-directives": {
      "prefix": "x",
      "pragmaType": "React"
    }
  }
}

List of supported rules

• react-directives/no-undef Disallow Undeclared Variables.
• react-directives/no-unused-vars Disallow Unused Variables.

Shareable configurations

Recommended

This plugin exports a recommended configuration.

To enable this configuration use the extends property in your .eslintrc config file:

{
  "extends": [
    "plugin:react-directives/recommended"
  ]
}

The rules enabled in this configuration are:

• react-directives/no-undef
• react-directives/no-unused-vars