npm 包 @putout/formatter-progress 使用教程

前言

@putout/formatter-progress 是一个能够在命令行中显示代码检查进度的 npm 包。它基于 putout 开发而来，可与其他 putout 插件一起使用。本文将为读者详细介绍该 npm包的使用方法，旨在帮助读者更加高效地使用 putout 代码检查工具。

介绍

@putout/formatter-progress 通过在命令行中动态地显示代码检查进度，让开发者更加清晰地了解代码检查的进展情况。其具有以下特性：

• 能够显示被解析的文件数目和已通过的文件数目。
• 能够显示当前正在检查的文件路径。
• 能够显示每个文件检查的结果。
• 能够在检查完成后输出统计信息。

安装

您可以通过以下 npm 命令在您的项目中安装 @putout/formatter-progress 。

npm install @putout/formatter-progress --save-dev

使用方法

在安装 @putout/formatter-progress 后，您可以在 .putout.yml 文件中使用它。以下是一个示例配置：

format: progress
rules:
    - "remove-unused-variables"
    - "remove-debugger"

format: progress 配置告诉 putout 使用 @putout/formatter-progress 来显示检查结果。您可以根据您的需求配置其他 putout 配置。rules 列表指定了要执行的检查规则。

示例

考虑以下 JavaScript 文件：

var unusedVariable = "I'm unused.";
console.log("Hello, World!");

运行 putout 命令后，输出将如下所示：

progress: 1/1 files
    lib/index.js
      ✓ remove-unused-variables
      ✓ remove-debugger

ESLint v7.19.0

✔ 2 problems (0 errors, 0 warnings)

命令行输出了以下信息：

• 程序处理的文件总数为 1，因为我们只有一个文件。
• 文件路径为 "lib/index.js"。
• 检查了两个规则，remove-unused-variables 和 remove-debugger，都被成功通过。

✔ 2 problems (0 errors, 0 warnings)

该信息表明在检查过程中，没有发现任何错误或警告。

总结

@putout/formatter-progress 可以让开发者更加高效地了解 putout 代码检查工具的执行进度，让开发者专注于代码的梳理和优化。在使用 putout 代码检查工具时，请务必记得安装和使用该 npm 包。

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