UDN-企业互联网技术人气社区

板块导航

浏览  : 1036
回复  : 3

[AngularJS] 通过ESLint进行js代码规则检查

[复制链接]
kingykking的头像 楼主
发表于 2017-5-12 17:14:52 | 显示全部楼层 |阅读模式
ESLint规范说明1、工具简介ESLint是一个QA工具,用来避免低级错误和统一代码的风格。ESLint被设计为完全可配置。可以使用内置的规则,也可以自己开发对应的插件规则。内置规则可以被配置的信息主要分为3类:

  • Environments:你的 JavaScript 脚步将要运行在什么环境(如:nodejs,browser,commonjs等)中。
  • Globals:执行代码时脚步需要访问的额外全局变量。
  • Rules:开启某些规则,也可以设置规则的等级

安装方法:
npm  install  eslint  –g
使用方法:
eslint –init
eslintexample.js

重点需要关注规则。在配置文件中可以设置一些规则。规则的错误等级有三种:

1."off"或者 0:关闭规则。

2."warn"或者 1:打开规则,并且作为一个警告(不影响exit code)。

3."error"或者 2:打开规则,并且作为一个错误(exit code将会是1)。

同时可以通过设定具体rule的参数来进行条件控制。

默认不会打开任何规则,所以全部需要手动建立。

2、规则列表         以下为翻译并收集的全部规则列表,选择我们需要的规则,进行等级配置和条件配置。具体文档参照。其中我标志为推荐的,是可以默认进行推荐配置,通过配置eslint:recommended,可以直接使用。其余规则按需要配置。
官方中文文档http://eslint.cn/docs/rules/


