前言：在前端开发中，代码风格的一致性非常重要。而代码风格的检查工具 eslint 能够帮助我们做到这一点。本文将介绍一个 npm 包 eslint-formatter-git-log，它能够让我们在检查代码风格时自动生成 Git Log。
什么是 eslint-formatter-git-log？
eslint-formatter-git-log 是一个在 eslint 检查结束后，自动生成 Git Log 的 npm 包。 使用它可以更加方便地追溯代码的变更历史，也能够更加准确地查找代码的问题。
安装
你可以通过以下命令安装 eslint-formatter-git-log：
$ npm install eslint-formatter-git-log --save-dev
使用
- 在项目的 package.json 中配置 eslint 的配置文件路径
在 package.json 中添加以下配置：
{
"eslintConfig": {
"extends": "eslint:recommended",
"rules": {
"semi": "error"
}
}
}这里以官方提供的 eslint:recommended 为例，你也可以根据你的项目需要自定义你的 eslint 配置，比如你需要检查 React 代码你可以添加 react/recommended 规则。
- 检查代码风格
执行 eslint 命令，检查代码风格：
$ eslint ./src
- 生成 Git Log
执行以下命令，生成 Git Log：
$ eslint --format=git-log ./src
- 查看 Git Log
查看生成的 Git Log，可以使用以下命令：
$ git log
示例代码
假设我们有以下代码：
function helloWorld() {
console.log("hello world")
}我们设置的 eslint 配置文件约束了代码必须以分号结尾，所以代码检查将失败。执行以下命令：
$ eslint ./test.js --format=git-log
将会输出以下结果：
1 file checked, 1 error found
/path/to/test.js
2:14 error Missing semicolon semi
eslint-formatter-git-log
warning: git-log formatter found errors. Run with eslint -f eslint-formatter-git-log to see them.
--> commit 0000000000000000000000000000000000000000
Author: anonymous <anonymous>
Date: Thu Jan 1 00:00:00 1970 +0000
🚨 ESLint Error(s)
/path/to/test.js
- line 2:14 : Missing semicolon: 'console'
--> commit b5c5dbc5c5c5c5c5c5c5c5c5c5c5c5c5c5c5c5c5
Author: Your Name <your-email@example.com>
Date: Tue Mar 16 22:39:47 2021 +0800
👷 [eslint]
- Fix missing semicolon
src/test.js | 2 +-其中，第一部分是 eslint 的报错信息；第二部分是 eslint-formatter-git-log 生成的提交记录信息。你可以通过 Git Log 查找到错误的提交并进行修改。
总结
本文介绍了 npm 包 eslint-formatter-git-log 的使用方法，并给出了示例代码。使用它可以更加方便地进行代码风格检查，并能够更加准确地追溯代码的变更历史。
希望本文能够帮助到你更加有效地进行前端开发。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/600673e2fb81d47349e53dc1