梳理前端开发使用eslint和prettier来检查与格式化代码问题

梳理前端开发使用eslint和prettier来检查以及格式化代码问题

2018/06/11 · JavaScript
· 格式化

原文出处:
Edwin   

一样、问题痛点

  • 以组织的档次开进程中,代码维护所占的光阴比重往往超出新成效的开发。因此编写符合组织编码规范的代码是重点的,这样做不仅可以老十分程度地避免基本语法错误,也保证了代码的可读性。
  • 于代码版本管理网(svn 和
    git或者其他),代码格式不同等带来的题目是惨重的,在代码一致的景下,因为格式不同,触发了本子管理体系标记为
    diff,导致力不从心检查代码和校验。

然而用理解之是,开发规范不仅仅包含代码格式规范,还有不少内容,这里只是独自说明代码格式化规范而已。

(一)关于代码格式规范问题

代码格式规范的正规可以参考各大主流公司暨社区,以下且是局部常用主流规范:

  • 前端开发规范的命名规范、html规范、css规范、js规范 – 腾讯Web前端
    IMWeb 团队社区 | blog |
    团队博客 腾讯的
  • 编制「可读」代码的履行 | Taobao FED |
    淘宝前端团队
    淘宝的
  • GitHub – airbnb/javascript: JavaScript Style
    Guide airbnb 的
  • https://google.github.io/styleguide/jsguide.html google 的
  • https://github.com/pablohpsilva/vuejs-component-style-guide/blob/master/README-CN.md
    vue 的

参照别人的业内,制定适合自己团队采用的正式,太过复杂的正经履起来最为难为,太过简短的正统不如没有正儿八经。

没断然的标准,只有切合之专业!

(二)关于为什么要因此 eslint 和 prettier问题

  • prettier 主要是为了格式化代码,而以无 prettier 之前,是因此
    eslint —fix暨 编辑器自带代码格式来开展代码格式化的。

    • 症结:每种编辑器会生不等同的代码格式,而且配置会比较累。
    • prettier 已经逐步变为业界主流的代码风格格式化工具。
    • 减轻 eslint 等工具的校验规则,因为将代码样式校验交给了
      prettier,所以可以以代码校验的平整更规范地采用至代码真正的正统者。
  • eslint 是非同小可还是承受代码规则校验,prettier
    只调整代码风格,代码样式,eslint
    才是的确反省代码是否符合规范的家伙。

之所以两者是亟需般配使用的。

其次、解决办法

原始片解决办法是:

  • 采取 editorconfig 协助配合开发工具的代码格式化。
  • 应用 eslint 检查代码
  • 使用 eslint —fix来修复不切合 eslint
    规则的代码,它见面活动根据设置的条条框框来转代码(它见面包含代码样式的平整,但是
    eslint 的体制规则并无顶准确)。
  • 手动修改剩下的产生题目之地方,或者小地方特别不便用规则来判断的早晚,就得手动修改。

