如何记录 NPM 包？

在现代化的 Web 开发中，NPM（Node Package Manager）已成为了许多开发者的首选工具。NPM 是用于管理 Node.js 包的命令行工具。如果你是一位 Node.js 或 Web 开发者，你可能会面临这样的需求：记录自己正在使用或者计划使用的 NPM 包，以方便查阅和分享。本文将介绍如何记录 NPM 包。

方法一：使用 Markdown 文件

可以通过编写 Markdown 文件的方式来记录自己使用的 NPM 包，具体操作如下：

1. 在你的项目根目录下新建一个名为 packages.md 的文件。
2. 在文件中添加如下内容：

# 我的 NPM 包列表

| 包名 | 说明 |
| --- | --- |
| package1 | 用于实现 xxx 功能 |
| package2 | 用于实现 yyy 功能 |
| package3 | 用于实现 zzz 功能 |

3. 根据你使用或计划使用的 NPM 包数量进行添加和修改。

这样，就可以通过查看 packages.md 文件来了解你所使用的 NPM 包列表。

方法二：使用工具进行记录

除了手动编写 Markdown 文件之外，我们也可以使用一些第三方工具来记录自己的 NPM 包列表。下面介绍一个比较实用的工具: npm-check。

npm-check 是一个命令行工具，可以检查当前项目的 NPM 包的更新情况并且能够列出当前项目的依赖项，非常方便。同时，npm-check 还支持输出 HTML、JSON 和 Markdown 格式的依赖报告。

安装 npm-check：

npm install -g npm-check

运行 npm-check 并保存输出为 Markdown：

npm-check --save --markdown > packages.md

这样，就可以一键生成你的 NPM 包列表并保存为 packages.md 文件。

总结

无论是手动编写 Markdown 文件还是使用 npm-check 工具，记录自己使用的 NPM 包都非常简单。无论是对于个人开发者还是团队协作而言，记录 NPM 包都是非常有价值的。这样可以方便查询、复用，也有助于规范开发流程。