梳理前端开发使用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

相关文章