代码保存时自动格式化

使用 Eslint Prettier vscode 配置文件

安装 eslint

  yarn add eslit - D
# 或者使用下面指令来初始化eslint配置
yarn eslint --init 

然后再 package.json 文件中可以看到 eslintConfig 内容， 也可在根目录新增 .eslint.trc 文件，进行 eslint 的配置。本文旨在 做自动格式化， eslint 配置不做赘述。

安装 Prettier

  yarn add prettier -D

安装成功后在根目录新增文件 prettier.json。并且写入下面配置代码。

// prettier.config.js or .prettierrc.js
module.exports = {
  // 一行最多 100 字符
  printWidth: 100,
  // 使用 2 个空格缩进
  tabWidth: 2,
  // 不使用缩进符，而使用空格
  useTabs: false,
  // 行尾需要有分号
  semi: false,
  // 使用单引号
  singleQuote: true,
  // 对象的 key 仅在必要时用引号
  quoteProps: 'as-needed',
  // jsx 不使用单引号，而使用双引号
  jsxSingleQuote: false,
  // 末尾不需要逗号
  trailingComma: 'none',
  // 大括号内的首尾需要空格
  bracketSpacing: true,
  // jsx 标签的反尖括号需要换行
  jsxBracketSameLine: false,
  // 箭头函数，只有一个参数的时候，也需要括号
  arrowParens: 'always',
  // 每个文件格式化的范围是文件的全部内容
  rangeStart: 0,
  rangeEnd: Infinity,
  // 不需要写文件开头的 @prettier
  requirePragma: false,
  // 不需要自动在文件开头插入 @prettier
  insertPragma: false,
  // 使用默认的折行标准
  proseWrap: 'preserve',
  // 根据显示样式决定 html 要不要折行
  htmlWhitespaceSensitivity: 'css',
  // 换行符使用 lf
  endOfLine: 'lf'
}

如果有特定的文件不需要Prettier来格式化，需要在根目录创建 .prettierignore 文件，然后输入 不需要格式化的文件或目录。然后要在对应不需要格式化的文件中 添加 /* prettier-ignore */ 注释。

# .prettierignore文件
node_modules
.umi
.umi-production
rsa2048.ts

# rsa2048.ts文件
/* prettier-ignore */
...

启用 vscode 的配置文件

1. 打开 vscode 编辑器的配置文件, 在 vscode 主界面快捷键 ctrl+shift+p , 弹窗里的 首选项: Open WorkSpace Settings(JSON)。然后就能在项目目录中看到 .vscode 的文件目录
2. 在 .vscode/settings.json 文件中写入下面配置代码

{
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  },
  "editor.formatOnSave": true,
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.tabSize": 2
}

配置完成

1. 保存文件时，会自动去除行末尾的逗号。

2. 对象冒号后面会自动添加 空格。

3. 代码会自动换行

高级选项

使用tabnin ， Quokka 等 vscode 拓展插件来智能补充代码。

跟多信息参考文章：Eslint & Prettier 做代码校验和自动格式化