@deprecatedを付けた関数や変数を呼んだら警告する

概要

コードベース内で徐々にアーキテクチャや使用するライブラリ等々を変更する際等に既存のコードをdeprecated(非推奨・廃止予定)扱いにしたいケース等があるかと思います。

下記のeslint-pluginを使用することで簡単にJSDocの@deprecatedタグの付いたコードを使用するとeslintで警告してくれるように出来ます。

https://github.com/gund/eslint-plugin-deprecation

前提条件

eslintのparserが@typescript-eslint/parserである必要があります。

それ以外のparserで使用したい場合は
eslint-plugin-sonarjsでも同じようなルールがありそうでしたので、そちらを使用するとできるはずです。

使用方法

eslintのpluginなので、下記のようにdev dependenciesとしてインストールして.eslintrc内に追加するだけです。

npm i -D eslint-plugin-deprecation

{
  "plugins": ["deprecation", ...],
  "rules": {
    "deprecation/deprecation": "warn",
    ...
  }
}

使用結果

下記のようなコードでinterfaceと関数に@deprecatedをつけてあげます。

@deprecatedのついたコードを使用しようとすると下記のように警告を出してくれます。