前端实用工具（二）：编程规范化解决方案

news2024/11/16 2:40:41

目录

本地代码规范化工具

代码检测工具ESLint

代码格式化工具Prettier

远程代码规范化工具

远程提交规范化工具commitizen

提交规范检验工具commitlint +husky

什么是git hooks

commitlint安装

husky安装

检测代码提交规范 ESLint +husky

自动修复格式错误lint-staged

本地代码规范化工具

代码检测工具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规则在rules中以键值对的形式添加

代码格式化工具Prettier

安装prettier插件

新建 .prettierrc 文件，该文件为 perttier 默认配置文件

{
  // 不尾随分号
  "semi": false,
  // 使用单引号
  "singleQuote": true,
  // 多行逗号分割的语法中，最后一行不加逗号
  "trailingComma": "none"
}

在VSCode设置中，搜索 save ，勾选 Format On Save

ESLint和prettier的常见问题？

● VSCode默认制表符是4个空格，而ESLint希望一个制表符是两个空格

● 如果VSCode安装多个代码格式化工具可能会冲突

● ESLint和Prettier之间有冲突，默认ESLint括号前会有空格需要手动关闭'space-before-function-paren':'off'

远程代码规范化工具

远程提交规范化工具commitizen

commitizen 仓库名为 cz-cli ，它提供了一个 git cz 的指令用于代替 git commit，简单一句话介绍它：

当你使用 commitizen 进行代码提交（git commit）时，commitizen 会提交你在提交时填写所有必需的提交字段！

commitizen安装步骤如下：

  1. 全局安装Commitizen
npm install -g commitizen@4.2.4
  1. 安装并配置 cz-customizable 插件
  • 使用 npm 下载 cz-customizable
npm i cz-customizable@6.3.0 --save-dev
  • 添加以下配置到 package.json 中
...
  "config": {
    "commitizen": {
      "path": "node_modules/cz-customizable"
    }
  }
  1. 项目根目录下创建 .cz-config.js 自定义提示文件
module.exports = {
  // 可选类型
  types: [
    { value: 'feat', name: 'feat:     新功能' },
    { value: 'fix', name: 'fix:      修复' },
    { value: 'docs', name: 'docs:     文档变更' },
    { value: 'style', name: 'style:    代码格式(不影响代码运行的变动)' },
    {
      value: 'refactor',
      name: 'refactor: 重构(既不是增加feature，也不是修复bug)'
    },
    { value: 'perf', name: 'perf:     性能优化' },
    { value: 'test', name: 'test:     增加测试' },
    { value: 'chore', name: 'chore:    构建过程或辅助工具的变动' },
    { value: 'revert', name: 'revert:   回退' },
    { value: 'build', name: 'build:    打包' }
  ],
  // 消息步骤
  messages: {
    type: '请选择提交类型:',
    customScope: '请输入修改范围(可选):',
    subject: '请简要描述提交(必填):',
    body: '请输入详细描述(可选):',
    footer: '请输入要关闭的issue(可选):',
    confirmCommit: '确认使用以上信息提交？(y/n/e/h)'
  },
  // 跳过问题
  skipQuestions: ['body', 'footer'],
  // subject文字长度默认是72
  subjectLimit: 72
}
  1. 使用 git cz 代替 git commit

补充：

不同的团队可能会有不同的标准，那么咱们今天就以目前使用较多的 Angular团队规范 延伸出的 Conventional Commits specification（约定式提交） 为例，来为大家详解 git 提交规范

约定式提交规范要求如下：

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

--------  翻译 -------------
    
<类型>[可选 范围]: <描述>

[可选 正文]

[可选 脚注]

其中 <type> 类型，必须是一个可选的值，比如：

  1. 新功能：feat
  2. 修复：fix
  3. 文档变更：docs
  4. ....

如果忘记了git cz指令，我们有没有方法限制这种错误的出现？

我们可以使用git hooks + commitlint阻止不规范提交

提交规范检验工具commitlint +husky

检查提交描述是否符合规范要求husky+commitlint

什么是git hooks

Git hooks(git 钩子 || git 回调方法)：git在执行某些事件之间或之后进行一些其他额外的操作

PS：详细的 HOOKS介绍 可点击这里查看

整体的 hooks 非常多，当时我们其中用的比较多的其实只有两个：

  1. commit-msg：可以用来规范化标准格式，并且可以按需指定是否要拒绝本次提交
  2. pre-commit：会在提交前被调用，并且可以按需指定是否要拒绝本次提交

  • Husky：主要作用是简化git hooks的配置和管理，可以通过配置文件定义钩子行为（简化拆分git hooks）
  • commitlint：用来检查提交信息

