代码规范1

目录规范

• kebab-case 命名

代码风格

prettier 配置

{
  "singleQuote": true,
  "semi": false,
  "trailingComma": "all",
  "arrowParens": "always",
  "htmlWhitespaceSensitivity": "ignore"
}

• singleQuote: 在 js 中使用单引号风格、html 或 vue 模板中使用双引号；两者混用时不易产生混淆。
• semi: 做一个无分号党。
• trailingComma: 对 git diff 友好，编码体验友好。
• arrowParens: 总是带括号，方便增减参数、或解构。
• htmlWhitespaceSensitivity: 参考issue#6061。

git 配置

我们约定使用类 Unix 风格的换行符 \n 作为标准，统一的换行符，使得 git diff 更友好。

因此，建议在项目中添加 .gitattributes 文件，配置如下：

* text=auto eol=lf

Javascript 规范

• airbnb javascript 风格指南
• vue 风格指南
• typescript 风格指南

样式规范

• stylelint-config-standard
• stylelint-config-prettier

git 规范

pr 机制有待完善

• git commit message 规范
• pr 机制

VSCode 配置

打通整个开发流程，使得整个过程中的结果保持一致性，开发工具作为最为常见的场景，它能良好的运转至关重要。

必备插件

• stylelint
• eslint
• prettier
• vetur

工作区配置

{
    "eslint.format.enable": true, # 启动 eslint 格式化功能
    "editor.formatOnSave": true, # 【推荐】保存时自动格式化
    "eslint.alwaysShowStatus": true, # 【推荐】开启后，右下角能看到 eslint 控制台信息
    "[javascript]": {
	   # 使用 eslint 格式化
        "editor.defaultFormatter": "dbaeumer.vscode-eslint"
    },
    "[typescript]": {
	   # 使用 eslint 格式化
        "editor.defaultFormatter": "dbaeumer.vscode-eslint"
    },
    "[vue]": {
	   # 使用 eslint 格式化
        "editor.defaultFormatter": "dbaeumer.vscode-eslint"
    },
    "[html]": {
	   # 使用 prettier 格式化
        "editor.defaultFormatter": "esbenp.prettier-vscode"
    },
    "[typescriptreact]": {
	   # 使用 prettier 格式化，eslint 不支持 jsx 扩展
        "editor.defaultFormatter": "esbenp.prettier-vscode"
    }
}