Prettier 和 ESLint

ESLint

ESLint 是一个 JavaScript 代码检查工具,根据给定的规则,它包括两方面作用:

  1. 对代码的排版风格进行 formatter,比如行尾逗号、对象跨行展示、字符串单双引号等
  2. 对不符合编程规范的「低质量」代码给出提示或进行修复,比如是否用了不严格等于、是否用 var、是否有声明但未被使用的变量等

Prettier

见名知义,prettier 是 pretty 的比较式,所以 Prettier 是一个 formatter,它所做的事也就是上面 ESLint 的作用 1,当然,formatter 的对象不仅仅只有 JavaScript,包括前端相关的各种格式(TypeScript、Vue、JSX、Angular、HTML、CSS、SCSS、Markdown 等)的文件。到此,人们自然会想,既然在 JavaScript 上相较于 Prettier,ESLint 的功能只多不少,那 Prettier 存在的意义是什么?诚然,ESLint 提供了丰富的配置以支持 format 出各种不同排版风格的代码,但是多的选择也就意味着排版风格的多样性,这在调和上也造成更多困难,而且即便是对同一单个规则,最后符合这个规则的排版格式也可能有多种,而这些多样性在一个以保证代码可维护性至上的多人团队中存在的必要性是否定的。Prettier 就是致力于减少那些 ESLint 无法减少的多样性的一个存在。

Prettier is an opinionated code formatter

上面是 Prettier 介绍 Prettier 为何物时的第一句话。opinionated 是灵魂,正是靠着 opinionated,多样性才会减少,一个团队里所有的代码风格的 consistentancy 才得以保证。opinionated 的体现在于,Prettier 只提供了远少于 ESLint 在 formatter 方面提供的十来个规则,这样一来在排版风格上可供讨论的内容大大减少。就好像两个人为一件微不足道的事争执不休,这时来了一个权威的人制止了他们,并让他们无条件的达成了统一,至于是什么样的统一并不重要,重要的是,统一就行了。

如何 integrate Prettier 和 ESLint

在知晓 Prettier 的作用后,我们打算专门让 Prettier 做 formatter 的事,ESLint 只做保证编程规范的事。那么需要将 ESLint 与 formatter 相关的规则全部 disabled 掉(因为可能会与 prettier 相关的 rule 冲突),然后依次执行 prettier --writeeslint --fix 或者将 prettier 的 rules 扩展到 eslint 的 rules 中,这样只需执行 eslint --fix

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