使用eslint和editorconfig规范代码

  • 规范代码有利于团队协作
  • 手工规范费时费力,准确性不令人满意
  • 可以配合编辑器自动提醒,提高开发效率

1.eslint[lint:检测]

1.1 随着ECMAScript版本一直更新的Js lint工具,插件丰富,并且能够套用规范,规则丰富,能够满足大部分团队需求。
1.2 eslint可以配合git,可以再git commit代码时,使用git hook调用eslint进行代码规范验证,不规范的代码无法提交到仓库。

2.editorconfig

2.1 不同编辑器队文本的格式会有一定的区别,如果不统一一些规范,可能跟别人合作的时候每次更新下来别人的代码会出现一大堆报错。

3.配置

$npm i eslint -D
//在项目根目录下创建文件.eslintrc用于规范输出文件
{
  "extends":"standard"    //需要安装
}
//在client目录下创建.eslintrc--用于规范jsx
{
  "parser":"babel-eslint",  //需要安装,指定babel-eslint去解析js代码,代替eslint默认的解析器
  "env":{
    "browser":true,          //声明执行在浏览器环境,防止报错没有dom变量
    "es6":true,              //声明es6代码
    "node":true              //声明node,防止报错没有node变量
  },
  "parserOptions":{
    "ecmaVersion":6,          //定义ecma版本
    "sourceType":"module"      //声明写代码方式为模块化
  },
  "extends":"airbnb",    //需要安装,美国一个踩过非常多react坑的公司总结出来的
  "rules":{                    //自定义规则
    "semi":[0]                //问号(semi)不去检查([0])
  }
}
//webpack.config.client.js下添加rules
{
  enforce:"pre",        //在其他的loader之前进行此loader,如果出错则不进行下面的loader
  test:/.(js|jsx)$/,
  loader:"eslint-loader",
  exclude:[
    path.resolve(__dirname,"../node_modules") //Node_modules排除
  ]
}
//安装依赖包[airbnb包安装时会提醒包缺失]
$npm i babel-eslint \
\ eslint-config-airbnb eslint-config-standard \
\ eslint-loader \
\ eslint-plugin-import \
\ eslint-plugin-react \
\ eslint-plugin-promise \
\ eslint-plugin-jsx-a11y \
\ eslint-plugin-node \
\ eslint-plugin-standard -D \

//安装并且配置好后
npm run dev:client
//如果有不符合规范的,会在控制台打印ERROR,以及文件,行数
//eslint行注释:行末添加 【//eslint-disable-line】,之后eslint对该行代码不进行检测 
//eslint提示会有很多优化方面的提示
  • 3.2 安装editorconfig
//根目录下新建.editorconfig
root = true
[*]
charset=utf-8
indent_style=space
indent_size=2
end_of_line=lf
insert_final_newline=true
trim_trailing_whitespace=true

//webstorm本身已经集成editorconfig
  • 3.3 git时使用eslint检测
$git init       //本地项目git仓库化,需要安装git
$npm i husky -D  
//package.json添加script
"lint":"eslint --ext .js --ext .jsx client/",
"precommit":"npm run lint"

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

推荐阅读更多精彩内容