Husky 和 commitlint 通常一起使用，Husky监听commit-msg函数，在每次提交之前触发commitlint 检查提交规范

下面我们分别安装两个工具

commitlint安装

  1. 安装依赖：
npm install --save-dev @commitlint/config-conventional@12.1.4 @commitlint/cli@12.1.4
  1. 创建 commitlint.config.js 文件（也可以手动创建）
echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js
  1. 打开 commitlint.config.js ， 增加配置项（ config-conventional 默认配置点击可查看 ）：
module.exports = {
  // 继承的规则
  extends: ['@commitlint/config-conventional'],
  // 定义规则类型
  rules: {
    // type 类型定义，表示 git 提交的 type 必须在以下类型范围内
    'type-enum': [
      // 当前验证的错误级别
      2,
      // 在什么情况下进行验证
      'always',
      [
        'feat', // 新功能 feature
        'fix', // 修复 bug
        'docs', // 文档注释
        'style', // 代码格式(不影响代码运行的变动)
        'refactor', // 重构(既不增加新功能，也不是修复bug)
        'perf', // 性能优化
        'test', // 增加测试
        'chore', // 构建过程或辅助工具的变动
        'revert', // 回退
        'build' // 打包
      ]
    ],
    // subject 大小写不做校验
    'subject-case': [0]
  }
}

注意：确保保存为 UTF-8 的编码格式，否则可能会出现以下错误：

husky安装

  1. 安装依赖：
npm install husky@7.0.1 --save-dev
  1. 启动 hooks ， 生成 .husky 文件夹
npx husky install

  1. 在 package.json 中生成 prepare 指令（ 需要 npm > 7.0 版本 ）

命令无效就手动添加

npm set-script prepare "husky install"

  1. 执行 prepare 指令
npm run prepare
  1. 执行成功，提示

  1. 添加 commitlint 的 hook 到 husky中，并指令在 commit-msg 的 hooks 下执行 npx --no-install commitlint --edit "$1" 指令
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'
  1. 此时的 .husky 的文件结构

至此， 不符合规范的 commit 将不再可提交：

PS F:\xxxxxxxxxxxxxxxxxxxxx\test-admin> git commit -m "测试"
⧗   input: 测试
✖   subject may not be empty [subject-empty]
✖   type may not be empty [type-empty]

✖   found 2 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

husky - commit-msg hook exited with code 1 (error)

检测代码提交规范 ESLint +husky

在前面的ESLint和Prettier配合解决的是本地代码的格式问题，而且我们需要手动在VSCode中配置自动保存

如果本地忘记配置了，怎么在提交之前如何检测代码格式是否错误？

husky 监测 pre-commit 钩子，在该钩子下执行 npx eslint --ext .js,.vue src 指令来去进行相关检测

执行脚本，在pre-commit 中执行检测代码

npx husky add .husky/pre-commit "npx eslint --ext .js,.vue src"

操作会生成对应文件 pre-commit：

此时如果不符合ESLint标准，代码提交失败

自动修复格式错误lint-staged

lint-staged 可以让你当前的代码检查 只检查本次修改更新的代码，并在出现错误的时候，自动修复并且推送

  1. 修改 package.json 配置
"lint-staged": {
    "src/**/*.{js,vue}": [
      "eslint --fix",
      "git add"
    ]
  }
  1. 如上配置，每次它只会在你本地 commit 之前，校验你提交的内容是否符合你本地配置的 eslint规则(这个见文档 ESLint )，校验会出现两种结果：
  • 如果符合规则：则会提交成功。
  • 如果不符合规则：它会自动执行 eslint --fix 尝试帮你自动修复，如果修复成功则会帮你把修复好的代码提交，如果失败，则会提示你错误，让你修好这个错误之后才能允许你提交代码。
  1. 修改 .husky/pre-commit 文件
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx lint-staged
  1. 再次执行提交代码
  2. 发现 暂存区中 不符合 ESlint 的内容，被自动修复

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/2151165.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

前缀和与差分（二维）

前缀和与差分（二维）

二维前缀和 下面是一个二维数组&#xff0c;我们要求&#xff08;1&#xff0c;1&#xff09;到&#xff08;2&#xff0c;2&#xff09;区间内的所有元素的和&#xff0c;最原始的方法就是遍历每个元素然后一个一个加起来&#xff0c;此时时间复杂度为O(n*m)。 我们之前学过…
阅读更多...
华为---代理ARP工作过程示例分析

华为---代理ARP工作过程示例分析

