npmに公開したパッケージを非推奨（deprecated）にする

npmにパッケージを公開したけど、今はもうメンテナンスしていないパッケージはないだろうか？自分にはある。 とあるコードを書いている最中にnpmに非推奨（deprecated）の概念があることがわかったので手順を記録しておく。忘備録的な記事です。

手順

調べたところ、npmのドキュメントがあった。

https://docs.npmjs.com/cli/deprecate.html

npm deprecate <pkg>[@<version>] <message>という形式で実行できる。今回は以下のコマンドを実行した。

$ npm deprecate gatsby-plugin-workbox "Gatsby now supports workbox. Please use gatsby-plugin-offline."

deprecatedになるとどうなるか？

npmのパッケージページ上部にThis package has been deprecatedという表示が出る。

https://www.npmjs.com/package/gatsby-plugin-workbox

また、npm / yarn CLIでインストールする際にdeprecatedに設定したメッセージが表示されるようになる。 この表示からするにdeprecatedなメッセージ以外に、代わりに使ってほしいパッケージを表示するのが親切だろう。