eslint-find-new-rules

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

eslint-find-new-rules

(★ 33)

Find built-in ESLint rules you don't have in your custom config

eslint-find-new-rules Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# eslint-find-new-rules

## Deprecation Notice

**This module is deprecated in favor of [eslint-find-rules](https://www.npmjs.com/package/eslint-find-rules/)**

---

Use this for your own [ESLint](http://eslint.org/) [shareable configuration](http://eslint.org/docs/developer-guide/shareable-configs)
to identify built-in ESLint rules that you're not explicitly configuring.

[![Build Status](https://img.shields.io/travis/kentcdodds/eslint-find-new-rules.svg?style=flat-square)](https://travis-ci.org/kentcdodds/eslint-find-new-rules)
[![Code Coverage](https://img.shields.io/codecov/c/github/kentcdodds/eslint-find-new-rules.svg?style=flat-square)](https://codecov.io/github/kentcdodds/eslint-find-new-rules)
[![version](https://img.shields.io/npm/v/eslint-find-new-rules.svg?style=flat-square)](http://npm.im/eslint-find-new-rules)
[![downloads](https://img.shields.io/npm/dm/eslint-find-new-rules.svg?style=flat-square)](http://npm-stat.com/charts.html?package=eslint-find-new-rules&from=2015-08-01)
[![MIT License](https://img.shields.io/npm/l/eslint-find-new-rules.svg?style=flat-square)](http://opensource.org/licenses/MIT)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](https://raw.githubusercontent.com/kentcdodds/eslint-find-new-rules/main/)

## 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:

```javascript
{
  ...
  "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](https://github.com/kentcdodds/eslint-config-kentcdodds)) 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](http://eslint.org/docs/user-guide/configuring).

### 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 `require`d 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](https://github.com/kentcdodds/all-contributors#emoji-key)):

| [![Kent C. Dodds](https://avatars3.githubusercontent.com/u/1500684?v=3&s=100) Kent C. Dodds](https://twitter.com/kentcdodds) [💻](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=kentcdodds) [📖](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=kentcdodds) [⚠️](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=kentcdodds) 👀 | [![Michał Gołębiowski](https://avatars3.githubusercontent.com/u/1758366?v=3&s=100) Michał Gołębiowski](https://github.com/mgol) [💻](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=mgol) | [![Sarbbottam Bandyopadhyay](https://avatars1.githubusercontent.com/u/949380?v=3&s=100) Sarbbottam Bandyopadhyay](https://twitter.com/sarbbottam) [⚠️](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=sarbbottam) 👀 | [![Andreas Windt](https://avatars1.githubusercontent.com/u/262436?v=3&s=100) Andreas Windt](https://twitter.com/ta2edchimp) [💻](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=ta2edchimp) [📖](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=ta2edchimp) [⚠️](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=ta2edchimp) | [![Jeroen Engels](https://avatars.githubusercontent.com/u/3869412?v=3&s=100) Jeroen Engels](https://github.com/jfmengels) [📖](https://github.com/kentcdodds/eslint-find-new-rules/commits?author=jfmengels) |
| :---: | :---: | :---: | :---: | :---: |

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.
Contributions of any kind welcome!

Special thanks to [@mgol](https://github.com/mgol) who created the original script.

## LICENSE

MIT

eslint-find-new-rules

eslint-find-new-rules Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

eslint-find-new-rules

eslint-find-new-rules Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README