(开发)ESLint - 代码规范

时间:2022-03-25 08:25:42

参考文档:http://eslint.cn/

ESLint 是在 ECMAScript/JavaScript 代码中识别和报告模式匹配的工具,它的目标是保证代码的一致性和避免错误。在许多方面,它和 JSLint、JSHint 相似,除了少数的例外:

  • ESLint 使用 Espree 解析 JavaScript。
  • ESLint 使用 AST 去分析代码中的模式
  • ESLint 是完全插件化的。每一个规则都是一个插件并且你可以在运行时添加更多的规则。

  以上来自官网。不想再说下去,反正就是一个代码风格检测工具就对了

如何使用

  1. 安装

    npm install -g eslint
    
  2. 如果你第一次使用 ESLint,你必须使用 –init 命令新建一个配置文件:

    eslint --init
    
  3. 使用 ESLint 检测任何 JavaScript 文件:

    eslint test.js test2.js
    
  4. ESLint 中一些规则运行命令它可以帮你自动修复

    eslint test.js --fix
    

  5.  忽略 某条 (no-new )规程 :

     加上注释:  /* eslint-disable no-new */

  

  6.  忽略所有规程 :

     加上注释:  /* eslint-disable */

Sublime 安装:

   http://www.tuicool.com/articles/faANRvj

  安装之后的效果:

  (开发)ESLint - 代码规范

  误用了 = ,在文件保存时就会被提示,直接顺手改掉就行了,方便的不行

  

  • 步骤2:安装ESLint: npm i -g eslint

  

  • 步骤3::配置eslint,最好把 官方教程 看看,配置出适合自己编程习惯的配置文件再好不过了,我的配置文件内容如下:

    文件: .eslintrc.json

    内容:

{
"env": {
"browser": true,
"es6": true,
"node": true
},
"parserOptions": {
"sourceType": "module"
},
"rules": {
"no-cond-assign": [2, "always"], //if, while等条件中不允许使用“=”
"no-constant-condition": 2,
"no-debugger": 2, // 程序中不能出现debugger
"no-dupe-args": 2, // 函数的参数名称不能重复
"no-dupe-keys": 2, // 对象的属性名称不能重复
"no-duplicate-case": 2, // switch的case不能重复
"no-func-assign": 2,
"no-obj-calls": 2,
"no-regex-spaces": 2,
"no-sparse-arrays": 2,
"no-unexpected-multiline": 2,
"no-unreachable": 2,
"use-isnan": 2,
"valid-typeof": 2,
"eqeqeq": [2, "always"],
"no-caller": 2,
"no-eval": 2,
"no-redeclare": 2,
"no-undef": 2,
"no-unused-vars": 1,
"no-use-before-define": 2,
"comma-dangle": [1, "never"],
"no-const-assign": 2,
"no-dupe-class-members": 2
}
}

  • 最后,把配置好的文件放在你项目的根目录中就可以了,项目中所有的子文件也会自动使用该配置文件。