Prettier 配置及使用

2,100 阅读1分钟

一、背景

在维护就项目的时候,发现旧项目中存在代码特别冗长的情况,特别夸张的是GOMS项目中,一行代码的经常超过200个字符,维护起来体验很差,prettier是保证代码一致性、兼具美化效果的代码格式化工具,在项目中使用能够很好的解决上述问题。目前在oms重构新项目中探索prettier的配置及使用。

二、prettier配置

2.1 安装prettier所需的npm包

npm i -D prettier eslint-config-prettier eslint-plugin-react

2.2添加配置在项目中新增prettier.config.js,该文件是代码格式化时的配置文件,而非校验文件修改原有的eslint配置文件

目前仅将代码格式化的错误定为warning

具体的规则可言参考www.cnblogs.com/oneweek/p/1…

2.3解决冲突

项目中配置不使用尾逗号,prettier的默认配置是使用“es5”的策略,因此需要统一,将prettier中的trailingComma配置成“none”

三、在编辑器中的使用

3.1在webstorm中的使用

具体可参考blog.csdn.net/ttxxsir/art…


配置完成后,在保存后会自动格式化代码

注意:因为项目中一般只考虑在src目录下使用,所以配置Scope为src目录。

3.2在VS Code中的使用

安装prettier插件,使用格式化命令时,将格式化的方式默认更改为prettier。

3.3在subline中的使用

四、后续

如果在项目中推广使用顺利,后续建议在git提交代码时,增加格式校验勾子,确保代码的美观易读。


参考文献:

1.www.cnblogs.com/qiqi715/p/1…

2.prettier使用官网