ESLint 入门 | 您所在的位置:网站首页 › 代码检查错误 › ESLint 入门 |
ESLint 入门
ESLint 是一个根据方案识别并报告 ECMAScript/JavaScript 代码问题的工具,其目的是使代码风格更加一致并避免错误。在很多地方它都与 JSLint 和 JSHint 类似,除了: ESLint 使用 Espree 对 JavaScript 进行解析。 ESLint 在代码中使用 AST 评估方案。 ESLint 完全是插件式的,每个规则都是一个插件,你可以在运行时中添加更多插件。 安装并使用前提条件:内置 SSL 支持的 Node.js 版本(^12.22.0、^14.17.0 或 >=16.0.0),如果你使用的是官方 Node.js 发行版,那么已经内置了 SSL 支持。 你可以使用该命令安装并配置 ESLint: npm init @eslint/config 1如果你想使用托管在 npm 上的指定可共享配置,你可以使用 --config 选项并指定包名: # 使用 `eslint-config-semistandard` 可共享配置 # npm 6.x npm init @eslint/config --config semistandard # ⚠️ npm 7+ 需要使用额外的双杠: npm init @eslint/config -- --config semistandard # 或(可以省略 `eslint-config` 前缀) npm init @eslint/config -- --config eslint-config-semistandard 1234567--config 标志也支持传递数组 npm init @eslint/config -- --config semistandard,standard # 或 npm init @eslint/config -- --config semistandard --config standard 123注意:使用 npm init @eslint/config 时,运行目录需要已经有 package.json 文件了。如果还没有该文件,请确保在此之前运行 npm init 或 yarn init。 在此之后,你可以像这样使用 ESLint 检查任一文件或目录: npx eslint yourfile.js # 或 yarn run eslint yourfile.js 12345也可以全局安装 ESLint 而不仅限于本地(使用 npm install eslint --global)。但并不推荐这样做,因为无论使用哪种安装方式,你都需要在本地安装插件和可共享配置。 配置注意:如果你正在使用 1.0.0 以前的版本,请阅读迁移指南。 在运行 npm init @eslint/config 后,你的目录下会有 .eslintrc.{js,yml,json} 文件。在里面你可以看到类似于这样的一些已经配置好了的规则: { "rules": { "semi": ["error", "always"], "quotes": ["error", "double"] } } 123456"semi" 和 "quotes" 是 ESLint 规则的名称。第一个值代表规则的错误级别,有以下几种可供选择: "off" 或 0 - 关闭该规则 "warn" 或 1 - 启用并警告(不影响现有代码) "error" 或 2 - 启用并报错(错误代码 1)你可以调节这三档错误级别以精准控制 ESLint 规则实施方式(更多配置项和细节,参见配置文档)。 你的 .eslintrc.{js,yml,json} 配置文件也会包括这一行: { "extends": "eslint:recommended" } 123这一行将启用所有标记为“推荐”的规则。另外,你也可以通过在 npmjs.com 上搜索“eslint-config”并使用别人创建的配置。在没有使用别人的可共享配置或在配置中明确启用规则时,ESLint 不会检查你的代码。 全局安装也可以全局安装 ESLint 而不仅限于本地(使用 npm install eslint --global)。但并不推荐这样做,因为即使全局安装 ESLint,你仍需要在本地安装插件和可共享配置。 手动设置你也可以在项目中手动设置 ESLint. 在开始前你必须确保存在 package.json 文件。如果不存在,请优先运行 npm init 或 yarn init 来创建此文件。 在项目中安装 ESLint 包: npm install --save-dev eslint 1添加任一支持的配置文件格式的 .eslintrc 文件。 # 创建 JavaScript 配置文件 touch .eslintrc.js 12在 .eslintrc 文件中添加配置。阅读配置 ESLint 文档学习如何添加规则、环境、自定义配置、插件以及其他内容。 // .eslintrc.js 示例 module.exports = { "env": { "browser": true, "es2021": true }, "extends": "eslint:recommended", "parserOptions": { "ecmaVersion": "latest", "sourceType": "module" }, } 123456789101112使用 ESLint 命令行检查代码: npx eslint project-dir/ file1.js 1更多关于可用命令行选项的信息,参见命令行文档。 下一步 了解 ESLint 可选配置。 熟悉一下命令行选项。 将 ESLint 集成带到诸如编辑器、构建系统以及其他工具中。 找不到合适的规则?创造属于自己的自定义规则。 通过贡献让 ESLint 变得更棒。 |
今日新闻 |
推荐新闻 |
专题文章 |
CopyRight 2018-2019 实验室设备网 版权所有 |