ESLint 是一个流行的 JavaScript linter 工具，用于在代码编写过程中发现和修复错误。然而，它提供的默认输出格式不够便于人类阅读。这时，eslint-formatter-github 包便派上了用场。
eslint-formatter-github 是一个格式化程序，将 ESLint 的输出转换为 GitHub Actions 注释格式，以便在 GitHub 工作流程中使用。
安装 eslint-formatter-github
如果你已经安装了 ESLint，则可以在项目中安装 eslint-formatter-github。先通过 npm 安装：
npm install eslint-formatter-github --save-dev
在 ESLint 配置文件中使用 eslint-formatter-github
安装完成后，修改 ESLint 配置文件 .eslintrc.json，使其使用 eslint-formatter-github。
你需要在 formatter 属性中指定 github：
{
"extends": "eslint:recommended",
"plugins": [],
"rules": {},
"formatter": "github",
"parserOptions": {}
}注意，你必须在配置文件中启用 output-file 选项。配置示例如下：
{
"output-file": "eslint_output.txt"
}执行 ESLint，将会在 eslint_output.txt 中输出文本信息。为了将输出变成GitHub的注释，需要使用 actions/github@v5 动作，该动作将读取文件中的错误，并用注释的方式在GitHub工作流程中呈现。示例如下：
-- -------------------- ---- -------
----- ------
--- ----
-----
--------
-------- -------------
------
- ----- -------------------
- ----- --- ------- ----
----- ---------------------
-----
------------- ------
- ---- --- --
- ---- --- --- ----
----
------------- --- -------------------- --
- ----- -----------------
--- --- -------- --
-----
------------ -----------------这样，在 GitHub 上推送您的代码时，每次通过 ESLint 检测和修复错误时，都会在 Commit 的评论中看到相应的注释。
总结
通过对 npm 包 eslint-formatter-github 的使用教程，我们学习了如何在Github Actions 中使用格式化程序并使其正确工作。这对于任意一个项目都非常实用，特别是对那些使用 GitHub 工作流程进行操作的项目。通过此教程，希望你能更好地了解如何使用 eslint-formatter-github 这个 NPM 包来改进你的项目代码质量。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f408b61dbf7be33b2567217