eslint-find-new-rules

eslint-find-new-rules

Deprecation Notice

This module is deprecated in favor of eslint-find-rules

---

Use this for your own ESLint shareable configuration to identify built-in ESLint rules that you're not explicitly configuring.

Installation

Simply install locally as a development dependency to your project's package:

npm install --save-dev eslint-find-new-rules

Usage

The intended usage is as an npm script:

{
  ...
  "scripts": {
    "find-new-rules": "eslint-find-new-rules path/to/eslint-config"
  }
  ...
}

Then run it with: $ npm run find-new-rules -s (the -s is to silence npm output).

Specify a file

This is really handy in an actual config module (like mine) where you could also do:

eslint-find-new-rules ./index.js

This is resolved relative to the process.cwd() which, in the context of npm scripts is always the location of your package.json.

You may specify any config format supported by ESLint.

Absolute Path

You can also provide an absolute path:

eslint-find-new-rules ~/Developer/eslint-config-kentcdodds/index.js

Please note that any tested ESLint config file must reside below your project's root.

Default to main

It will also default to the main in your package.json, so you can omit the argument altogether:

eslint-find-new-rules

As a required module

var getRuleFinder = require('./eslint-find-new-rules')
var ruleFinder = getRuleFinder('path/to/eslint-config')

// default to the `main` in your `package.json`
// var ruleFinder = getRuleFinder()

// get all the current, plugin, available and unused rules
// without referring the extended files or documentation

ruleFinder.getCurrentRules()

ruleFinder.getPluginRules()

ruleFinder.getAllAvailableRules()

ruleFinder.getUnusedRules()

Contributors

Thanks goes to these wonderful people (emoji key):

Kent C. Dodds 💻 📖 ⚠️ 👀	Michał Gołębiowski 💻	Sarbbottam Bandyopadhyay ⚠️ 👀	Andreas Windt 💻 📖 ⚠️	Jeroen Engels 📖

This project follows the all-contributors specification. Contributions of any kind welcome!

Special thanks to @mgol who created the original script.

LICENSE

MIT