关于统一代码风格-ESLint的简单总结

1.eslint是干嘛的,咱在此就不多说了,能搜到这边文章,证明已经对它有所了解了。
代码风格统一,记得13年在三星的时候就开始了,当时是用的jshint还是啥的,不记得了,反正都是棒子定的规则,按照这个规则来就行了;在现公司,由一个小鲜肉研究了下,根据leader的意愿搞了一套规则,主要有以下的检测
<b>1.空格</b>:函数定义时,函数名与花括号,关键字的空格等
<b>2.分号</b>:在我们的项目中不使用分号
<b>3.tab与空格</b>:在我们项目中不能有tab,并且以两个空格来缩进代码
主要是这些,当然还有一些,一时想不起来了


虽然用了很久了,但是感觉这些都是约定俗成的东西,定义了基本上就不会改了,也是因为最近项目不太紧,所以花一点时间来总结一下吧,以下就结合官网和项目,来谈谈怎么一步步在项目中加入eslint吧

<b>1.安装</b>:推荐本地安装而不要全局安装

npm i eslint --save-dev

<b>2.初始化</b>:根据提示一步步初始化,会让用户选择是否使用es6语法,是否使用react,jsx等 ,反正一步步选择,最后会生成一个<b>.eslintrc.js</b>文件,一看傻眼了,200多个规则,根据自己的需要该删的删,初始化时有一个坑:

Automatic Configuration failed.  No files were able to be parsed

添加一个js文件之后成功了


ok,接下来我们试着跑一下以下的代码

console.log('hello eslint')
alert('11')
debugger

看看报错

image.png

咦,这上生产环境了,console,alert,debugger是绝对不允许的,eslint一下,没后顾之忧了


示例就不再跑了,毕竟200条规则,要每条都满足,还是需要一定的功力的,在此,列举一些常用的吧

"no-console": "error", // 禁止console
"no-alert": "error", // 禁止alert,conirm等
"no-debugger": "error", // 禁止debugger
"semi": ["error", "never"], // 禁止分号
"no-tabs": "error", // 禁止使用tab
"no-unreachable": "error", // 当有不能执行到的代码时
"eol-last": "error", // 文件末尾强制换行
"no-new": "error", // 禁止在使用new构造一个实例后不赋值
"quotes": ["error", "backtick"], // 引号类型 `` "" ''
"no-unused-vars": ["error", { "vars": "all", "args": "after-used" }], // 不能有声明后未被使用的变量
"no-trailing-spaces": "error", // 一行结束后面不要有空格
"space-before-function-paren": ["error", "never"], // 函数定义时括号前面要不要有空格
"no-undef": "error", // 不能有未定义的变量,定义之前必须有var或者let
"curly": ["error", "all"], // 必须使用 if(){} 中的{}
'arrow-parens': "error", // 箭头函数的参数要有()包裹
'generator-star-spacing': "error", // allow async-await
"space-before-function-paren": ["error", "never"], // 禁止函数名前有空格,如function Test (aaa,bbb)
"space-in-parens": ["error", "never"], // 禁止圆括号有空格,如Test( 2, 3 )
"space-infix-ops": "error", //在操作符旁边必须有空格, 如 a + b而不是a+b
"space-before-blocks": ["error", "always"], // 语句块之前必须有空格 如 ) {}
"spaced-comment":["error", "always"], // 注释前必须有空格
"arrow-body-style": ["error", "always"], // 要求箭头函数必须有大括号 如 a => {}
"arrow-parens": ["error", "always"], //要求箭头函数的参数必有用括弧包住,如(a) =>{}
"arrow-spacing": ["error", { "before": true, "after": true }], // 定义箭头函数的箭头前后都必须有空格
"no-const-assign": "error",  // 禁止修改const变量
"template-curly-spacing": ["error", "never"], // 禁止末班字符串中的{}中的变量出现空格,如以下错误`${ a }`
"no-multi-spaces": "error", // 禁止多个空格,只有一个空格的地方必须只有一个
"no-whitespace-before-property": "error", // 禁止属性前有空格,如obj. a
"keyword-spacing":["error",{"before": true, "after": true}] //关键字前后必须有空格 如 } else {

本文demo代码,如果有任何疑问,强烈推荐去官网,绝对能满足需求

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

推荐阅读更多精彩内容