git提交增加hooks

GUIRH
149 阅读2分钟

git常用命令

git branch 查看本地所有分支

git status 查看当前状态

git commit 提交

git branch -a 查看所有的分支

git branch -r 查看远程所有分支

git commit -am "init" 提交并且加注释

git remote add origin git@192.168.1.119:ndshow 关联一个远程库

git push origin master 将文件给推到服务器上

git remote show origin 显示远程库origin里的资源

git push origin master:develop 将本地develop分支提交到远程master分支

git push origin master:hb-dev 将本地库与服务器上的库进行关联

git checkout --track origin/dev 切换到远程dev分支

git branch -D master develop 删除本地库develop

git checkout -b dev 建立一个新的本地分支dev

git merge origin/dev 将分支dev与当前分支进行合并

git checkout dev 切换到本地dev分支

git remote show 查看远程库

git add . 添加所有文件到暂存区

git rm 文件名(包括路径) 从git中删除指定文件

git clone git://github.com/schacon/grit.git 从服务器上将代码给拉下来

git config --list 看所有用户git ls-files 看已经被提交的

git rm [file name] 删除一个文件

git commit -a 提交当前repos的所有的改变

git add [file name] 添加一个文件到git index

git commit -v 当你用－v参数的时候可以看commit的差异

git commit -m "This is the message describing the commit" 添加commit信息

git commit -a -a是代表add，把所有的change加到git index里然后再commitgit commit -a -v 一般提交命令

git log 看你commit的日志

git diff 查看尚未暂存的更新

git rm a.a 移除文件(从暂存区和工作区中删除)

git rm --cached a.a 移除文件(只从暂存区中删除)

git commit -m "remove" 移除文件(从Git中删除)

git rm -f a.a 强行移除修改后文件(从暂存区和工作区中删除)

git diff --cached 或 $ git diff --staged 查看尚未提交的更新

git stash push 将文件给push到一个临时空间中

git stash pop 将文件从临时空间pop下来

git协同工作

master：主干分支，用于发布环境，记录正式发布版本，release分支测试确定没有问题后即可合并发布。

develop：开发分支，用于开发功能(大模块)，develop分支自测达到可以发布的状态时创建release分支。

feature：功能分支，用于开发功能(大模块分的小功能，开发人员独立开发)，一旦feature分支上的功能开发完成，就合并到develop分支上，合并完成后就删除feature分支。

release：预发布分支，用于上线前做的一些准备工作(全面测试、文档更新等)，没问题就合并到master和develop分支，合并完成后就删除release分支。

hotfix：热修复分支，用于处理已发布版本的bug，当用户在使用过程中遇到了bug，基于master分支创建hotfix分支用于维护，把改动的代码合并到master和develop分支上，合并完成删除hotfix上的分支。

hotfix基于master创建分支。

feature、release基于develop创建分支。

master允许来自release和hotfix分支的合并。

develop允许来自feature、release和hotfix分支的合并。

git协同工作命令

1、创建文件

2、git clone xxx 克隆项目

3、git checkout -b develop 创建空白分支并切换到develop分支

4、git push --set-upstream origin develop 提交分支到服务器上

5、基于develop创建feature功能分支

  • git checkout develop 切换到develop分支上
  • git checkout -b feature/one 基于develop创建功能分支，并切换到feature/one分支
  • 开发功能
  • 功能已完成，提交代码(git add . \git commit)
  • git pull origin develop 拉取远程develop分支，确保develop分支为最新的
  • git checkout develop
  • git merge --no-ff feature/one #合并分支到develop分支上
  • git push --set-upstream origin feature/one
  • git branch -d feature/one 删除本地分支 ，如果在服务器上有这个分支，则需要执行以下命令 git push origin --delete feature/FEATURE-01

6、基于develop创建release分支

  • git checkout develop 切换到develop分支上
  • git checkout -b release/v1.0.0
  • 测试有问题->修复测试问题->git add .->git commit -m 'fix:修改bug'->git push --set-upstream origin release/v1.0.0 并合并 //提交修复bug的代码
  • 没有问题，合并到master、develop分支
    • 合并到master
      • git checkout master 切换到master分支
      • git merge --no-ff release/v1.0.0 合并到master
      • git push
    • 合并到develop
      • git checkout develop 切换到develop分支
      • git merge --no-ff release/v1.0.0 合并到develop
      • git push
  • git branch -d release/v1.0.0 合并完成后删除release分支

7、发布打标签

  • git tag -a v1.0.0 -m "版本1.0.0" master
  • git push --tags

8、基于master创建hotfix分支

  • git cheakout master
  • git checkout -b hotfix/v.1.0.0 创建hotfix分支
  • 修复bug
  • bug修复完成，上传代码 ->git add .->git commit -m 'fix:修改bug'->git push --set-upstream origin hotfix/v.1.0.0 并合并 //提交修复bug的代码
  • 没有问题，合并到master、develop分支
    • 合并到master
      • git checkout master 切换到master分支
      • git merge --no-ff hotfix/v1.0.0 合并hotfix到master
      • git tab v1.0.1 修复bug打标签
      • git push
      • git push origin v1.0.1 提交到正式版本1.0.1上
    • 合并到develop
      • git checkout develop 切换到develop分支
      • git merge --no-ff hotfix/v1.0.0 合并hotfix到develop
      • git push
  • git branch -d hotfix/v1.0.0 合并完成后删除hotfix分支

