https://github.com/eslint-community/eslint-plugin-rulesdir

An ESLint plugin to load project-specific ESLint rules
https://github.com/eslint-community/eslint-plugin-rulesdir

eslint eslint-plugin

Last synced: 8 days ago
JSON representation

An ESLint plugin to load project-specific ESLint rules

• Host: GitHub
• URL: https://github.com/eslint-community/eslint-plugin-rulesdir
• Owner: eslint-community
• License: mit
• Created: 2017-06-30T07:03:02.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-10-11T11:27:04.000Z (3 months ago)
• Last Synced: 2024-12-14T10:45:53.393Z (13 days ago)
• Topics: eslint, eslint-plugin
• Language: JavaScript
• Size: 16.6 KB
• Stars: 50
• Watchers: 6
• Forks: 10
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# eslint-plugin-rulesdir

Allows a local directory containing ESLint rules directory to be easily used. This is a substitute for the `--rulesdir` option that can be used without a command-line flag.

**Experimental:** This plugin is currently a proof-of-concept. Its API is likely to change in the future.

## Installation

You'll first need to install [ESLint](http://eslint.org):

```

$ npm i eslint --save-dev

```

Next, install `eslint-plugin-rulesdir`:

```

$ npm install eslint-plugin-rulesdir --save-dev

```

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

## Usage

To use this plugin, you must load it manually first and set its `RULES_DIR` property to a path, or an array of paths. The paths are resolved from the current working directory, and indicates where you would like the plugin to load your rules from. This is easiest if you use a JavaScript config file (`.eslintrc.js`), and use a local installation of ESLint.

```js

// .eslintrc.js

const rulesDirPlugin = require('eslint-plugin-rulesdir');

rulesDirPlugin.RULES_DIR = 'tools/eslint-rules'; // (an example folder where your rules might be stored)

// You can also provide an array if you have multiple folders with rules in:

rulesDirPlugin.RULES_DIR = ['tools/eslint-rules', 'tools/other-eslint-rules'];

```

Then you should add `rulesdir` to the plugins section of your `.eslintrc.js` file.

```js

{

  plugins: [

    'rulesdir'

  ]

}

```

Finally, you can configure your local rules, prefixed with `rulesdir/`.

```js

{

  rules: {

    //

    'rulesdir/my-internal-foo-rule': 'error',

    'rulesdir/my-internal-bar-rule': ['warn', 2]

  }

}

```

All of the rules from your configured rules directory will be available. In this example, we assumed there were rule files in `tools/eslint-rules/my-internal-foo-rule.js` and `tools/eslint-rules/my-internal-bar-rule.js`.

## Prior Art

* [`eslint-plugin-local-rules`](https://github.com/cletusw/eslint-plugin-local-rules)

## License

[MIT](https://github.com/eslint-community/eslint-plugin-rulesdir/blob/main/LICENSE.md)