# all-eslint-rules

> Get all available ESLint rules

Latest version **6.0.0** (published 2019-06-26) · ISC license · 0 weekly downloads

## Install

```sh
npm install all-eslint-rules
pnpm add all-eslint-rules
yarn add all-eslint-rules
bun add all-eslint-rules
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 6.0.0 |
| Published | 2019-06-26 |
| First published | 2015-09-03 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 4.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Watanabe Shinnosuke |
| Maintainers | shinnn |
| Keywords | eslint, setting, config, configs, configuration, arr, ary, array, list, rule, rules |

## Links

- npm: https://www.npmjs.com/package/all-eslint-rules
- Repository: https://github.com/shinnn/all-eslint-rules
- Homepage: https://github.com/shinnn/all-eslint-rules#readme
- Issues: https://github.com/shinnn/all-eslint-rules/issues
- npm.io page: https://npm.io/package/all-eslint-rules

## Dependencies (3)

- [eslint](https://npm.io/package/eslint.md) ^6.0.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.11
- [inspect-with-kind](https://npm.io/package/inspect-with-kind.md) ^1.0.5

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 6.0.0 (latest) — 2019-06-26
- 6.0.0-1 — 2019-06-26
- 6.0.0-0 — 2019-06-23
- 5.0.0 — 2018-06-25
- 5.0.0-0 — 2018-06-25
- 4.0.0 — 2017-06-12
- 3.0.0 — 2017-03-15
- 2.1.2 — 2017-03-14
- 2.1.1 — 2016-07-04
- 2.1.0 — 2016-07-02
- 2.0.1 — 2016-04-12
- 2.0.0 — 2016-02-13
- 1.0.1 — 2015-09-03
- 1.0.0 — 2015-09-03
- 0.0.0 — 2015-09-03

## README

# all-eslint-rules

[![npm version](https://img.shields.io/npm/v/all-eslint-rules.svg)](https://www.npmjs.com/package/all-eslint-rules)
[![GitHub Actions](https://action-badges.now.sh/shinnn/all-eslint-rules)](https://wdp9fww0r9.execute-api.us-west-2.amazonaws.com/production/results/shinnn/all-eslint-rules)
[![codecov](https://codecov.io/gh/shinnn/all-eslint-rules/branch/master/graph/badge.svg)](https://codecov.io/gh/shinnn/all-eslint-rules)

Get all available [ESLint](https://eslint.org) rules

```javascript
const allEslintRules = require('all-eslint-rules');

allEslintRules();
//=> ['accessor-pairs', 'array-bracket-newline', 'array-bracket-spacing', ...]
```

## Installation

[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/about-npm/).

```
npm install all-eslint-rules
```

## API

```javascript
const allEslintRules = require('all-eslint-rules');
```

### allEslintRules([*options*])

*options*: `Object | CLIEngine`  
Return: `string[]`

It returns an `Array` of available [ESLint](https://github.com/eslint/eslint) rule names – [the built-in ones](https://eslint.org/docs/rules/) and the ones defined by external [plugins](https://eslint.org/docs/user-guide/configuring#configuring-plugins). [Deprecated](https://eslint.org/docs/rules/#deprecated) rules are excluded.

```javascript
const rules = allEslintRules();

// Both indent-legacy and no-spaced-func are deprecated.
rules.includes('indent-legacy'); //=> false
rules.includes('no-spaced-func'); //=> false
```

The optional parameter accepts either a plain `Object` to set [`CLIEngine`](https://eslint.org/docs/developer-guide/nodejs-api#cliengine) options or an already instantiated `CLIEngine`, and affects the result.

```javascript
// When eslint-plugin-promise https://www.npmjs.com/package/eslint-plugin-promise is installed

allEslintRules({
  useEslintrc: false,
  plugins: []
}).includes('promise/param-names'); //=> false

allEslintRules({
  useEslintrc: false,
  plugins: ['promise']
}).includes('promise/param-names'); //=> true
```

## License

[ISC License](./LICENSE) © 2018 - 2019 Watanabe Shinnosuke

---
_Source: https://npm.io/package/all-eslint-rules · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._