目录 1. 示例场景 2. 基本配置 3. 配置代码 4. 测试验证 5. 抓包分析 5.1 在代理ARP环境下PC1和PC2通信分析 5.2 取消代理ARP环境下PC1和PC2通信分析 【1】取消R1路由器GE 0/0/1端口ARP代理 【2】取消R2路由器GE 0/0/1端口ARP代理 1. 示例场景 如上图所示&#xff0c;…
阅读更多...
Python 中的方法解析顺序（MRO）

Python 中的方法解析顺序（MRO）

在 Python 中&#xff0c;MRO&#xff08;Method Resolution Order&#xff0c;方法解析顺序&#xff09;是指类继承体系中&#xff0c;Python 如何确定在调用方法时的解析顺序。MRO 决定了在多继承环境下&#xff0c;Python 如何寻找方法或属性&#xff0c;即它会根据一定规则…
阅读更多...
Ceph 基本架构（一）

Ceph 基本架构（一）

Ceph架构图 Ceph整体组成 Ceph 是一个开源的分布式存储系统&#xff0c;设计用于提供优秀的性能、可靠性和可扩展性。Ceph 的架构主要由几个核心组件构成&#xff0c;每个组件都有特定的功能&#xff0c;共同协作以实现高可用性和数据的一致性。 以下是 Ceph 的整体架构及其…
阅读更多...
【PyTorch】autograd与逻辑回归

【PyTorch】autograd与逻辑回归

autograd – 自动求导系统 torch.autograd autograd torch.autograd.backward 功能&#xff1a;自动求取梯度 tensor&#xff1a;用于求导的张量&#xff0c;如lossretain_graph&#xff1a;保存计算图create_graph&#xff1a;创建导数计算图&#xff0c;用于高阶求导gra…
阅读更多...
mac安装JetBtains全家桶新版本时报错：Cannot start the IDE

mac安装JetBtains全家桶新版本时报错：Cannot start the IDE

mac安装JetBtains全家桶新版本时报错&#xff1a;Cannot start the IDE 前言报错信息解决方法 前言 作者使用的是Mac电脑&#xff0c;最近想要更新JetBrains相关工具的软件版本&#xff0c;但是在安装时突然报错&#xff0c;导致安装失败&#xff0c;现在将报错信息以及解决方…
阅读更多...
API应用安全风险倍增，F5助企业赢得关键安全挑战

API应用安全风险倍增，F5助企业赢得关键安全挑战

如今&#xff0c;API应用安全的重要性与日俱增&#xff0c;但其复杂性也达到前所未有的程度。F5公司在亚太地区发布全新研究报告《2024策略洞察&#xff1a;亚太地区API安全报告》&#xff08;以下简称为“报告”&#xff09;&#xff0c;指出亚太地区企业正愈加依赖基于人工智…
阅读更多...
Linux 进程2

Linux 进程2

环境变量 再Linux操作系统中一切皆文件&#xff0c;这个环境变量自然也是一个文件&#xff0c;它的作用是辅助我们使用操作系统还可以辨识我们是什么用户(一般用户&#xff0c;root用户)。 env是读取完整环境变量的指令&#xff0c;里面记录了许多我登录操作系统所用的用户的信…
阅读更多...
一文说清楚ETL与Kafka如何实现集成

一文说清楚ETL与Kafka如何实现集成

ETL与Kafka为何需要集成? 随着企业对实时流数据的处理要求越来越高&#xff0c;很多企业都把实时流数(日志、实时CDC采集数据、设备数据…)先推入到kafka中&#xff0c;再通过ETL对kafka中的数据进行消费通过ETL强大的数据的转换、清洗功能来进行数据的集成与分发。 实时数据…
阅读更多...
table表格，让thead固定，tbody内容滚动，关键是都对齐的纯css写法

table表格，让thead固定，tbody内容滚动，关键是都对齐的纯css写法

前言&#xff1a;哈喽&#xff0c;大家好&#xff0c;今天给大家分享今天给大家分享一篇文章&#xff01;并提供具体代码帮助大家深入理解&#xff0c;彻底掌握&#xff01;创作不易&#xff0c;如果能帮助到大家或者给大家一些灵感和启发&#xff0c;欢迎收藏关注哦 &#x1f…
阅读更多...
地信、测绘、遥感、地质相关岗位招聘汇总

地信、测绘、遥感、地质相关岗位招聘汇总

3s等相关专业25秋招&提前批招聘信息 该岗位信息表&#xff0c;覆盖全国各大省市&#xff0c;招聘岗位主要针对地信、测绘、地质、遥感、城规等专业。 1800WebGIS开发岗位汇总表 该信息表&#xff0c;主要是WebGIS开发岗为主&#xff0c;岗位要求熟悉熟悉Openlayers&#…
阅读更多...
【C++篇】~类和对象（中）

