使用ESLint+Prettier格式化React+Typescript项目

创建项目

直接使用create-react-app创建项目，假如要创建一个react-demo的项目：

npx create-react-app react-demo --template typescript

下载成功后，如果你使用的是vs code，可以直接使用如下命打开本项目：

cd react-demo
code .

集成editorconfig配置

EditorConfig 有助于为不同 IDE 编辑器上处理同一项目的多个开发人员维护一致的编码风格。根目录新建.editorconfig文件：

# http://editorconfig.org

root = true

[*] # 表示所有文件适用
charset = utf-8 # 设置文件字符集为 utf-8
indent_style = space # 缩进风格（tab | space）
indent_size = 2 # 缩进大小
end_of_line = lf # 控制换行类型(lf | cr | crlf)
trim_trailing_whitespace = true # 去除行首的任意空白字符
insert_final_newline = true # 始终在文件末尾插入一个新行

[*.md] # 表示仅 md 文件适用以下规则
max_line_length = off
trim_trailing_whitespace = false

VSCode需要安装一个插件：EditorConfig for VS Code

ESLint配置

安装eslint依赖

yarn add eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin -D

在项目根目录创建eslintrc.js配置文件：

module.exports = {
  parser: '@typescript-eslint/parser',
  extends: [
    'plugin:@typescript-eslint/recommended',
    'react-app',
    'react-app/jest',
    'plugin:prettier/recommended', // 这里先配置下，后面有安装
  ],
  plugins: ['@typescript-eslint', 'react'],
  rules: {},
};

vscode必须安装eslint插件：

prettier配置

Prettier是一款强大的代码格式化工具，支持 JavaScript、TypeScript、CSS、SCSS、Less、JSX、Angular、Vue、GraphQL、JSON、Markdown 等语言，基本上前端能用到的文件格式它都可以搞定，是当下最流行的代码格式化工具。

安装prettier依赖：

yarn add prettier eslint-config-prettier eslint-plugin-prettier -D

prettier: 格式化规则程序
eslint-config-prettier: 禁用所有和 Prettier 产生冲突的规则
eslint-plugin-prettier: 把 Prettier 应用到 Eslint，配合 rules "prettier/prettier": "error" 实现 Eslint 提醒。

项目根目录新建.prettierrc文件：

{
  "useTabs": false,
  "tabWidth": 2,
  "printWidth": 80,
  "singleQuote": true,
  "trailingComma": "none",
  "semi": false
}

useTabs：使用tab缩进还是空格缩进，选择false；
tabWidth：tab是空格的情况下，是几个空格，选择2个；
printWidth：当行字符的长度，推荐80，也有人喜欢100或者120；
singleQuote：使用单引号还是双引号，选择true，使用单引号；
trailingComma：在多行输入的尾逗号是否添加，设置为 none；
semi：语句末尾是否要加分号，默认值true，选择false表示不加；

项目根目录新建.prettierignore文件，忽略掉不需要格式化的文件夹或文件：

/dist/*
.local
.output.js
/node_modules/**

**/*.svg
**/*.sh

/public/*

vscode必须安装prettier插件：

其他补充

为了保持统一的风格，把package.json里的eslint和broswerlist的配置删掉，然后在根目录新建.browserslistrc文件：

[production]
>0.2%
not dead
not op_mini all

[development]
last 1 chrome version
last 1 firefox version
last 1 safari version

这里可以参照package.json文件的配置来写。

最后，需要把vscode设置成默认用prettier来格式文件：

然后重启vscode，大功告成。重启后可以在package.json文件的scripts里写一个脚本： "prettier: prettier --write ." 然后执行yarn run prettier，所有的文件都会以prettier风格重新格式化。

大功告成。