乍的解决办法是:

  • 应用 editorconfig 协助配合开发工具的代码格式化。
  • 利用 eslint 检查代码。
  • 采用 prettier 格式化代码。(可以知道为prettier是 eslint —fix
    的增长版,用 prettier 来代替 eslint-fix
  • 手动修改剩下的起题目的地方,或者小地方深为难用规则来判断的当儿,就待手动修改。

咬一看,其实没啥区别,甚至可能发现新解决办法会进一步辛苦了有的,其实步骤及的确如此,但是真正操作上,会减轻
eslint
的条条框框编写,也会缩减过多手动修改样式的地方,格式化后底代码会愈发美妙,耐看。

老三、具体操作

由网上文章证实的于散乱,这里要是为了梳理整个工艺流程以及笔触。

大纲

  1. 联团队利用的开发工具(webstorm,ide 编辑器)
  2. 安装 eslint 和 prettier (node 模块)
  3. 安 eslint 和 prettier ( ide 编辑器的插件)
  4. 配置 eslint 和 prettier
  5. 配置 editorconfig (可选)
  6. 严加监控,按照流程检查和格式化代码,按照规范与要求进行代码提交。

此间多矣同一步是安装 eslint 和 prettier ( ide
编辑器的插件),主要就采取 ide
编辑器做代码格式错误提示和代码格式处理,这个操作为足以以 webpack
打包的上来举行,也得使 gulp 或者 npm
来开,但此处指编辑器会再次有益于。

(一)统一团队采用的开发工具(webstorm,ide 编辑器)

开发工具可以开过多东西,是支付代码的利器,但是不同的开发工具会生出异之代码提示,代码格式化,代码检查的体制,这样的差异化会对组织代码规范(开发以及自我批评)带来许多问题,所以需要统一。

本来,如果个人不乐意更换好用惯的开发工具的讲话,也未曾提到,只要会形成和团的出规范保持一致也是可的,但个体认为,这样难度比异常,毕竟开发工具和团体的支出规范非那么好融合。

此只有说明前端业界目前极其常用的开发工具来开例子 webstorm 。

(二)安装 eslint 和 prettier (node 模块)

安装此模块的意义在,实际上,整个流程最中心就是这地方,开发工具虽然支持了当下2只模块,但是最后运行是必使盖即时2单模块安装好才会使用的。

JavaScript

// 这里要全局安装最为要紧的星星点点只node 模块,主要是如给 ide
编辑器能够读取全局环境来调用这2单模块 npm install eslint prettier -g
–save-dev // 这个是为 eslint 跟 prettier 可以共利用 npm install
–save-dev eslint-plugin-prettier // 这个是为给 eslint 跟 prettier
兼容,关闭 prettier 跟 eslint 冲突的rules npm install –save-dev
eslint-config-prettier

1
2
3
4
5
6
7
// 这里需要全局安装最主要的两个node 模块,主要是要让 ide 编辑器能够读取全局环境来调用这2个模块
npm install eslint prettier -g –save-dev
 
// 这个是为了 eslint 跟 prettier 可以联合使用
npm install –save-dev eslint-plugin-prettier
// 这个是为了让 eslint 跟 prettier 兼容,关闭 prettier 跟 eslint 冲突的rules
npm install –save-dev eslint-config-prettier

补偿备注:

  • eslint-config-prettier :
    • 夫插件是设eslint的条条框框和prettier的规则发生冲突的当儿(主要是未必要之冲),例如eslint
      限制了必须单引号,prettier也克了要单引号,那么要用 eslint
      驱动 prettier
      来开代码检查来说,就会提示2种植报错,虽然他们还针对同一种代码错误,这个时节就会出于是插件来关闭掉额外之报错。
    • 但若是eslint 只担负检测代码,prettier
      只担负格式化代码,那么她们中互不干扰,也就是说,也是足以免装此插件的,但是坐团队的食指的差异性(即使跟一个开发工具也有本差异,也来利用
      prettier 和 eslint
      的反差),可能有存在各种状态,所以最好还是安装及之插件。
    • 合法发详尽介绍:GitHub – prettier/eslint-config-prettier: Turns
      off all rules that are unnecessary or might conflict with
      Prettier.

模块参考消息:Integrating with ESLint ·
Prettier

以下顺便说一下另我们经常因此到之eslint 模块:

JavaScript

npm -g install babel-eslint eslint-plugin-html –save-dev

1
npm -g install babel-eslint eslint-plugin-html –save-dev
  • babel-eslint :
    • 稍加代码是从未给 eslint 支持的(因为 babel
      也是肩负这种业务,转译不给支持的 js
      语法),所以用添加是插件来保障兼容性。
    • 合法发详尽介绍:https://github.com/babel/babel-eslint
  • eslint-plugin-html:
    • 以为eslint 可以检查.vue文件的代码。

(三)安装webstorm 的eslint 插件与 prettier 插件并启用插件

重复多安排方式参考:WebStorm Setup ·
Prettier

据悉官方介绍webstorm 分别发出2种植处理:

  1. WebStorm 2018.1 和上述之本子
  2. WebStorm 2017.3 和更早的本

倘若用IntelliJ IDEA, PhpStorm, PyCharm, and other JetBrains IDEs,
则需要装prettier插件和 eslint 插件,而webstorm
的话默认会帮你安装及,这为是引进 webstorm 的因由。

1. WebStorm 2018.1 和上述之本子

官方默认已经合龙了 prettier 支持,只需要配置好一个大局的 prettier
模块调用方式就得利用了(必须安排)。图片 1

图片 2

快捷键是:Alt-Shift-Cmd-P on macOS or Alt-Shift-Ctrl-P on Windows and Linux

氪金王的补益,升级快,支持快,免破解,省心省力不省钱!

2. WebStorm 2017.3 和再次早的版本

这个本子有2种情况:

  • ①是eslint 模式,使用 eslint-plugin-prettier 插件和启用eslint
    插件配合,这里相当给以 eslint 模块来教 prettier
    模块,然后中间驱动则是借助eslint-plugin-prettier

先是启用 eslint,并且配备 eslint 模块位置,默认会自动读取当前目录的
eslint.rc 配置文件,然后要进行 npm
安装eslint-plugin-prettier这插件,后面还统一验证。

图片 3
图片 4

  • ②凡是直接运用 prettier 作为额外工具来行使。
    图片 5图片 6图片 7
    图片 8面两栽方式的默认快捷键都是Cmd/Ctrl-Shift-A(在
    mac 下是comm+shift+A),觉得无痛快,按需要修改快捷键即可。

(三) 配置 eslint 插件和 prettier插件

1. eslint 的配置

eslint 的自我批评规则是透过配备文件.eslintrc 实现之,但是各家有各家的
eslint 配置文件GitHub – AlloyTeam/eslint-config-alloy: AlloyTeam ESLint
规则:

图片 9图片 10

翔参考网址:

  • AlloyTeam ESLint
    规则
  • 超脱令人围捕狂的ESlint 语法检测配置说明 – web攻城方略 – SegmentFault
    思否
  • ESLint配置文件.eslintrc参数说明 ·
    GitHub

唯独此不纠用哪一样栽 eslint
的布局,具体看项目以及团,这里只是说明需要做 eslint
的配备,并且用举行有征:

.eslintrc 配置文件要添加修改地方,主要是为
prettier插件和eslint-config-prettier
插件与eslint-plugin-prettier插件使用的:

JavaScript

// 因为以了 eslint 和 prettier,所以只要增长他们 extends: [
‘eslint:recommended’, ‘plugin:prettier/recommended’], // required to
lint *.vue files 使用 html参数 plugins: [‘html’, ‘prettier’], //
rules 规则就是按各家写法。