"no-alert": 0,//禁止使用alert confirmprompt
"no-array-constructor": 2,//禁止使用数组构造器
"no-bitwise": 0,//禁止使用按位运算符
"no-caller": 1,//禁止使用arguments.callerarguments.callee
"no-catch-shadow": 2,//禁止catch子句参数与外部作用域变量同名
(推荐)"no-case-declarations": 2,// 不允许在 case 子句中使用词法声明
(推荐)"no-class-assign": 2,//禁止给类赋值
(推荐)"no-cond-assign": 2,//禁止在条件表达式中使用赋值语句
(推荐)"no-console": 2,//禁止使用console
(推荐)"no-const-assign": 2,//禁止修改const声明的变量
(推荐)"no-constant-condition": 2,//禁止在条件中使用常量表达式 if(true) if(1)
"no-continue": 0,//禁止使用continue
(推荐)"no-control-regex": 2,//禁止在正则表达式中使用控制字符
(推荐)"no-debugger": 2,//禁止使用debugger
(推荐)"no-delete-var": 2,//不能对var声明的变量使用delete操作符
"no-div-regex": 1,//不能使用看起来像除法的正则表达式/=foo/
(推荐)"no-dupe-keys": 2,//在创建对象字面量时不允许键重复 {a:1,a:1}
(推荐)"no-dupe-args": 2,//函数参数不能重复
(推荐)" no-dupe-class-members": 2,// 禁止类成员中出现重复的名称
"no-duplicate-case": 2,//switch中的case标签不能重复
"no-else-return": 2,//如果if语句里面有return,后面不能跟else语句
(推荐)"no-empty": 2,//块语句中的内容不能为空
(推荐)"no-empty-character-class": 2,//正则表达式中的[]内容不能为空
"no-empty-label": 2,//禁止使用空label
(推荐)"no-empty-pattern": 2,// 禁止使用空解构模式
"no-eq-null": 2,//禁止对null使用==!=运算符
"no-eval": 1,//禁止使用eval
(推荐)"no-ex-assign": 2,//禁止给catch语句中的异常参数赋值
"no-extend-native": 2,//禁止扩展native对象
"no-extra-bind": 2,//禁止不必要的函数绑定
(推荐)"no-extra-boolean-cast": 2,//禁止不必要的bool转换
"no-extra-parens": 2,//禁止非必要的括号
(推荐)"no-extra-semi": 2,//禁止多余的冒号
(推荐)"no-fallthrough": 1,//禁止switch穿透
"no-floating-decimal": 2,//禁止省略浮点数中的0 .5 3.
(推荐)"no-func-assign": 2,//禁止重复的函数声明
"no-implicit-coercion": 1,//禁止隐式转换
"no-implied-eval": 2,//禁止使用隐式eval
"no-inline-comments": 0,//禁止行内备注
(推荐)"no-inner-declarations": [2, "functions"],//禁止在块语句中使用声明(变量或函数)
(推荐)"no-invalid-regexp": 2,//禁止无效的正则表达式
"no-invalid-this": 2,//禁止无效的this,只能用在构造器,类,对象字面量
(推荐)"no-irregular-whitespace": 2,//不能有不规则的空格
"no-iterator": 2,//禁止使用__iterator__ 属性
"no-label-var": 2,//label名不能与var声明的变量名相同
"no-labels": 2,//禁止标签声明
"no-lone-blocks": 2,//禁止不必要的嵌套块
"no-lonely-if": 2,//禁止else语句内只有if语句
"no-loop-func": 1,//禁止在循环中使用函数(如果没有引用外部变量不形成闭包就可以)
"no-mixed-requires": [0, false],//声明时不能混用声明类型
(推荐)"no-mixed-spaces-and-tabs": [2, false],//禁止混用tab和空格
"linebreak-style": [0, "windows"],//换行风格
"no-multi-spaces": 1,//不能用多余的空格
"no-multi-str": 2,//字符串不能用\换行
"no-multiple-empty-lines": [1, {"max": 2}],//空行最多不能超过2
"no-native-reassign": 2,//不能重写native对象
"no-negated-in-lhs": 2,//in 操作符的左边不能有!
"no-nested-ternary": 0,//禁止使用嵌套的三目运算
"no-new": 1,//禁止在使用new构造一个实例后不赋值
"no-new-func": 1,//禁止使用new Function
"no-new-object": 2,//禁止使用new Object()
"no-new-require": 2,//禁止使用new require
"no-new-wrappers": 2,//禁止使用new创建包装实例,new String newBoolean new Number
(推荐)"no-new-symbol": 2,// disallow new operators with the Symbol object
(推荐)"no-obj-calls": 2,//不能调用内置的全局对象,比如Math() JSON()
(推荐)"no-octal": 2,//禁止使用八进制数字
"no-octal-escape": 2,//禁止使用八进制转义序列
"no-param-reassign": 2,//禁止给参数重新赋值
"no-path-concat": 0,//node中不能使用__dirname__filename做路径拼接
"no-plusplus": 0,//禁止使用++--
"no-process-env": 0,//禁止使用process.env
"no-process-exit": 0,//禁止使用process.exit()
"no-proto": 2,//禁止使用__proto__属性
(推荐)"no-redeclare": 2,//禁止重复声明变量
(推荐)"no-regex-spaces": 2,//禁止在正则表达式字面量中使用多个空格 /foo bar/
"no-restricted-modules": 0,//如果禁用了指定模块,使用就会报错
"no-return-assign": 1,//return 语句中不能有赋值表达式
"no-script-url": 0,//禁止使用JavaScript:void(0)
(推荐)"no-self-assign": 2,//禁止自我赋值
"no-self-compare": 2,//不能比较自身
"no-sequences": 0,//禁止使用逗号运算符
"no-shadow": 2,//外部作用域中的变量不能与它所包含的作用域中的变量或参数同名
"no-shadow-restricted-names": 2,//严格模式中规定的限制标识符不能作为声明时的变量名使用
"no-spaced-func": 2,//函数调用时 函数名与()之间不能有空格
(推荐)"no-sparse-arrays": 2,//禁止稀疏数组, [1,,2]
"no-sync": 0,//nodejs 禁止同步方法
"no-ternary": 0,//禁止使用三目运算符
"no-trailing-spaces": 1,//一行结束后面不要有空格
(推荐)"no-this-before-super": 0,//在调用super()之前不能使用thissuper
"no-throw-literal": 2,//禁止抛出字面量错误 throw"error";
(推荐)"no-undef": 1,//不能有未定义的变量
"no-undef-init": 2,//变量初始化时不能直接给它赋值为undefined
"no-undefined": 2,//不能使用undefined
(推荐)"no-unused-labels": 2,// 禁用出现未使用过的标
(推荐)"no-unexpected-multiline": 2,//避免多行表达式
"no-underscore-dangle": 1,//标识符不能以_开头或结尾
"no-unneeded-ternary": 2,//禁止不必要的嵌套 var isYes =answer === 1 ? true : false;
(推荐)"no-unreachable": 2,//不能有无法执行的代码
(推荐)"no-unsafe-finally":2,//禁止在finally语块中出现控制流语句
"no-unused-expressions": 2,//禁止无用的表达式
(推荐)"no-unused-vars": [2, {"vars": "all", "args": "after-used"}],//不能有声明后未被使用的变量或参数
"no-use-before-define": 2,//未定义前不能使用
"no-useless-call": 2,//禁止不必要的callapply
"no-void": 2,//禁用void操作符
"no-var": 0,//禁用var,用letconst代替
"no-warning-comments": [1, { "terms": ["todo", "fixme", "xxx"], "location": "start" }],//不能有警告备注
"no-with": 2,//禁用with
"array-bracket-spacing": [2, "never"],//是否允许非空数组里面有多余的空格
"arrow-parens": 0,//箭头函数用小括号括起来
"arrow-spacing": 0,//=>的前/后括号
"accessor-pairs": 0,//在对象中使用getter/setter
"block-scoped-var": 0,//块语句中使用var
"brace-style": [1, "1tbs"],//大括号风格
"callback-return": 1,//避免多次调用回调什么的
"camelcase": 2,//强制驼峰法命名
"comma-dangle": [2, "never"],//对象字面量项尾不能有逗号
"comma-spacing": 0,//逗号前后的空格
"comma-style": [2, "last"],//逗号风格,换行时在行首还是行尾
"complexity": [0, 11],//循环复杂度
"computed-property-spacing": [0, "never"],//是否允许计算后的键名什么的
"consistent-return": 0,//return 后面是否允许省略
"consistent-this": [2, "that"],//this别名
(推荐)"constructor-super": 0,//非派生类不能调用super,派生类必须调用super
"curly": [2, "all"],//必须使用 if(){} 中的{}
"default-case": 2,//switch语句最后必须有default
"dot-location": 0,//对象访问符的位置,换行的时候在行首还是行尾
"dot-notation": [0, { "allowKeywords": true }],//避免不必要的方括号
"eol-last": 0,//文件以单一的换行符结束
"eqeqeq": 2,//必须使用全等
"func-names": 0,//函数表达式必须有名字
"func-style": [0, "declaration"],//函数风格,规定只能使用函数声明/函数表达式
"generator-star-spacing": 0,//生成器函数*的前后空格
"guard-for-in": 0,//for in循环要用if语句过滤
"handle-callback-err": 0,//nodejs 处理错误
"id-length": 0,//变量名长度
"indent": [2, 4],//缩进风格
"init-declarations": 0,//声明时必须赋初值
"key-spacing": [0, { "beforeColon": false, "afterColon": true }],//对象字面量中冒号的前后空格
"lines-around-comment": 0,//行前/行后备注
"max-depth": [0, 4],//嵌套块深度
"max-len": [0, 80, 4],//字符串最大长度
"max-nested-callbacks": [0, 2],//回调嵌套深度
"max-params": [0, 3],//函数最多只能有3个参数
"max-statements": [0, 10],//函数内最多有几个声明
"new-cap": 2,//函数名首行大写必须使用new方式调用,首行小写必须用不带new方式调用
"new-parens": 2,//new时必须加小括号
"newline-after-var": 2,//变量声明后是否需要空一行
"object-curly-spacing": [0, "never"],//大括号内是否允许不必要的空格
"object-shorthand": 0,//强制对象字面量缩写语法
"one-var": 1,//连续声明
"operator-assignment": [0, "always"],//赋值运算符 += -=什么的
"operator-linebreak": [2, "after"],//换行时运算符在行尾还是行首
"padded-blocks": 0,//块语句内行首行尾是否要空行
"prefer-const": 0,//首选const
"prefer-spread": 0,//首选展开运算
"prefer-reflect": 0,//首选Reflect的方法
"quotes": [1, "single"],//引号类型 `` ""''
"quote-props":[2, "always"],//对象字面量中的属性名是否强制双引号
"radix": 2,//parseInt必须指定第二个参数
"id-match": 0,//命名检测
(推荐)"require-yield": 0,//生成器函数必须有yield
"semi": [2, "always"],//语句强制分号结尾
"semi-spacing": [0, {"before": false, "after": true}],//分号前后空格
"sort-vars": 0,//变量声明时排序
"space-after-keywords": [0, "always"],//关键字后面是否要空一格
"space-before-blocks": [0, "always"],//不以新行开始的块{前面要不要有空格
"space-before-function-paren": [0, "always"],//函数定义时括号前面要不要有空格
"space-in-parens": [0, "never"],//小括号里面要不要有空格
"space-infix-ops": 0,//中缀操作符周围要不要有空格
"space-return-throw-case": 2,//return throwcase后面要不要加空格
"space-unary-ops": [0, { "words": true, "nonwords": false }],//一元运算符的前/后要不要加空格
"spaced-comment": 0,//注释风格要不要有空格什么的
"strict": 2,//使用严格模式
(推荐)"use-isnan": 2,//禁止比较时使用NaN,只能用isNaN()
"valid-jsdoc": 0,//jsdoc规则
(推荐)"valid-typeof": 2,//必须使用合法的typeof的值
"vars-on-top": 2,//var必须放在作用域顶部
"wrap-iife": [2, "inside"],//立即执行函数表达式的小括号风格
"wrap-regex": 0,//正则表达式字面量用小括号包起来
"yoda": [2, "never"]//禁止尤达条件

