如何实现只让 ESLint 校验 git 状态中的代码
前言
在前端开发过程中，我们经常使用 ESLint 来规范我们的代码。但是，有时候我们可能只想让 ESLint 校验 git 状态中的代码，而不是所有的代码。那么，该如何实现呢？下面，我就来为大家详细介绍一下。
背景
在开发项目中，我们可能需要使用 Git 来管理我们的代码。而在开发过程中，我们常常需要提交代码到 Git，但是有时候我们提交的代码可能并不符合 ESLint 的规范。如果我们让 ESLint 校验所有的代码，那么无疑会增加我们的工作量。因此，我们需要找到一种方法，只让 ESLint 校验 Git 状态中的代码。
实现
下面是具体的实现步骤：
- 安装依赖
首先，我们需要安装一些依赖：
npm install --save-dev husky lint-staged
Husky 是一个 Git hook 工具，可以让我们在 Git hook 周期中执行命令。而 lint-staged 是一个工具，可以让我们在提交代码之前，根据指定的文件来执行 ESLint，并只校验 git 状态中的代码。
- 添加 Husky 钩子
接下来，我们需要在项目的 package.json 文件中添加 Husky 钩子。钩子的作用是在 Git 执行特定的操作之前执行一些命令。
-- -------------------- ---- -------
-
------- -------------
-------- -
-------- -
------------- --------------
----------- ------
-
-
-如上所示，这里我们指定了两个 Husky 钩子，分别是 pre-commit 和 pre-push。其中 pre-commit 钩子会在提交代码之前执行代码格式化，而 pre-push 钩子会在推送代码之前执行测试命令。
- 添加 lint-staged 配置
如果我们想要只让 ESLint 校验 git 状态中的代码，我们需要在项目的 package.json 文件中添加 lint-staged 配置。
-- -------------------- ---- -------
-
------- -------------
---------- -
------- ----- -------- -- ---- ----------- -- ---- --
--
-------- -
-------- -
------------- --------------
----------- ------
-
--
-------------- -
---------- -
------- ------- ------- ------------------
---- ----
--
----------------- -
--------- ---------
---- ----
-
-
-如上所示，我们指定了要校验的文件为所有的 .js 文件，同时指定了要执行的命令。该命令将会对 Git 状态中的代码进行 ESLint 校验，并将校验通过的代码提交到 Git。
优化
除了上述方法之外，我们还可以通过 .eslintrc.js 文件来自定义配置文件。在这里，我们可以随意定义一些自己的配置，以满足我们的实际需求。下面，我将为大家展示如何自定义配置文件。
-- -------------------- ---- -------
-- ------------
-------------- - -
----- -----
------- ----------------------------
-------- -
---------------------
--
-------- -
---------------------
----------------------------------------
-----------
------------------------------
--
------ -
------------- --------- - ------ -------- -------- ---
------------------------------------- ------
--
-具体的配置说明如下：
- root：指定根目录为当前目录。
- parser：指定 ESLint 采用的解析器。
- plugins：指定 ESLint 采用的插件。
- extends：指定基础规则。
- rules：指定自定义规则。
结论
通过上述步骤，我们成功的实现了只让 ESLint 校验 git 状态中的代码。这样，我们就不用再为一些不需要校验的代码浪费时间去检查。同时，我们还可以通过自定义配置文件来满足我们的实际需求，使得我们的校验更加符合项目的实际情况。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67498d62a1ce006354662301