# eslint-plugin-deprecation
> ESLint rule that reports usage of deprecated code
Latest version **3.0.0** (published 2024-05-31) · LGPL-3.0-or-later license · 0 weekly downloads
## Install
```sh
npm install eslint-plugin-deprecation
pnpm add eslint-plugin-deprecation
yarn add eslint-plugin-deprecation
bun add eslint-plugin-deprecation
```
## Health
**Score 25/100 (F)** — status: abandoned.
Positive: has types; no vulnerabilities; high quality score.
Warnings: low downloads; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 3.0.0 |
| Published | 2024-05-31 |
| First published | 2020-02-16 |
| Weekly downloads | 0 |
| License | LGPL-3.0-or-later |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 49.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 328 |
| Author | Alex Malkevich |
| Maintainers | gund |
## Links
- npm: https://www.npmjs.com/package/eslint-plugin-deprecation
- Repository: https://github.com/gund/eslint-plugin-deprecation
- Homepage: https://github.com/gund/eslint-plugin-deprecation#readme
- Issues: https://github.com/gund/eslint-plugin-deprecation/issues
- npm.io page: https://npm.io/package/eslint-plugin-deprecation
## Dependencies (3)
- [tslib](https://npm.io/package/tslib.md) ^2.3.1
- [ts-api-utils](https://npm.io/package/ts-api-utils.md) ^1.3.0
- [@typescript-eslint/utils](https://npm.io/package/@typescript-eslint/utils.md) ^7.0.0
## Recent versions
- 3.0.0 (latest) — 2024-05-31
- 1.4.0-next.2 (next) — 2023-03-31
- 2.0.0 — 2023-09-13
- 1.6.0 — 2023-09-13
- 1.5.0 — 2023-07-27
- 1.4.1 — 2023-04-05
- 1.4.0 — 2023-04-01
- 1.4.0-next.1 — 2023-02-22
- 1.3.3 — 2022-11-14
- 1.3.2 — 2021-12-15
- 1.3.1 — 2021-12-14
- 1.3.0 — 2021-12-14
- 1.2.1 — 2021-05-04
- 1.2.0 — 2020-12-07
- 1.1.1 — 2020-12-06
- … 3 more at https://npm.io/package/eslint-plugin-deprecation/versions
## README
# eslint-plugin-deprecation
[](https://github.com/gund/eslint-plugin-deprecation/actions/workflows/test.yml)
[](https://github.com/gund/eslint-plugin-deprecation/actions/workflows/release.yml)
[](https://codeclimate.com/github/gund/eslint-plugin-deprecation/maintainability)
[](https://www.npmjs.com/package/eslint-plugin-deprecation)
[](https://www.npmjs.com/package/eslint-plugin-deprecation)
[](https://github.com/gund/eslint-plugin-deprecation/blob/master/LICENSE)
[](https://github.com/semantic-release/semantic-release)
> An [ESLint](https://eslint.org/) plugin with rules reporting usage of deprecated code
## Prerequisites
If you already use [TypeScript](https://www.typescriptlang.org/) and one or more rules from the [`typescript-eslint`](https://typescript-eslint.io/) plugin, then `eslint-plugin-deprecation` will work out of the box without any additional dependencies or special configuration specified in this section. (This is because `@typescript-eslint/plugin` automatically contains `@typescript-eslint/parser` and your ESLint should already be configured with the `parserOptions` to work properly with TypeScript.)
Otherwise, in order for you to use this plugin, you must also install the following dependencies:
- `typescript`
- `@typescript-eslint/parser`
For example, if you use the `npm` package manager, then you would run the following command in the root of your project:
```sh
npm install --save-dev typescript @typescript-eslint/parser
```
Next, you must configure ESLint to parse TypeScript and include type information:
```jsonc
{
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaVersion": 2020,
"sourceType": "module",
"project": "./tsconfig.json" // <-- Point to your project's "tsconfig.json" or create a new one.
}
}
```
## Install
For example, if you use the `npm` package manager, then you would run the following command in the root of your project:
```sh
npm install --save-dev eslint-plugin-deprecation
```
## Setup
### Using the `recommended` Config
The easiest way to use this plugin is to extend from the `recommended` config, like this:
```jsonc
{
"extends": [
"plugin:deprecation/recommended",
],
}
```
The `recommended` config will enable the plugin and enable the `deprecation/deprecation` rule with a value of `error`.
### Manually Enable the Plugin and Rule
If you don't want to use the `recommended` config for some reason, you can accomplish the same thing by specifying the following config:
```jsonc
{
"plugins": [
"deprecation",
],
"rules": {
"deprecation/deprecation": "error",
},
}
```
## Rules
### Disallow usage of deprecated APIs (`deprecation/deprecation`)
Reports usage of any code marked with a [`@deprecated` JSDoc tag](https://jsdoc.app/tags-deprecated.html).
For example, this includes browser APIs, Node.js APIs, library APIs and any other code that is marked with this tag.
#### Rule Details
Examples of **incorrect** code for this rule:
```ts
import { parse } from 'node:url';
import cheerio from 'cheerio';
// Node.js API
const url = parse('/foo'); // ❌ 'parse' is deprecated. Use the WHATWG URL API instead. eslint(deprecation/deprecation)
// Browser API
console.log(event?.bubbles); // ❌ 'event' is deprecated. [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/event) eslint(deprecation/deprecation)
// Deprecated library API
cheerio('Hello world
'); // ❌ 'cheerio' is deprecated. Use the function returned by `load` instead. eslint(deprecation/deprecation)
```
Examples of **correct** code for this rule:
```ts
import { load } from 'cheerio';
import { ChangeEvent } from 'react';
// Node.js API
const url2 = new URL('/foo', 'http://www.example.com'); // ✅ Modern Node.js API, uses `new URL()`
// Browser API
function onClick(event: ChangeEvent) {
console.log(event.bubbles); // ✅ Modern browser API, does not use global
}
// Library API
load('Hello world
'); // ✅ Allowed library API, uses named `load` import
```
## Credits
This rule was originally ported from the [SonarJS repository](https://github.com/SonarSource/SonarJS).
---
_Source: https://npm.io/package/eslint-plugin-deprecation · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._