三、代码示例具体规则可以自己定义,也可以使用别人配置好的。比如airbnb使用的规则
https://www.npmjs.com/package/eslint-config-airbnb
目前我们项目中引入的是推荐规则。
module.exports = {
    "extends": ["eslint:recommended","angular"],
    "rules": {
        // 额外规则
        "indent": ["error", 4],
        "linebreak-style": ["error", "unix"],
        "quotes": ["error", "double"],
        "semi": ["error", "always"],
        //覆盖已有规则
        "comma-dangle": ["error", "always"],
        "no-cond-assign": ["error", "always"],
        // 禁用已有规则
        "no-console": "off",
    }
}

四、代码自动格式化eslint –fix:用该命令可依照ESLint的配置来格式化代码,你怎么定义代码规范的,他就怎么格式化。主要是对一些空格和空白的格式化。
            eslint test.js --fix

能够进行自动格式化的规则,在官方文档中标注为                               ,这里将能够自动格式化的全部总结如下:

no-extra-parens禁止不必要的括号
no-extra-semi禁止不必要的分号
no-regex-spaces禁止正则表达式字面量中出现多个空格

no-unsafe-negation disallow negating the left operand ofrelational operators

curly强制所有控制语句使用一致的括号风格
dot-location强制在点号之前和之后一致的换行
dot-notation强制尽可能地使用点号
no-extra-bind 禁止不必要的 .bind() 调用
no-floating-decimal禁止数字字面量中使用前导和末尾小数点
no-implicit-coercion禁止使用短符号进行类型转换
no-multi-spaces禁止使用多个空格
no-useless-return disallow redundant return statements
wrap-iife要求 IIFE 使用括号括起来
yoda要求或禁止 “Yoda” 条件
strict要求或禁止使用严格模式指令
no-undef-init禁止将变量初始化为 undefined
array-bracket-spacing强制数组方括号中使用一致的空格
block-spacing强制在单行代码块中使用一致的空格
brace-style强制在代码块中使用一致的大括号风格
comma-dangle要求或禁止末尾逗号
comma-spacing强制在逗号前后使用一致的空格
comma-style强制使用一致的逗号风格
computed-property-spacing强制在计算的属性的方括号中使用一致的空格
eol-last要求或禁止文件末尾存在空行

