Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

eslint-plugin-deprecation

1.1.0 • Public • Published

eslint-plugin-deprecation

Build Status Maintainability Npm Npm Downloads Size Licence semantic-release

ESLint rule that reports usage of deprecated code

Prerequisites

This plugin only works with @typescript-eslint/parser.

Which means that you should install dev deps:

  • @typescript-eslint/parser
  • typescript

Then configure your .eslintrc like this:

{
  "parser": "@typescript-eslint/parser",
  "parserOptions": {
    "ecmaVersion": 2020,
    "sourceType": "module",
    "project": "./tsconfig.json" // <-- Point to your project's tsconfig.json or create new one
  },
  "settings": {
    "import/parsers": {
      "@typescript-eslint/parser": [".ts", ".tsx"]
    },
    "import/resolver": {
      "typescript": {
        "alwaysTryTypes": true,
        "directory": "./tsconfig.json" // <-- Same tsconfig.json must be referenced
      }
    }
  }
}

Install

Install the plugin

npm i -D eslint-plugin-deprecation

Setup

Now add deprecation plugin and rule to your .eslintrc:

{
  "plugins": ["deprecation", ...],
  "rules": {
    "deprecation/deprecation": "warn", // or "error" to have stricter rule
    ...
  }
}

Now eslint will report all deprecated code that you use!


NOTE: This rule was ported from https://github.com/SonarSource/SonarJS repository.

Keywords

none

Install

npm i eslint-plugin-deprecation

DownloadsWeekly Downloads

3,696

Version

1.1.0

License

LGPL-3.0-or-later

Unpacked Size

42.6 kB

Total Files

14

Last publish

Collaborators

  • avatar