Skip to content

findmypast-oss/eslint-plugin-deprecate-import

Repository files navigation

eslint-plugin-deprecate-import

npm version build status


An ESLint plugin to deprecate import statements

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-deprecate-import:

$ npm install eslint-plugin-deprecate-import --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-deprecate-import globally.

Usage

Add deprecate-import to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "plugins": ["deprecate-import"]
}

Then configure the rules you want to use under the rules section.

{
  "rules": {
    "deprecate-import/rule-name": 2
  }
}

Supported Rules

  • module: Deprecates npm module imports via regex pattern matching