代码格式规范

ESLint+Prettier+VSCode配置，保存代码时，自动格式化代码格式。

1、ESLint(插件化的javascript代码检测工具)

不符合规范的代码格式会报错

如何解决：

  • 按照ESLint的要求修改代码
  • 修改ESLint的 验证规则（.eslintrc.js文件中 ）
    • "quotes": "error" // 默认
    • "quotes": "warn" // 修改为警告
    • "quotes": "off" // 修改不校验

2、prettier（代码格式化工具），保存自动符合ESLint标准

  • 安装prettier插件
  • 新建.prettierrc文件
  • 如下配置
{ // 不尾随分号 "semi": false, // 使用单引号 "singleQuote": true, // 多行逗号分割的语法中，最后一行不加逗号 "trailingComma": "none" }
  • 设置里面找到Format On Save点击保存
  • 多个格式化工具时，右键选择格式化，选择prettier保存即可

3、解决prettier和ESLint冲突

  • 打开.eslitrc.js配置文件
  • 在rules规则下，新增一条规则 如： 'space-before-function-paren': 'off' （方法名后增加空格）

git提交规范

  1. 约定式提交规范
  2. commitizen：git 提交规范化工具
  3. commitlint：用于检查提交信息
  4. pre-commit： git hooks 钩子
  5. lint-staged：只检查本次修改更新的代码，并在出现错误的时候，自动修复并且推送

1、提交规范：

<类型>: <描述>

类型(必选)：

  • 新功能：feat
  • 修复：fix
  • 文档变更：docs
  • 代码格式(不影响代码运行的变动) ：style
  • 重构(既不是增加feature，也不是修复bug)：refactor
  • 性能优化：perf
  • 增加测试：test
  • 构建过程或辅助工具的变动：chore
  • 回退：revert
  • 打包：build

2、Commitizen规范化提交代码：

步骤：

  • 全局安装Commitizen npm install -g commitizen@4.2.4
  • 安装并配置cz-customizable 插件
    • 使用 npm下载cz-customizable npm i cz-customizable@6.3.0 --save-dev
    • 添加以下配置到 package.json 中
"config": { "commitizen": { "path": "node_modules/cz-customizable" } }
    • 项目根目录下创建 .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 }
    • 使用 git cz 代替 git commit，即可看到提示内容 

3、什么是 Git Hooks

git 在执行某个事件之前或之后进行一些其他额外的操作，需要阻止不合规的提交消息，需要用到hooks的钩子函数。

4、使用 husky + commitlint 检查提交git描述是否符合规范要求

  • commitlint：用于检查提交信息
    • 安装依赖：npm install --save-dev @commitlint/config-conventional@12.1.4 @commitlint/cli@12.1.4
    • 创建commitlint.config.js 文件，添加配置项
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格式，vscode右下角有。
  • 、husky：是git hooks工具
    • 安装依赖：npm install husky@7.0.1 --save-dev
    • 启动 hooks，根目录下生成 .husky 文件夹 npx husky install
    • 在 package.json 中生成  prepare 指令（ 需要 npm > 7.0 版本 ） npm set-script prepare "husky install"
    • 执行 prepare 指令 npm run prepare
    • 执行成功

image.png

    • 添加 commitlint 的 hook 到 husky中，并指令在 commit-msg 的 hooks 下执行 npx --no-install commitlint --edit "1" 指令npxhuskyadd.husky/commit−msg′npx−−no−installcommitlint−−edit"1" 指令 npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "1"'

image.png

    • 不符合规范的commit将不可提交。

5、通过pre-commit检测提交时代码规范

  • 执行 npx husky add .husky/pre-commit "npx eslint --ext .js,.vue src" 添加 commit 时的 hook （npx eslint --ext .js,.vue src 会在执行到该 hook 时运行）
  • 该操作会生成对应文件 pre-commit

image.png image.png

  • 关闭 VSCode 的自动保存操作
  • 修改一处代码，使其不符合 ESLint 校验规则
  • 执行 提交操作 会发现，抛出一系列的错误，代码无法提交
  • 想要提交代码，必须处理完成所有的错误信息

6、lint-staged自动修复代码规范错误

lint-staged只检查本次更新的代码，并在出现错误的时候，自动修复并且推送。

  • 修改 package.json 配置
"lint-staged": { "src/**/*.{js,vue}": [ "eslint --fix", "git add" ] }
  • 本地commit之前，校验提交的内容是否符合本地配置的eslint
    • 如果符合规则：则会提交成功。
    • 如果不符合规则：它会自动执行 eslint --fix 尝试帮你自动修复，如果修复成功则会帮你把修复好的代码提交，如果失败，则会提示你错误，让你修好这个错误之后才能允许你提交代码。
  • 修改 .husky/pre-commit 文件
#!/bin/sh . "$(dirname "$0")/_/husky.sh" npx lint-staged //原npx eslint --ext .js,.vue src
  • 再次执行提交代码
  • 发现 暂存区中 不符合 ESlint 的内容，被自动修复
avatar
文章
阅读
粉丝