在开发过程中，经常会遇到一些依赖过时的 npm 包，为了保证代码的质量和稳定性，我们需要尽早地发现这些问题，及时地进行更新。
而 npm 包 obsolete 可以帮助我们发现过时的依赖包，并提供一些更新建议，极大地简化了依赖更新的工作。
本文将介绍 npm 包 obsolete 的使用方法及注意事项，同时提供一些示例代码。
安装
使用 npm 安装 obsolete：
npm install -g obsolete
使用
基本用法
在终端窗口中运行以下命令：
obsolete
obsolete 将扫描当前目录下的 package.json 文件，发现过时的依赖后输出如下信息：
Package mysql is deprecated. Switch to mysql2.
输出 JSON 格式
使用 --json 参数可以输出 JSON 格式的信息，方便后续程序处理。
obsolete --json
输出如下：
-- -------------------- ---- -------
-
-
---------- --------
------------- -
---------
--
----------------- -
-------
--
--------- --------
------------- -----
------------------ ---------------------------
-------------- -
---------- ---------
--------- --------
------------- -----
-
-
-忽略依赖检查
有时候我们不希望检查某些依赖包，可以使用 --ignore <package> 忽略检查。
obsolete --ignore mysql
指定 package.json 文件
使用 -p <path> 参数可以指定要检查的 package.json 文件的路径。
obsolete -p ~/project/package.json
指定 yarn.lock 文件
使用 -y <path> 参数可以指定 yarn.lock 文件的路径。
obsolete -y ~/project/yarn.lock
指定 npm-shrinkwrap.json 文件
使用 -s <path> 参数可以指定 npm-shrinkwrap.json 文件的路径。
obsolete -s ~/project/npm-shrinkwrap.json
示例代码
以下是一个示例代码，演示如何使用 obsolete 发现并更新过时的依赖包。
-- -------------------- ---- ------- ----- ----- - ----------------- ----- ----- - ----------------- ----- -------- ---------- - ----- -------- - ----- -------------------------------------------------------- ------ -------------- - ----- ---------- - ------------------------ ----- ------------ ----- ------- --------- ----------- --------- ------ --- --------------------- ------------------------ - ---- ------- -------- ------- -------- ------- - -- ------- ----- ------ --------------------- --- ----------------- --------------------- -- - ------------------- ---
使用 obsolete 发现过时依赖：
obsolete
输出：
Package mysql is deprecated. Switch to mysql2.
根据提示，将 mysql 替换为 mysql2。
npm install mysql2
修改代码：
-- -------------------- ---- ------- ----- ----- - ----------------- ----- ------ - -------------------------- ----- -------- ---------- - ----- -------- - ----- -------------------------------------------------------- ------ -------------- - ----- ---- - ------------------- ----- ------------ ----- ------- --------- ----------- --------- ------ --- ------ -- -- - ----- ---- - ----- --------------------- ----- ------ ------- - ----- -------------------- - ---- -------- ------------------ --------------- ----- --------------------- -- - ------------------- ---
再次运行，可以看到程序正常运行，并且 obsolete 不再提示关于 mysql 的消息。
注意事项
obsolete 仅能检查当前项目中的依赖包，如果依赖包来自于父级目录或全局安装，则无法检查。
obsolete 不保证推荐的更新方法一定是最优的，需要开发者自行判断是否适合当前项目。
obsolete 可能会忽略一些自定义的安装方式，如 Git 或本地文件，这时需要手动检查更新。
结论
使用 npm 包 obsolete 可以大大简化依赖包更新的工作，以便更好地保证代码的质量和稳定性。但需要开发者仔细判断更新推荐是否适合当前项目。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/161803