管理代码质量 - lint-staged、eslint、prettier的联合使用

实现目标:从零对项目工程进行配置定制,以保证在git提交时,校验代码是否符合定制的规则及风格

说在前面🤞

代码质量作为前端工程化的一个重要指标,需要前端团队共同管理起来。虽然基于vue-cli等脚手架可以配置出一些现成的工程链,隔离开发者的关注点,但是我们还是需要大致进行一个了解,以便应用于其他项目工程。

2021-04-22:以下流程已被我封装成了一款npm插件,实现自动配置,欢迎体验反馈

Let's beging

eslint

对代码进行质量检测,预防某些用法可能存在的问题,配置项繁多,常规方案是使用被认可的标准指南

  • 安装eslint

npm i eslint -D

  • 初始化配置(如果你使用了ts 请在此之前先安装typescript,否则生成配置文件会抛错)

npx eslint --initnode_modules/.bin/eslint --init(基于环境因素我无法使用npx,故使用后者)

eslint初始化的配置对话

通过对话得到基本配置文件.eslintrc.js,配置详细请参阅文档

prettier

对代码风格进行强制控制,不允许freestyle😂,可配置项少,因为是opinionated,即自主倾向强硬的,相当于喜欢就用,不喜勿喷,hahaha~,相反的unopinionated,如eslint,可配置项就比较多

  • 安装prettier和eslint对应的插件
    npm i prettier eslint-plugin-prettier -D

  • 配置.eslintrc.js

    eslint配置文件的增量修改

    至此我们已经完成了eslint和prettier的部分集成,此时如果运行eslint进行检测,会先用prettier进行代码风格修订,然后对修订后的代码进行eslint的规则检测,此时会产生出两者规则不同之处的错误并且无法自动修正,需要继续做处理

  • 安装eslint-config-prettier
    npm i eslint-config-prettier -D

  • 配置.eslintrc.js

    eslint配置文件的第二次增量修改

    对于standardprettier的extends还可以继续合并
    合并standard和prettier

lint-staged

实际使用中每次都对整个项目进行lint是不可取的,所以我们要结合lint-staged使用。顾名思义,只对staged的文件进行lint,网上大部分方案都是利用husky和lint-staged结合进行使用,但是我们利用yorkie进行更简单的配置👌

  • 安装yorkie和lint-staged
    npm i yorkie lint-staged -D
    安装好后就会自动打开git hooks,我们只需要对package.json进行简单配置
    package.json的增量修改

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

推荐阅读更多精彩内容