npm 包 eslint-watch 使用教程-JavaScript中文网-JavaScript教程资源分享门户

什么是 ESLint？

ESLint 是一个开源的 JavaScript 代码检查工具，它被广泛地应用于前端项目中。通过使用 ESLint 可以帮助我们检测代码中可能存在的错误、不规范等问题，并规范化我们的代码风格。

eslint-watch 是一个基于 ESLint 的 npm 包，它可以在代码文件被修改时实时运行 ESLint 检查，并给出相应的警告或错误提示。这个包主要有两个优点：

实时性：当我们写代码的时候，如果保存后需要手动去命令行执行 ESLint 检查，那会非常麻烦。使用 eslint-watch 后，每次保存代码文件时，都会自动触发 ESLint 进行检查。
提升效率：在写代码的过程中，我们经常需要频繁地调试和修改代码。如果每次修改后都需要手动执行一次 ESLint 检查，那将会严重影响我们的效率。使用 eslint-watch 后，我们只需要专注于代码的修改和调试，其他的事情都会自动处理。

首先，我们需要安装 eslint 和 eslint-watch 这两个 npm 包。
```
npm install eslint eslint-watch --save-dev
```
接下来，在项目根目录下创建一个 .eslintrc.js 文件，并配置相关的规则。这里我们以 airbnb 的 eslint 配置为例进行说明：
```
-- -------------------- ---- -------
-------------- - -
  -------- --------------
  ------ -
    -- -----
  --
  ---- -
    -------- -----
  --
--
```
如果您不熟悉如何配置 eslint 规则，可以参考官方文档：https://eslint.org/docs/user-guide/configuring。
在 package.json 文件中添加以下代码：
```
"scripts": {
  "lint": "eslint .",
  "lint:watch": "eslint-watch"
}
```
这里我们定义了两个脚本命令：lint 和 lint:watch。其中，lint 命令会在当前目录下执行 ESLint 检查，而 lint:watch 命令则会启动 eslint-watch，在文件被修改时自动检查代码并给出相应的提示。
最后，我们只需要在命令行中运行 npm run lint:watch 命令即可启动 eslint-watch。

示例代码：

// index.js 文件
const add = (a, b) => {
  return a + b;
};

console.log(add(1, 2));

如果我们在修改上面的代码后保存文件，eslint-watch 会自动运行 ESLint 检查，并输出类似如下的提示信息：

> eslint-watch

✔ ESLint found no errors in file app.js

通过使用 eslint-watch，我们可以方便地对 JavaScript 代码进行实时检查，大大提升我们的开发效率。当然，在使用的过程中也需要注意一些细节问题，比如如何正确配置 .eslintrc.js 文件等等。希望此教程能够对您有所帮助！

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