1
2
3
4
5
6
7
// 因为使用了 eslint 和 prettier,所以要加上他们
extends: [ ‘eslint:recommended’, ‘plugin:prettier/recommended’],
 
// required to lint *.vue files 使用 html参数
plugins: [‘html’, ‘prettier’],
 
// rules 规则就按照各家写法。

在 webstorm 下,在列根本目录.eslintrc作为配置文件。

2. prettier的配置

prettier 的检查规则是由此部署文件.prettierrc
实现之,不过貌似的话,只需要安排少部分条条框框即可:

JavaScript

{ “printWidth”: 100, “singleQuote”: true, “semi”: false }

1
2
3
4
5
{
  "printWidth": 100,
  "singleQuote": true,
  "semi": false
}

来或会见出现的图景是,prettier 格式化后,全部加以了子公司,但是 eslint
又如失去丢分号,那么就是见面还了,这里可以略地设置 prettier 的分店设置与
eslint
保持一致,其他如此类推,但无非适用于几个比较特别的地方,可以参考官方文档。官方发详细的牵线:Configuration
File · Prettier

(四) 配置 editorconfig

  • EditorConfig可以帮忙开发者在不同之编辑器和IDE之间定义和保护一致的代码风格。
  • EditorConfig包含一个用于定义代码格式的公文和一致批判编辑器插件,这些插件可以于编辑器读取配置文件并依此格式化代码。

针对这我个人的喻就是是,editorconfig可以帮开发工具在自行格式化或者机关排版或者录入排版的当儿进行代码格式化,但是只能支持比较简单的平整,不过也减轻了同样有代码格式化的压力以及财力,所以发生比尚未好,而且太好只要发。

JavaScript

// 放在项目根本目录的.editorconfig文件 root = true [*] charset = utf-8
indent_style = space indent_size = 2 end_of_line = lf
insert_final_newline = true trim_trailing_whitespace = true

1
2
3
4
5
6
7
8
9
10
// 放在项目根目录的.editorconfig文件
root = true
 
[*]
charset = utf-8
indent_style = space
indent_size = 2
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

详细参考:

  • 【译】EditorConfig介绍 |
    AlloyTeam
  • EditorConfig

(五) 严格监督,按照流程检查及格式化代码,按照专业以及要求开展代码提交。

需明白一点,代码格式化需要由上而下执行,如果没强制性压力督促,那么是相持不了人类的惰性的。

通代码检查及格式化流程应该规范也如下步骤:

  1. 行使eslint 并且尝试自动修复所有题目(eslint 有 autofix
    提示,可以拓展—fix 修复,按照 .eslintrc 配置文件来展开修复)。
  2. 以 prettier 格式化所有代码。
  3. 差异性修复代码,因为微微格式或其它问题造成差而给前少管辖过滤后还剩余的。(通常前面两步基本缓解了独具题目了)
  4. 将良好的格式化后的代码提交至版本库。

参考文档:

  • 怎样花30分钟解决 eslint 产生的各种错误 |
    Tomyail的记忆现场
  • Introducing Prettier with Eslint – Michael Hsu –
    Medium
  • Efficient Code Analyzing and Formatting (for Vue.js) with ESLint
    and
    Prettier

    1 赞 收藏
    评论

图片 11

相关文章