一.项目搭建规范

1.1. 集成editorconfig配置


EditorConfig 有助于为不同 IDE 编辑器上处理同一项目的多个开发人员维护一致的编码风格。

  1. # http://editorconfig.org
  3. root = true
  5. [*] # 表示所有文件适用
  6. charset = utf-8 # 设置文件字符集为 utf-8
  7. indent_style = space # 缩进风格（tab | space）
  8. indent_size = 2 # 缩进大小
  9. end_of_line = lf # 控制换行类型(lf | cr | crlf)
  10. trim_trailing_whitespace = true # 去除行首的任意空白字符
  11. insert_final_newline = true # 始终在文件末尾插入一个新行
  13. [*.md] # 表示仅 md 文件适用以下规则
  14. max_line_length = off
  15. trim_trailing_whitespace = false


1.2. 使用prettier工具

1.安装prettier
npm install prettier -D
2.配置.prettierrc文件：

  • useTabs：使用tab缩进还是空格缩进，选择false；
  • tabWidth：tab是空格的情况下，是几个空格，选择2个；
  • printWidth：当行字符的长度，推荐80，也有人喜欢100或者120；
  • singleQuote：使用单引号还是双引号，选择true，使用单引号；
  • trailingComma：在多行输入的尾逗号是否添加，设置为 none；
  • semi：语句末尾是否要加分号，默认值true，选择false表示不加；
    1. {
    2. "useTabs": false,
    3. "tabWidth": 2,
    4. "printWidth": 80,
    5. "singleQuote": true,
    6. "trailingComma": "none",
    7. "semi": false
    8. }
    3.创建.prettierignore忽略文件
  1. /dist/*
  2. .local
  3. .output.js
  4. /node_modules/**
  6. **/*.svg
  7. **/*.sh
  9. /public/*

在package.json中配置一个scripts：

"prettier":"prettier --write ."

1.3. 使用Eslint检测

1.安装
npm i eslint -D
2.初始化
npx eslint --init