前端团队规范探索:自动格式化、代码校验、提交规范

简介: 以往在使用eslint对代码进行规范的时候,经常遇到校验与自动化格式化规则不同的问题,比如eslint中规定末尾必须使用分号,那么你开发工具中代码美化插件也需要配置相应的格式化规则,这是比较麻烦的,所以standard规范太霸道了,大家开发基本都不会去用。

目前已集成为vue-cli-plugin,可以直接使用自动化配置,无需手动配置。

--以下正文--

以往在使用eslint对代码进行规范的时候,经常遇到校验与自动化格式化规则不同的问题,比如eslint中规定末尾必须使用分号,那么你开发工具中代码美化插件也需要配置相应的格式化规则,这是比较麻烦的,所以standard规范太霸道了,大家开发基本都不会去用。

这里我们使用别的团队封装好的车轮,他们去掉了eslint中的代码风格的校验,只专注于代码逻辑的校验,而代码美化部分则交给了prettier来做,这样就避免了上述冲突。

首先安装

yarn add eslint-config-alloy -D

vue2:

yarn add eslint-config-alloy@3 -D

安装eslint校验以及vue工具:

yarn add eslint babel-eslint vue-eslint-parser eslint-plugin-vue -D

安装typescript支持:

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

根目录创建:.eslintrc.js

module.exports = {
  extends: ['alloy', 'alloy/vue', 'alloy/typescript'],
  env: {
    // 你的环境变量(包含多个预定义的全局变量)
    //
    // browser: true,
    // node: true,
    // mocha: true,
    // jest: true,
    // jquery: true
  },
  globals: {
    // 你的全局变量(设置为 false 表示它不允许被重新赋值)
    //
    // myGlobal: false
  },
  rules: {
    // 自定义你的规则,这里我把以前tslint的规则直接搬过来了,还没排查未生效项
    'no-empty': false,
    'only-arrow-functions': [false, 'allow-declarations', 'allow-named-functions'],
    quotemark: [false, 'single'],
    indent: [true, 'spaces', 2],
    'interface-name': false,
    'ordered-imports': false,
    'object-literal-sort-keys': false,
    'no-consecutive-blank-lines': false,
    semicolon: false,
    'max-line-length': false,
    'prefer-for-of': false,
    'trailing-comma': false,
    'arrow-parens': false,
    'no-console': false,
  },
}

根目录创建 .vscode/settings.json (这是为项目配置保存自动格式化)

{
    "files.eol": "\n",
    "editor.tabSize": 2,
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "esbenp.prettier-vscode",
    "eslint.validate": ["javascript", "javascriptreact", "vue", "typescript", "typescriptreact"],
    "editor.codeActionsOnSave": {
      "source.fixAll.eslint": true
    }
  }

根目录创建 .prettierrc.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',
}

以上方式配置只在项目中生效,编辑器为vscode,与个人配置(user->settings.json)不冲突,如果你是用vetur对vue代码进行格式化,可以额外配置自己的风格,本人经常使用如下配置:

  "vetur.format.defaultFormatter.html": "js-beautify-html",
  "vetur.format.defaultFormatterOptions": {
    "js-beautify-html": {
      "wrap_attributes": "auto"
    }
  }

这是单独为vue中的html配置的attributes规则,因为我不想标签每个属性都换行,而prettier则对此无能为力。

husky 一个git钩子插件

husky经常配合lint-staged一起使用,在git提交的钩子中用lint-staged做一些操作,例如让你提交前运行vue自带的代码格式化工具:vue-cli-service lint,或者运行prettier --write,它的作用是可以配置一些规则,且只对本次提交的各种文件进行检查而不是整个项目。

但是我们已经做到了自动保存格式化,这种方式明显是多余的,所以我们现在只需要一个husky,来对commit提交做些规范工作。

安装

yarn add husky -D

新版使用方法:
package.json中添加脚本

"scripts": {
    "prepare": "husky install",
  }

执行初始化

npm run prepare

会在根目录生成一个目录,使用命令往git钩子中添加要执行的命令:

npx husky add .husky/pre-commit "npm test"

git commit时对应的生命周期会触发对应的命令。

如果你想使用旧版的配置,需要指定版本安装:

yarn add husky@3.0.9 -D

package.json配置

"husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS" 
      "pre-commit": "xxx" // pre-commit,提交前的钩子
    }
  },

Commitize 统一代码提交信息

安装:

yarn add commitizen cz-conventional-changelog @commitlint/cli @commitlint/config-conventional -D

package.json添加如下配置

  "config": {
    "commitizen": {
      "path": "node_modules/cz-conventional-changelog"
    }
  },
   "commitlint": {
    "extends": [
      "@commitlint/config-conventional"
    ]
  },

在根目录创建 commitlint.config.js 配置我们的commit规则

/**
 * feat 新功能
 * fix 修补bug
 * docs 文档修改
 * style 样式修改
 * build 代码编译
 * refactor 代码重构
 * code 代码优化
 * test 测试用例
 */
module.exports = {
  extends: ['@commitlint/config-conventional'],
  rules: {
    'type-enum': [2, 'always', ['feat', 'fix', 'docs', 'style', 'build', 'refactor', 'test', 'code']],
  },
}

