使用eslint来规范你的项目源码

在vscode上开发个人项目的时候,代码风格随你定,弄出花也没人说,可是一旦是团队项目,那就得注意代码风格了。举个常见例子来说,A修改了代码,并格式化成2个缩进,B也同时同一份代码,但格式化成4个缩进,这时候代码提交的时候就会存在冲突,需要花费大量的时间在格式上。


那么解决方案有三步

  1. 使用Settings Sync拓展同步用户设置
  2. 使用eslint统一代码风格
  3. 使用git预检查工具在提交前检验

使用Settings Sync拓展

在之间的文章说过

不可否者vscode是一款好用的IDE,可是仍存在着一些小缺陷,为了方便在不同设备上使用统一的用户配置(团队协作时特别有用,确保代码风格统一),这里推荐一款vscode 插件 Settings Sync。

在项目开始的时候,我们要求团队成功的用户配置是一样的,这样可以确保代码风格一致。相关教程请移步 使用Settings Sync同步你的vscode配置

使用Eslint

使用脚手架创建vue项目的时候会提示是否使用eslint,如果选用了而代码风格不符合规范,将在控制台中输出警告,此时代码仍然可以运行。

如果不是没有选用eslint或者不是vue项目,我们可以在ide中按照eslint拓展来帮助我们定位错误代码。

搜索并按照ESLint拓展

其他非vscode用户也可以安装相关的ide拓展
安装完成后将直接在代码上显示提示信息。

eslint有两个重要的配置文件,需要在项目根目录创建

1   .eslintignore
2   .eslintrc.js

.eslintignore eslint需要过滤检查的资源
.eslintrc.js eslint 检查规则
下面是简单的配置

# .eslintignore
node_modules/ # 忽略node_modules文件夹
/dist/        # 忽略检查dist文件夹
// .eslintrc.js
module.exports = {
  root: true,
  parserOptions: {
    parser: 'babel-eslint'
  },
  env: {
    browser: true,
  },
  extends: [
    // https://github.com/vuejs/eslint-plugin-vue#priority-a-essential-error-prevention
    // consider switching to `plugin:vue/strongly-recommended` or `plugin:vue/recommended` for stricter rules.
    'plugin:vue/essential', 
    // https://github.com/standard/standard/blob/master/docs/RULES-en.md
    'standard'
  ],
  // required to lint *.vue files
  plugins: [
    'vue'
  ],
  // add your custom rules here
  rules: {
    // allow async-await
    'generator-star-spacing': 'off',
    // allow debugger during development
    'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off'
  }
}

其中我们需要注意的是.eslintrc.js文件下的rules配置,比如希望关闭eslint的console检测,我们再rules中添加一条规则

'no-console': 0

具体规则可以看官网或提示,配置属性为0off可以关闭指定检查。

当然,处理代码检查,eslint还支持代码修复,简单的代码风格eslint可以直接修复,比如我们希望eslint修复src文件夹下的js文件,那么在package.json中添加一条自定义命令

# 安装eslint模块
$ npm install eslint --save-dev
# 添加eslint修复命令
"lint-fix": "eslint --fix --ext .js src/"

执行 npm run lint-fix 将自动修复。无法修复的将在控制台给出提示。

使用git预检查工具

原则上每次git commit前我们都需要先执行一下 lint-fix命令的,避免遗忘或者偷懒,我们使用预检查工具进行处理。
husky 是一个npm模块,可以在git提交前做拦截,如果拦截返回异常信息,将取消提交。

安装husky

$ npm install husky --save-dev

添加拦截事件precommit

# package.json
"precommit": "npm run lint-fix"

在提交前自动执行eslint修复命令,如果成功全部修复就可以正常提交,如果没有全部修复,将取消提交,避免无法团队代码。

愉快的提交代码

这样就确保了开发者本地的代码格式化是统一的,而且提交到线上的代码也是严格要求的。

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