非标题党:前端项目编程规范化配置(大厂规范)

lxf2023-03-17 17:27:01

前端项目编程规范化配置

下述例子主要是从 代码规范化 以及 git 提交规范化 两方面进行配置。内容很多,请做好心理准备

一、代码检测工具 ESLint

在我们通过 vue create “项目名” 时,我们可以通过手动配置的方式,来配置 ESLint 来对代码进行检测。

? Pick a linter / formatter config: 
  ESLint with error prevention only // 仅包含错误的 ESLint
  ESLint + Airbnb config // Airbnb 的 ESLint 延伸规则
  ESLint + Standard config // 标准的 ESLint 规则

当我们配置了 标准的 ESLint 规则后,在项目根目录下会生成 .eslintrc.js 文件

// ESLint 配置文件遵循 commonJS 的导出规则,所导出的对象就是 ESLint 的配置对象
// 文档:https://eslint.bootcss.com/docs/user-guide/configuring
module.exports = {
  // 表示当前目录即为根目录,ESLint 规则将被限制到该目录下
  root: true,
  // env 表示启用 ESLint 检测的环境
  env: {
    // 在 node 环境下启动 ESLint 检测
    node: true
  },
  // ESLint 中基础配置需要继承的配置
  extends: ["plugin:vue/vue3-essential", "@vue/standard"],
  // 解析器
  parserOptions: {
    parser: "babel-eslint"
  },
  // 需要修改的启用规则及其各自的错误级别
  /**
   * 错误级别分为三种:
   * "off" 或 0 - 关闭规则
   * "warn" 或 1 - 开启规则,使用警告级别的错误:warn (不会导致程序退出)
   * "error" 或 2 - 开启规则,使用错误级别的错误:error (当被触发的时候,程序会退出)
   */
  rules: {
    "no-console": process.env.NODE_ENV === "production" ? "warn" : "off",
    "no-debugger": process.env.NODE_ENV === "production" ? "warn" : "off"
  }
};

当我们配置好 ESLint 规范后,就可以控制好自己的代码格式规范,但出现不符合规范的代码格式时,在运行阶段,ESLint 会在控制台输出提示信息。

但由此也暴露了一些问题,我们并不清楚 ESLint 有哪些规范,当我们出现不符合 ESLint 代码规范时,我们并不知道该怎么解决,那该怎么办?

接下来:要介绍的另外一个插件就是为了解决上诉问题的。


二、代码格式化 Prettier

Prettier 的作用:既可以保证 ESLint 规则校验,又可以让开发者无需关注格式问题来进行顺畅的开发

如何使用:

  • 步骤一:在 vsCode 中 安装 prettier 插件

非标题党:前端项目编程规范化配置(大厂规范)

  • 步骤二:在项目根目录下新建 .prettierrc 文件(该文件为 prettier 默认配置文件),并写入配置规则
{
  // 不尾随分号
  "semi": false,
  // 使用单引号
  "singleQuote": true,
  // 多行逗号分割的语法中,最后一行不加逗号
  "trailingComma": "none"
}
  • 步骤三:在vsCode 设置中,搜索 save ,勾选 Format On Save(目的:保存时对代码进行检测)

非标题党:前端项目编程规范化配置(大厂规范)

到这里就基本配置结束了,但这里会有一个问题,如果我们电脑的 VSCode 中 安装了多个代码格式化工具时,可能会出现 prettier 无法对代码进行格式化

解决方法

非标题党:前端项目编程规范化配置(大厂规范)

prettierESLint 有几个地方会出现冲突(需要同步一下):

  • VSCode 而言,默认一个 tab 等于 4 个空格,而 ESLint 希望一个 tab 为两个空格

非标题党:前端项目编程规范化配置(大厂规范)

  • 定义方法名和后面的小括号之间,得有一个空格!

非标题党:前端项目编程规范化配置(大厂规范)

出现这种情况可以修改ESLint 的配置文件(.eslintrc.js)将这个报错信息给关闭掉

rules: {
    // 该规则表示关闭《方法名后增加空格》的规则
    'space-before-function-paren': 'off'
 }

tips: 至此我们整个的 perttierESLint 的配合使用就算是全部完成了。到这里,代码规范化 已经配置好了。 接下来就是:git 提交规范化


三、约定式提交规范

我们在开发过程中,最常用的项目管理工具主要是 Git 工具。而约定式提交就是针对执行 git commit -m "描述信息" 时对 ”描述信息“ 进行规范化。

对于 Git 提交规范 来说,不同的团队可能会有不同的标准

目前使用最多的规范: Conventional Commits specification(约定式提交)


tips:

下面就已上述的规范进行 Git 提交进行规范化处理


四、 Commitizen

commitizen 仓库名为 cz-cli ,它提供了一个 git cz 的指令用于代替 git commit,从而对 Git 提交进行规范化处理

当你使用 commitizen 进行代码提交(git commit)时,commitizen 会提交你在提交时填写所有必需的提交字段!


注:接下的所有操作建议 npm >= 7

注:接下的所有操作建议 npm >= 7

注:接下的所有操作建议 npm >= 7

重要的事情说三遍!!!!!


1、由于我们平常要经常要使用到 Commitizen 来规范提交代码,建议全局安装

非标题党:前端项目编程规范化配置(大厂规范)

2、进入到项目中,安装 cz-customizable(局部,局部,局部)

npm i cz-customizable@6.3.0 --save-dev

3、添加下面配置信息到 package.json

"config": {
    "commitizen": {
      "path": "node_modules/cz-customizable"
    }
}

非标题党:前端项目编程规范化配置(大厂规范)

4、在项目根目录下创建 .cz-config.js 自定义提示文件

module.exports = {
  // 可选类型
  types: [
    { value: 'feat', name: 'feat: