npm 包 eslint-config-fullcube 使用教程

什么是 eslint-config-fullcube

eslint-config-fullcube 是一款基于 eslint 的前端代码规范核对工具。这款工具可以对代码进行语法检查，确保代码风格的一致性。同时，它还可以通过配置文件灵活适配多种编码标准，并且支持自定义规则。

如何安装 eslint-config-fullcube

使用 npm 安装 eslint-config-fullcube：

npm install eslint-config-fullcube --save-dev

这样就可以将我们需要的 eslint-config-fullcube 安装到本地开发环境的依赖。

如何使用 eslint-config-fullcube

1. 在项目目录下新建 .eslintrc 文件:

touch .eslintrc

1. 在 .eslintrc 文件中添加以下代码：

{
   "extends": "fullcube"
}

这样就可以使用全局配置的 eslint-config-fullcube 了。

如何配置 eslint-config-fullcube

如果需要自定义一些特殊的代码规范，可以在 .eslintrc 中添加自己的配置：

{
  "extends": "fullcube",
  "rules": {
      "semi": ["error", "never"],
      "quotes": ["error", "single"]
  },
  "plugins": ["react"]
}

这样在项目中我们可以通过类似以下的配置来实现自定义规范：

  "semi": ["error", "never"]

以上配置意味着不允许代码中存在分号 ;。

ESLint 基础常用规则

• "no-console": "off", 允许使用 console
• "no-debugger": "off", 允许使用 debugger
• "no-alert": "error", 不允许使用 alert
• "no-unreachable": "error", 不允许有无效的 return，throw，break 或 continue 语句等
• "no-dupe-keys": "error", 不允许在对象字面量中重复的键
• "no-duplicate-case": "error", 不允许在 switch 语句中有重复的 case 标签
• "no-empty": "error", 禁止出现空语句块
• "no-multi-spaces": "error", 不允许出现多余的空格
• "no-useless-concat": "error", 禁止不必要的字符串字面量或模板字面量的连接
• "no-var": "error", 使用 let 或者 const 而不是 var
• "prefer-const": "error", 如果一个变量不会被重新赋值，使用 const 声明

总结

eslint-config-fullcube 可以帮助我们规范代码风格并且降低代码出错的概率。使用该工具需要熟悉其基本的配置规则以及对于项目的特殊需求进行适当的自定义设置。同时我们也要了解一些 JavaScript 基本的代码规范标准。

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