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

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

2018/06/11 · JavaScript
· 格式化

初稿出处:
Edwin   

一、问题痛点

  • 在社团的档次支付进度中,代码维护所占的岁月比重往往超过新功能的开支。由此编写符合公司编码规范的代码是紧要的,那样做不仅可以很大程度地避免基本语法错误,也确保了代码的可读性。
  • 对此代码版本管理连串(svn 和
    git或者其余),代码格式不雷同带来的题目是惨重的,在代码一致的气象下,因为格式不相同,触发了版本管理种类标记为
    diff,导致力不从心检查代码和校验。

然而急需通晓的是,开发规范不仅仅包括代码格式规范,还有好多情节,那里只是独自说明代码格式化规范而已。

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

代码格式规范的标准可以参见各大主流集团和社区,以下都是一对常用主流规范:

参照旁人的正儿八经,制定切合自己团队采取的正规化,太过复杂的业内推行起来太费事,太过简短的正规不如没有正经。

从不断然的规范,只有顺应的规范!

(二)关于为啥要用 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 和更早的本子

若果用英特尔liJ IDEA, PhpStorm, PyCharm, and other JetBrains IDEs,
则须求设置prettier插件和 eslint 插件,而webstorm
的话默许会帮你安装上,那也是援引 webstorm 的来头。

1. WebStorm 2018.1 和上述的本子

官方默许已经合龙了 prettier 匡助,只须要配置好一个大局的 prettier
模块调用形式就足以行使了(必须安顿)。ca88官网 1

ca88官网 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以此插件,前面再统一验证。

ca88官网 3
ca88官网 4

  • ②是一贯运用 prettier 作为额外工具来利用。
    ca88官网 5ca88官网 6ca88官网 7
    ca88官网 8地方两种方法的默许飞速键都是Cmd/Ctrl-Shift-A(在
    mac 下是comm+shift+A),觉得不爽快,按需修改急速键即可。

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

1. eslint 的配置

eslint 的检查规则是经过布置文件.eslintrc 落成的,可是各家有各家的
eslint 配置文件GitHub – AlloyTeam/eslint-config-alloy: AlloyTeam ESLint
规则

ca88官网 9ca88官网 10

详尽参考网址:

而是那里不纠结用哪种 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

详细参考:

(五) 严峻监督,依照流程检查和格式化代码,根据规范和须要举办代码提交。

急需鲜贝因美(Beingmate)(Beingmate)点,代码格式化必要由上而下执行,即使没有强制性压力督促,那么是争执不了人类的惰性的。

全总代码检查和格式化流程应该规范为如下步骤:

  1. 行使eslint 并且尝试自动修复所有题目(eslint 有 autofix
    提示,可以拓展—fix 修复,依照 .eslintrc 配置文件来拓展修补)。
  2. 利用 prettier 格式化所有代码。
  3. 差别性修复代码,因为微微格式或者其余题目导致出错而被前两部过滤之后还剩余的。(常常前边两步基本解决了富有题目了)
  4. 把良好的格式化后的代码提交到版本库。

参考文档:

ca88官网 11

相关文章