# eslint-rule-docs

> Find documentation url for a given ESLint rule

Latest version **1.1.235** (published 2022-05-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install eslint-rule-docs
pnpm add eslint-rule-docs
yarn add eslint-rule-docs
bun add eslint-rule-docs
```

## 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 | 1.1.235 |
| Published | 2022-05-27 |
| First published | 2018-07-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 195.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Stefan Buck |
| Maintainers | stefanbuck |
| Keywords | eslint, eslint-plugin, docs, documenation, rules, rule |

## Links

- npm: https://www.npmjs.com/package/eslint-rule-docs
- Repository: https://github.com/stefanbuck/eslint-rule-docs
- Homepage: https://github.com/stefanbuck/eslint-rule-docs#readme
- Issues: https://github.com/stefanbuck/eslint-rule-docs/issues
- npm.io page: https://npm.io/package/eslint-rule-docs

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 1.1.235 (latest) — 2022-05-27
- 1.1.234 — 2022-05-27
- 1.1.233 — 2022-05-27
- 1.1.232 — 2022-05-27
- 1.1.231 — 2021-07-25
- 1.1.230 — 2021-07-04
- 1.1.229 — 2021-06-27
- 1.1.228 — 2021-06-20
- 1.1.227 — 2021-05-30
- 1.1.226 — 2021-05-02
- 1.1.225 — 2021-04-25
- 1.1.224 — 2021-04-11
- 1.1.223 — 2021-03-14
- 1.1.222 — 2021-02-21
- 1.1.221 — 2021-02-14
- … 242 more at https://npm.io/package/eslint-rule-docs/versions

## README

# eslint-rule-docs 
[![Actions Status](https://github.com/stefanbuck/eslint-rule-docs/workflows/Cron/badge.svg)](https://github.com/stefanbuck/eslint-rule-docs/actions) [![NPM](https://badgen.net/npm/v/eslint-rule-docs)](https://npmjs.com/package/eslint-rule-docs) 

> Find documentation url for a given ESLint rule. Updated daily!

## Install

```bash
$ npm install eslint-rule-docs
```

## Usage

```js
const getRuleUrl = require('eslint-rule-docs');

// Find url for core rules
getRuleUrl('no-undef');
// => { exactMatch: true, url: 'https://eslint.org/docs/rules/no-undef' }

// Find url for known plugins
getRuleUrl('react/sort-prop-types');
// => { exactMatch: true, url: 'https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/sort-prop-types.md' }

// If the plugin has no documentation, return repository url 
getRuleUrl('flowtype/semi');
// => { exactMatch: false, url: 'https://github.com/gajus/eslint-plugin-flowtype' }

// If the plugin is unknown, returns an empty object
getRuleUrl('unknown-foo/bar');
// => {}
```

## License

Copyright (c) 2018–present [Stefan Buck](https://stefanbuck.com/). Licensed under the MIT license.

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