eslint — js书写规范

转载自:https://www.cnblogs.com/my93/p/5681879.html

一、安装
npm install -g eslint 安装eslint
编辑器安装插件eslint(具体安装方法根据不同编辑器而不同)

二、使用
使用方法一:
eslint --init npm中用命令新建eslintrc.js文件
eslint yourfile.js npm中用命令检查自己文件中的错误

使用方法二:
手动在项目的根目录下新建eslintrc.*文件(.js、.json、.yaml、.yml等),进行配置(具体配置规则详见下文),即可在安装好eslint的编辑器中查看到出现错误的位置。

三、配置:http://eslint.org/docs/rules/ (以下规则文件配置一个即可,置于项目根目录下)
(1).eslintrc文件中进行配置 http://eslint.org/docs/user-guide/configuring

四、其他
1.在样式之前标注“/* eslint-disable /”,可忽略配置的规则;标注“/ esint-enable /“,开启配置的规则
2.“/
eslint-enable /“必须在“/ eslint-disable */”之后使用
3.忽略指定的内容:新建一个.eslineignore文件,例如:

/node_modules/* and /bower_components/* ignored by default

Ignore built files except build/index.js

build/*
!build/index.js
通过命令 eslint --ignore-path .eslintignore file.js可检测是否被忽视
4.enlint 有很多的rules,为了改变rule的设置,可以设置rule ID等同于一些规则属性:如
"off" or 0 关闭规则
"warn" or 1 打开规则,出现警告提示
"error" or 2 打开规则,出现错误提示
规则可如下定义:

五、配置文件

六、配置文件说明

| 属性名 | 属性值 | 描述 |
| array-callback-return | "error" | Array执行回调函数返回语句 |
| indent | ["error", 4, {"SwitchCase": 1}] | 缩写格式的一致性 |
| block-spacing | "error" | 禁止执行空间内出现'-' |
| brace-style | ["error","1tbs"] | 代码书写格式验证 |
| camelcase | ["error", { "properties": "never" }] | 属性命名规则可以不使用驼峰命名法 |
| callback-return | ["error", ["cb", "callback", "next"]] | 回调函数需要return进行返回 |
| comma-spacing | "error" | 不允许在逗号前面出现空格 |
| comma-style | ["error", "last"] | 方数组元素、变量声明等直接需要逗号隔开 |
| consistent-return | "error" | 保持return返回的一致性 |
| curly | ["error", "all"] | 函数或者条件判断时需要统一使用大括号 |
| default-case | "error" | switch语句中必须有default条件 |
| dot-notation | ["error", { "allowKeywords": false }] | 不允许关键字出现在变量中 |
| eol-last | "error" | 代码间间隔出现一行 |
| eqeqeq | "error" | 消除不安全类型的全等操作 |
| guard-for-in | "error" | for循环中过滤掉一下不被需要的行为 |
| key-spacing | ["error", { "beforeColon": false, "afterColon": true }] | 键和值前保留一个空格 |
| keyword-spacing | "error" | 确保字符前后空格的一致性 |
| lines-around-comment | ["error", {
"beforeBlockComment": true,
"afterBlockComment": false,
"beforeLineComment": true,
"afterLineComment": false
}] | 注释前需要空行,注释后不需要空行 |
| new-cap | "error" | 构造函数首字母需要大写 |
| newline-after-var | ["error", "never"] | var定义后不空行 |
| new-parens | "error" | 没有参数时,构造函数也需要添加括号 |
| no-invalid-this | "error" | 不允许关键字this在函数或者类的外面 |
| no-multi-spaces | "error" | 不允许键和值之间存在多个空格 |
| no-redeclare | "error" | 不允许重复声明 |
| no-return-assign | "error" | 不允许在return语句中任务 |
| no-spaced-func | "error" | 调用函数时,函数名和括号之间不能有空格。 |
| no-trailing-spaces | "error" | 不允许在语句后存在多余的空格 |
| semi | "error" | 语句以分号结尾 |
| semi-spacing | "error" |
分号前后不能有空格 |
| quotes | ["error","double"] | 使用双引号 |
| [space-before-function-paren](http://eslint.org/docs/rules/space-before-function-paren) | "space-before-function-paren": ["error", "never"] | 不允许函数括号之间存在空格 |
| space-in-parens | "error" | 不允许在括号里面存在空格 |
| space-infix-ops | "error" | 插入符合变量之间需要添加一个空格 |
| space-unary-ops | ["error", {"words": true, "nonwords": false}] | 允许一元运算符操作 |
| spaced-comment | "error" | 注释前需要一个空格 |
| yoda | ["error", "never"] | 条件语句中,变量在赋值语句的前面 |
| no-mixed-requires | "error" | 不允许混合requires文件 |
| no-new-require | "error" | 不允许new require出现 |
| no-path-concat | "error" | 不允许路径以_链接 |
| handle-callback-err | ["error", "err"] | 处理错误的回调函数 |

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,386评论 6 479
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,939评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,851评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,953评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,971评论 5 369
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,784评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,126评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,765评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,148评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,744评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,858评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,479评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,080评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,053评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,278评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,245评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,590评论 2 343

推荐阅读更多精彩内容