npm 包 nsp-formatter-remarkup 使用教程

什么是 nsp-formatter-remarkup

nsp-formatter-remarkup 是一个 npm 包，它提供了一种将 npm audit 产生的报告转换为可视化报告的功能。nsp-formatter-remarkup 会将报告转化为一个 markup 文件，然后转化为 HTML 文件，以便您可以以更直观的方式查看报告。

安装 nsp-formatter-remarkup

在安装 nsp-formatter-remarkup 之前，您需要先安装 Node.js 和 npm。

安装完成后，您可以通过下面的命令安装 nsp-formatter-remarkup：

npm install -g nsp-formatter-remarkup

使用 nsp-formatter-remarkup

使用 nsp-formatter-remarkup 的步骤如下：

1. 运行 npm audit。这将生成一个安全漏洞报告。

npm audit

1. 将报告输出到一个文件中。您可以将报告输出到任何您想要的地方，但最好将其输出到一个单独的文件中，以便您稍后可以使用它。

npm audit --json > audit-result.json

1. 运行 nsp-formatter-remarkup。这将转换报告成 markup 文件。

npx nsp-formatter-remarkup audit-result.json > audit-result.markup

1. 将 markup 文件转换为 HTML 文件，并打开它以查看报告。

npx w3m audit-result.markup -dump -T 'text/html' > audit-result.html && open audit-result.html

nsp-formatter-remarkup 使用示例

下面是一个简单的示例，演示如何使用 nsp-formatter-remarkup 来生成报告。在本示例中，我们将会创建一个具有漏洞的 Node.js 应用，然后使用 nsp-formatter-remarkup 来检查它。

1. 创建 Node.js 应用。

mkdir demo && cd demo
npm init -y

1. 安装具有漏洞的 npm 包。

npm install serialize-javascript@2.1.2

1. 打开漏洞报告。

npm audit

报告将会给出一个安全漏洞的警告，类似于下面的输出：

found 1 low severity vulnerability
  run `npm audit fix` to fix them, or `npm audit` for details

1. 将漏洞报告保存到一个文件中。

npm audit --json > audit-result.json

1. 转换漏洞报告为 markup 格式。

npx nsp-formatter-remarkup audit-result.json > audit-result.markup

1. 将 markup 文件转换为 HTML 文件，并打开它以查看报告。

npx w3m audit-result.markup -dump -T 'text/html' > audit-result.html && open audit-result.html

报告将会显示出一个可视化的标记页面，其中包含了漏洞报告的详细信息和建议，如下图所示。

结论

nsp-formatter-remarkup 是一个很有用的 npm 包，它可以帮助您将 npm audit 生成的漏洞报告转换为更容易理解的格式。此功能将为您提供更好的可视化报告，以便您可以轻松了解您的代码中存在的漏洞，并尽快进行修复。我希望这篇文章能够对你有所帮助。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066f923d1de16d83a66b79