1. 前言
ESLint 是目前最受欢迎的 JavaScript 代码规范检查工具之一，它能够帮助我们在编写代码时遵循一定的规范。但是，在 ESLint 的配置上，很多开发者可能会遇到困难。在这篇文章中，我们将会介绍 npm 包 @gooddata/eslint-config，它是由 GoodData 公司推出的一个 ESLint 配置规范，旨在让开发者更加容易地配置和使用 ESLint。
2. 安装和使用
2.1 安装
要安装 @gooddata/eslint-config，首先您需要在项目中安装 ESLint：
npm install eslint --save-dev
安装完成后，我们再通过 npm 安装 @gooddata/eslint-config：
npm install @gooddata/eslint-config --save-dev
2.2 配置
安装完 @gooddata/eslint-config 后，我们需要在项目根目录下创建一个名为 .eslintrc.json 的配置文件。我们可以在这个文件中进行 ESLint 的配置。
{
"extends": ["@gooddata"]
}以上个配置举例，它可以继承 @gooddata/eslint-config 的规则。
2.3 使用
在安装和配置好之后，您就可以在项目中使用 ESLint 了。可以运行以下命令进行代码检查：
npx eslint yourfile.js
这是一种简单的方式。如果您想要更加便捷地进行代码检查，您还可以在 package.json 中的 scripts 中添加一个 npm 脚本：
"scripts": {
"lint": "eslint ."
}这样，在运行 npm run lint 命令后，就可以进行代码检查了。
3. 示例
以下是一个使用 @gooddata/eslint-config 的示例：
-- -------------------- ---- ------- -- ----------- ---- -------- -------- ------ -- - ------ - - -- - ----- ------ - ------ --- --------------------
当运行 npx eslint yourfile.js 命令时，@gooddata/eslint-config 会检查这段代码并给出一些警告：
yourfile.js 3:1 warning Unexpected "use strict" statement strict 5:1 warning Missing space before function parentheses space-before-function-paren 10:1 warning Missing trailing comma at the end of multiline function comma-dangle 10:2 warning Expected indentation of 2 spaces but found 1 indent 11:1 warning Expected newline after 'return' statement newline-return
这是因为 @gooddata/eslint-config 默认开启了一些规则，它们有助于使代码更具可读性、更加容易被理解。你可以通过编辑 .eslintrc.json 中的 rules 选项来禁用或调整默认规则。
4. 总结
@gooddata/eslint-config 是一个适用于 ESLint 的配置规范，它可以帮助开发者更加容易地配置和使用 ESLint，还能够提高代码的质量和可读性。在您的下一个项目中尝试一下它吧，看看它是否能帮助您更好地编写代码！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/they-eslint-config