https://github.com/AlexMost/eslint-plugin-deprecate

simple eslint rules for deprecation
https://github.com/AlexMost/eslint-plugin-deprecate

Last synced: 3 months ago
JSON representation

simple eslint rules for deprecation

• Host: GitHub
• URL: https://github.com/AlexMost/eslint-plugin-deprecate
• Owner: AlexMost
• License: mit
• Created: 2017-03-01T15:55:40.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-10-12T08:33:46.000Z (about 1 year ago)
• Last Synced: 2024-05-01T03:04:42.025Z (6 months ago)
• Language: JavaScript
• Homepage:
• Size: 286 KB
• Stars: 78
• Watchers: 3
• Forks: 10
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-eslint - deprecate - Mark functions or modules as deprecated and get lint messages when they are used. (Plugins / Deprecation)

README

        
[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direct.svg)](https://stand-with-ukraine.pp.ua)

# eslint-plugin-deprecate

[![NPM version](http://img.shields.io/npm/v/eslint-plugin-deprecate.svg)](https://www.npmjs.com/package/eslint-plugin-deprecate)

![downloads](https://img.shields.io/npm/dm/eslint-plugin-deprecate.svg)

This plugin helps you to refactor your codebase.

## Installation

You'll first need to install [ESLint](http://eslint.org):

```

$ npm i eslint --save-dev

```

Next, install `eslint-plugin-deprecate`:

```

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

```

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

## Usage

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

```json

{

    "plugins": [

        "deprecate"

    ]

}

```

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

```json

{

    "rules": {

        "deprecate/rule-name": 2

    }

}

```

## Supported Rules

* [deprecate/function](docs/rules/function.md): Warn about some function usage.

* [deprecate/member-expression](docs/rules/member-expression.md): Warn about some member expression usages.

* [deprecate/import](docs/rules/import.md): Warn about some import/require usage.