【C++篇】~类和对象（中）

类和对象&#xff08;中&#xff09; 1.类的默认成员函数​ 默认成员函数就是用户没有显式实现&#xff0c;编译器会自动生成的成员函数称为默认成员函数。一个类&#xff0c;我们不写的情况下编译器会默认生成以下6个默认成员函数&#xff0c;需要注意的是这6个中最重要的是前…
阅读更多...
YOLOv8改进系列，YOLOv8替换主干网络为PP-HGNetV2(百度飞桨视觉团队自研，助力涨点)

YOLOv8改进系列，YOLOv8替换主干网络为PP-HGNetV2(百度飞桨视觉团队自研，助力涨点)

摘要 PP-HGNetV2(High Performance GPU Network V2) 是百度飞桨视觉团队自研的 PP-HGNet 的下一代版本，其在 PP-HGNet 的基础上，做了进一步优化和改进，最终在 NVIDIA GPU 设备上，将 “Accuracy-Latency Balance” 做到了极致，精度大幅超过了其他同样推理速度的模型。其在…
阅读更多...
远程桌面连接工具Microsoft Remote Desktop Beta for Mac

远程桌面连接工具Microsoft Remote Desktop Beta for Mac

Microsoft Remote Desktop Beta for Mac 是一款功能强大的远程桌面连接工具&#xff0c;具有以下功能特点&#xff1a; 软件下载地址 跨平台连接&#xff1a; 允许 Mac 用户轻松连接到运行 Windows 操作系统的计算机&#xff0c;打破了操作系统的界限&#xff0c;无论这些 Wi…
阅读更多...
什么是HTTP DDOS，如何防护

什么是HTTP DDOS，如何防护

在当今高度互联的网络世界中&#xff0c;网络安全威胁日益严峻&#xff0c;其中HTTP DDoS&#xff08;Distributed Denial of Service&#xff0c;分布式拒绝服务&#xff09;攻击作为一种常见的网络攻击手段&#xff0c;给企业和个人用户带来了巨大的挑战。今天我们就来详细介…
阅读更多...
计算机四级-计算机网络

计算机四级-计算机网络

一、基础知识 1.对计算机网络发展具有重要影响的广域网是&#xff1a;ARPANET 随机争用型的介质访问控制方法起源于&#xff1a;ALOHANET 2.计算机网络发展阶段&#xff1a; A&#xff09;第一阶段的主要成果是计算机技术与通信技术的结合 B&#xff09;第二阶段的主要成果…
阅读更多...
ZYNQ FPGA自学笔记~操作PLL

ZYNQ FPGA自学笔记~操作PLL

一 时钟缓冲器、管理和路由 垂直时钟中心&#xff08;clock backbone&#xff09;将设备分为相邻的左侧和右侧区域&#xff0c;水平中心线将设备分为顶部和底部两侧。clock backbone中的资源镜像到水平相邻区域的两侧&#xff0c;从而将某些时钟资源扩展到水平相邻区域。BUFG不…
阅读更多...
一、RTOS入门

一、RTOS入门

目录 一、裸机与RTOS介绍 1、裸机 2、 RTOS 二、FreeRTOS简介 1、FreeRTOS 特点 2、关于FreeRTOS学习资料 一、裸机与RTOS介绍 1、裸机 简介&#xff1a;裸机又称为前后台系统&#xff0c;前台系统指的中断服务函数&#xff0c;后台系统指的大循环&#xff08;While循环…
阅读更多...
基于PHP的新闻管理系统

基于PHP的新闻管理系统

作者&#xff1a;计算机学姐 开发技术&#xff1a;SpringBoot、SSM、Vue、MySQL、JSP、ElementUI、Python、小程序等&#xff0c;“文末源码”。 专栏推荐&#xff1a;前后端分离项目源码、SpringBoot项目源码、SSM项目源码 系统展示 【2025最新】基于phpMySQL的新闻管理系统。…
阅读更多...
数据结构—(java)反射，枚举，lambda表达式

数据结构—(java)反射，枚举，lambda表达式

文章目录 反射反射的定义&#xff1a;反射相关的类&#xff1a;反射相关的方法&#xff1a;反射示例&#xff1a;获取Class类对象创建指定类的对象反射私有属性&#xff1a;反射私有方法&#xff1a;反射私有的构造方法 枚举枚举的意义枚举类的实现枚举类的使用&#xff1a;Enu…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023