Prettier初体验

时间 2019-12-05

标签 prettier 体验繁體版

原文原文链接

前言

最近正在新作一个新的项目，准备尝试一下社区很火的Prettier，一边学习的同时也正好总结了一些经验，在这里作一些记录json

什么是 Prettier

Prettier 是一个代码格式化工具，它能够支持 JS/JSX/TS/Flow/JSON/CSS/LESS 等文件格式。数组

为何要用 Prettier

用来替代 lint 中的一些场景，好比说分号/tab 缩进/空格/引号，这些在 lint 工具检查出问题以后还须要手动修改，而一般这样的错误都是空格或者符号之类的，这样相对来讲不太优雅，利用格式化工具自动生成省时省力。函数

如何自定义配置

Prettier 提供了一套默认的配置，那么如何修改配置项符合咱们本身的代码规范呢，有三种方法能够作到工具

.prettierrc 文件学习
prettier.config.js 文件ui
package.json 中配置 prettier 属性es5

Prettier 会检查配置文件并自动读取文件中的配置，咱们只须要选一种方法配置就行了，我如今选的是第二种。是否是有种感受跟 lint 工具很像呢？spa

集成 VS CODE

只须要下载 prettier 的插件就能够了,在插件市场搜索能够直接搜索到插件

下面是愉快使用的相关配置代码规范

editor.formatOnPaste: Boolean //粘贴时自动格式化

editor.formatOnSave: Boolean //保存时自动格式化

editor.formatOnType: Boolean //键入一行后是否格式化

editor.formatOnSaveTimeout: Int //保存后延时格式化
复制代码

可配置的属性

分享一下个人配置文件

module.exports = {
// tab缩进大小,默认为2
tabWidth: 2,


// 使用tab缩进，默认false
useTabs: true,


// 使用分号, 默认true
semi: false,


// 使用单引号, 默认false(在jsx中配置无效, 默认都是双引号)
singleQuote: true,


// 行尾逗号,默认none,可选 none|es5|all
// es5 包括es5中的数组、对象
// all 包括函数对象等全部可选
TrailingCooma: "none",


// 对象中的空格 默认true
// true: { foo: bar }
// false: {foo: bar}
bracketSpacing: true,


// JSX标签闭合位置 默认false
// false: <div
// className=""
// style={{}}
// >
// true: <div
// className=""
// style={{}} >
jsxBracketSameLine：false,


// 箭头函数参数括号 默认avoid 可选 avoid| always
// avoid 能省略括号的时候就省略 例如x => x
// always 老是有括号
arrowParens: 'always',

}

复制代码