Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ipasechnikov/eslint-plugin-deprecated-rules
ESLint plugin to warn you about deprecated rules used in your project's ESLint configuration file
https://github.com/ipasechnikov/eslint-plugin-deprecated-rules
eslint eslint-plugin eslintplugin
Last synced: 1 day ago
JSON representation
ESLint plugin to warn you about deprecated rules used in your project's ESLint configuration file
- Host: GitHub
- URL: https://github.com/ipasechnikov/eslint-plugin-deprecated-rules
- Owner: ipasechnikov
- License: mit
- Created: 2023-11-24T17:06:31.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-02-25T17:38:01.000Z (9 months ago)
- Last Synced: 2024-10-12T17:22:15.039Z (about 1 month ago)
- Topics: eslint, eslint-plugin, eslintplugin
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/eslint-plugin-deprecated-rules
- Size: 485 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# eslint-plugin-deprecated-rules
Warns about deprecated or removed ESLint rules in ESLint config.
This small plugin was created for the purpose of finding whether our team of developers is using deprecated rules for the currently installed version of ESLint.
Meaning, if you are using an older version of ESLint and a rule got deprecated in newer versions, then you won't get any warnings.
This plugin's rules work both for ESLint core rules, as well as rules provided by 3rd-party plugins.
## Table of Contents
- [eslint-plugin-deprecated-rules](#eslint-plugin-deprecated-rules)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Usage](#usage)
- [Option 1. Add plugin and its rules](#option-1-add-plugin-and-its-rules)
- [Option 2. Extend `recommended` config](#option-2-extend-recommended-config)
- [Rules](#rules)
- [Built With](#built-with)
- [Versioning](#versioning)
- [License](#license)
## Installation
You'll first need to install [ESLint](https://eslint.org/):
```sh
npm i eslint --save-dev
```
Next, install `eslint-plugin-deprecated-rules`:
```sh
npm install eslint-plugin-deprecated-rules --save-dev
```
## Usage
There are 2 main ways to use this package:
- Add plugin and its rules manually
- Extend `recommended` config provided by the plugin
### Option 1. Add plugin and its rules
Add `deprecated-rules` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
```json
{
"plugins": [
"deprecated-rules"
]
}
```
Then configure the rules you want to use under the rules section.
```json
{
"rules": {
"deprecated-rules/no-deprecated-rules": "warn"
}
}
```
### Option 2. Extend `recommended` config
```json
{
"extends": [
"plugin:deprecated-rules/recommended"
]
}
```
## Rules
⚠️ Configurations set to warn in.\
✅ Set in the `recommended` configuration.
| Name | Description | ⚠️ |
| :------------------------------------------------------- | :-------------------------------- | :- |
| [no-deprecated-rules](docs/rules/no-deprecated-rules.md) | Warns for ESLint deprecated rules | ✅ |
## Built With
- [eslint-find-rules](https://github.com/sarbbottam/eslint-find-rules) - used to parse ESLint configs and extract rules
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/ipasechnikov/eslint-plugin-deprecated-rules/tags).
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.