附录:config-conventional

最终不符合规范的git commit将会被拦截。

package.json添加

"scripts": {
    "c": "git add . && git-cz"
  }

提交代码使用 yarn cnpm run c,即可使用命令行工具以Angular规范(社区使用最广泛的规范)进行代码提交。

终端工具选择:

mac:无所谓 ,自带终端就很强大。

windows:我遇到过还有在使用CMD的同事,曾经也用过一段时间装git附赠的gitBash工具,这些都不太好用,建议使用vsCode自带的Terminal工具就很好。

相关文章
|
1月前
|
缓存 前端开发 JavaScript
利用代码分割优化前端性能:策略与实践
在现代Web开发中,代码分割是提升页面加载性能的有效手段。本文介绍代码分割的概念、重要性及其实现策略,包括动态导入、路由分割等方法,并探讨在React、Vue、Angular等前端框架中的具体应用。
|
23天前
|
缓存 监控 前端开发
探索前端性能优化:关键策略与代码实例
本文深入探讨前端性能优化的关键策略,结合实际代码示例,帮助开发者提升网页加载速度和用户体验,涵盖资源压缩、懒加载、缓存机制等技术。
|
2月前
|
JavaScript 前端开发 Docker
前端全栈之路Deno篇(二):几行代码打包后接近100M?别慌,带你掌握Deno2.0的安装到项目构建全流程、剖析构建物并了解其好处
在使用 Deno 构建项目时,生成的可执行文件体积较大,通常接近 100 MB,而 Node.js 构建的项目体积则要小得多。这是由于 Deno 包含了完整的 V8 引擎和运行时,使其能够在目标设备上独立运行,无需额外安装依赖。尽管体积较大,但 Deno 提供了更好的安全性和部署便利性。通过裁剪功能、使用压缩工具等方法,可以优化可执行文件的体积。
151 3
前端全栈之路Deno篇(二):几行代码打包后接近100M?别慌,带你掌握Deno2.0的安装到项目构建全流程、剖析构建物并了解其好处
|
1月前
|
Web App开发 缓存 监控
前端性能优化实战:从代码到部署的全面策略
前端性能优化实战:从代码到部署的全面策略
31 1
|
1月前
|
Web App开发 前端开发 JavaScript
前端性能优化实战:从代码到部署的全面指南
前端性能优化实战:从代码到部署的全面指南
34 1
|
1月前
|
前端开发 JavaScript UED
不可思议!前端小白如何靠这些技巧逆袭,成为团队中的闪耀之星?
前端开发对初学者来说充满挑战,但通过正确的方法和技巧,你可以从新手蜕变为高手。本文分享前端小白逆袭的秘诀,包括夯实HTML、CSS与JavaScript基础,掌握前端框架与库,提升性能优化技巧,以及持续学习与分享。示例代码展示了简单的HTML+CSS+JavaScript页面和Vue组件,帮助你逐步进阶。
24 4
|
1月前
|
前端开发 JavaScript
前端界的革命:掌握这些新技术,让你的代码简洁到让人惊叹!
前端技术的快速发展带来了许多令人惊叹的新特性。ES6及其后续版本引入了箭头函数、模板字符串等简洁语法,极大减少了代码冗余。React通过虚拟DOM和组件化思想,提高了代码的可维护性和效率。Webpack等构建工具通过模块化和代码分割,优化了应用性能和加载速度。这些新技术正引领前端开发的革命,使代码更加简洁、高效、可维护。
28 2
|
1月前
|
前端开发 JavaScript 测试技术
前端工程师的必修课:如何写出优雅、可维护的代码?
前端工程作为数字世界的门面,编写优雅、可维护的代码至关重要。本文从命名规范、模块化设计、注释与文档、遵循最佳实践四个方面,提供了提升代码质量的方法。通过清晰的命名、合理的模块划分、详细的注释和持续的学习,前端工程师可以写出高效且易于维护的代码,为项目的成功打下坚实基础。
34 2
|
1月前
|
监控 前端开发 JavaScript
前端开发的终极奥义:如何让你的代码既快又美,还不易出错?
【10月更文挑战第31天】前端开发是一个充满挑战与机遇的领域,本文从性能优化、代码美化和错误处理三个方面,探讨了如何提升代码的效率、可读性和健壮性。通过减少DOM操作、懒加载、使用Web Workers等方法提升性能;遵循命名规范、保持一致的缩进与空行、添加注释与文档,让代码更易读;通过输入验证、try-catch捕获异常、日志与监控,增强代码的健壮性。追求代码的“快、美、稳”,是每个前端开发者的目标。
39 3
|
1月前
|
前端开发 JavaScript 开发者
前端开发的终极技巧:如何让你的代码既简洁又高效,还能减少bug?
【10月更文挑战第30天】前端开发充满挑战与创新,如何编写简洁高效且少bug的代码是开发者关注的重点。本文介绍五大技巧:1. 模块化,提高代码复用性;2. 组件化,降低代码耦合度;3. 使用现代框架,提高开发效率;4. 统一代码规范,降低沟通成本;5. 利用工具,优化代码质量。掌握这些技巧,让前端开发更高效。
84 1