func-call-spacing //require or disallow spacing betweenfunction identifiers and their invocations

indent强制使用一致的缩进

jsx-quotes强制在JSX 属性中一致地使用双引号或单引号

key-spacing强制在对象字面量的属性中键和值之间使用一致的间距
keyword-spacing强制在关键字前后使用一致的空格
linebreak-style强制使用一致的换行风格
lines-around-comment要求在注释周围有空行

lines-around-directive //require or disallow newlinesaround directives

new-parens要求调用无参构造函数时有圆括号
newline-after-var要求或禁止变量声明语句后有一行空行
newline-before-return要求 return 语句之前有一空行

no-lonely-if禁止if 作为唯一的语句出现在 else 语句中

no-multiple-empty-lines禁止出现多行空行
no-trailing-spaces禁用行尾空格
no-whitespace-before-property禁止属性前有空白
object-curly-newline强制大括号内换行符的一致性
object-curly-spacing强制在大括号中使用一致的空格
one-var-declaration-per-line要求或禁止在变量声明周围换行
padded-blocks要求或禁止块内填充
quote-props要求对象字面量属性名称用引号括起来
quotes强制使用一致的反勾号、双引号或单引号
semi-spacing强制分号之前和之后使用一致的空格
semi要求或禁止使用分号而不是 ASI
space-before-blocks强制在块之前使用一致的空格
space-before-function-paren强制在 function的左括号之前使用一致的空格
space-in-parens强制在圆括号内使用一致的空格
space-infix-ops要求操作符周围有空格
space-unary-ops强制在一元操作符前后使用一致的空格
spaced-comment强制在注释中 // /* 使用一致的空格
unicode-bom要求或禁止 Unicode 字节顺序标记 (BOM)
wrap-regex要求正则表达式被括号括起来
arrow-body-style要求箭头函数体使用大括号
arrow-parens要求箭头函数的参数使用圆括号
arrow-spacing强制箭头函数的箭头前后使用一致的空格
generator-star-spacing强制 generator 函数中 * 号周围使用一致的空格

