Skip to content

前端规范工程化最佳实践

一、ESLint

  • .eslintrc.js 以 VSCode 编辑器为例,安装 ESLint 插件并在编辑器设置 settings.json 添加以下配置: "editor.codeActionsOnSave": { "source.fixAll.eslint": true, },

二、Prettier

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

三、StyleLint

  • .stylelintrc.js

"editor.codeActionsOnSave": { "source.fixAll.eslint": true, "source.fixAll.stylelint": true }

四、.editorconfig