Prettier和editorconfig和eslint的配置

497 阅读1分钟

Prettier使用记录

1.安装npm包和插件

npm install prettier -D

image.png

2.文件设置美化格式

image.png

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

  • 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/*

3.保存时进行美化

image.png

image.png

4.设置命令

"prettier": "prettier --write ."

image.png

editorconfig的使用

1.安装插件

image.png

2.设置格式

image.png

# 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

eslint的使用

1.安装npm包和插件

npm install eslint -D

image.png

2.eslint和prettier两个会冲突,需要安装下面二个插件 (先看有没有eslint-config-prettier)

npm install eslint-plugin-prettier eslint-config-prettier -D

3.设置代码规范

image.png

  extends: [
    'plugin:vue/vue3-essential',
    'eslint:recommended',
    '@vue/typescript/recommended',
    '@vue/prettier',
    '@vue/prettier/@typescript-eslint',
    'plugin:prettier/recommended' // 这个就是使用解决冲突的插件(让eslint使用prettier进行检测)
  ],

注意: 配置不生效完重启即可