no-useless-computed-key //disallow unnecessary computedproperty keys in object literals

no-useless-rename //disallow renaming import, export, anddestructured assignments to the same name

no-var要求使用let 或 const 而不是 var

object-shorthand要求或禁止对象字面量中方法和属性使用简写语法
prefer-arrow-callback要求使用箭头函数作为回调

prefer-const要求使用const 声明那些声明后不再被修改的变量

prefer-numeric-literals //disallow parseInt() in favor ofbinary, octal, and hexadecimal literals

prefer-spread要求使用扩展运算符而非 .apply()
prefer-template要求使用模板字面量而非字符串连接

rest-spread-spacing //enforce spacing between rest andspread operators and their expressions

template-curly-spacing要求或禁止模板字符串中的嵌入表达式周围空格的使用
yield-star-spacing强制在 yield* 表达式中 * 周围使用空格
五、生成代码规范检测报告可生成各种格式的报告,也可同时生成多种格式的报告.html、markdown等格式。自己比较喜欢的插件,美化命令行输出的插件eslint-friendly-formattereslint-formatter-pretty,支持Markdown格式的插件eslint-formatter-markdown
# just make sure you pass the path tothe module to the format option of eslint
eslint.js --format './node_modules/eslint-friendly-formatter/index.js' index.js test/-c './eslint.json'

具体使用文档参考:
https://npm.taobao.org/package/eslint-friendly-formatter

六、结合Git Hook来实现代码检测不通过则不允许提交https://github.com/brigade/overcommit


                                                                                                                                                              
                                                                                                                                                


发表于 2017-5-25 10:10:29 | 显示全部楼层
占坑编辑ing
使用道具 举报

回复

发表于 2017-5-25 10:10:48 | 显示全部楼层
个人觉得js是一种解释性语言,它提供了一个非常方便的开发过程,不需要编译,js与HTML标识结合在一起,从而方便用户的使用操作。
使用道具 举报

回复

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

关于我们
联系我们
  • 电话:010-86393388
  • 邮件:udn@yonyou.com
  • 地址:北京市海淀区北清路68号
移动客户端下载
关注我们
  • 微信公众号:yonyouudn
  • 扫描右侧二维码关注我们
  • 专注企业互联网的技术社区
版权所有:用友网络科技股份有限公司82041 京ICP备05007539号-11 京公网网备安1101080209224 Powered by Discuz!
快速回复 返回列表 返回顶部