检查项目 需要有.git文件夹
安装依赖 husky
husky是Git hooks 工具，可以防止使用 Git hooks 的一些不好的 commit 或者 push。）
#安装husky 依赖
npm install husky --save-dev
#启用 Git 挂钩
npx husky install
#自动启用hooks
npm set-script prepare "husky install"
#添加 commit-msg 钩子
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'
安装@commitlint/config-conventional @commitlint/cli ， commit 校验工具
npm install --save-dev @commitlint/config-conventional @commitlint/cli
生成配置文件commitlint.config.js
echo "module.exports = {extends: ['@commitlint/config-conventional']};" > commitlint.config.js
commitlint.config.js配置项<仅作参考>（官方文档：https://commitlint.js.org/#/）
// @see: https://cz-git.qbenben.com/zh/guide
/** @type {import('cz-git').UserConfig} */
module.exports = {
ignores: [(commit) => commit.includes("init")],
extends: ["@commitlint/config-conventional"],
rules: {
// @see: https://commitlint.js.org/#/reference-rules
"body-leading-blank": [2, "always"],
"footer-leading-blank": [1, "always"],
"header-max-length": [2, "always", 108],
"subject-empty": [2, "never"],
"type-empty": [2, "never"],
"subject-case": [0],
"type-enum": [
2,
"always",
[
"feat",
"fix",
"docs",
"style",
"refactor",
"perf",
"test",
"build",
"ci",
"chore",
"revert",
"wip",
"workflow",
"types",
"release",
],
],
},
prompt: {
messages: {
type: "Select the type of change that you're committing:",
scope: "Denote the SCOPE of this change (optional):",
customScope: "Denote the SCOPE of this change:",
subject: "Write a SHORT, IMPERATIVE tense description of the change:\n",
body: 'Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
breaking:
'List any BREAKING CHANGES (optional). Use "|" to break new line:\n',
footerPrefixsSelect:
"Select the ISSUES type of changeList by this change (optional):",
customFooterPrefixs: "Input ISSUES prefix:",
footer: "List any ISSUES by this change. E.g.: #31, #34:\n",
confirmCommit: "Are you sure you want to proceed with the commit above?",
// 中文版
// type: "选择你要提交的类型 :",
// scope: "选择一个提交范围（可选）:",
// customScope: "请输入自定义的提交范围 :",
// subject: "填写简短精炼的变更描述 :\n",
// body: '填写更加详细的变更描述（可选）。使用 "|" 换行 :\n',
// breaking: '列举非兼容性重大的变更（可选）。使用 "|" 换行 :\n',
// footerPrefixsSelect: "选择关联issue前缀（可选）:",
// customFooterPrefixs: "输入自定义issue前缀 :",
// footer: "列举关联issue (可选) 例如: #31, #I3244 :\n",
// confirmCommit: "是否提交或修改commit ?"
},
types: [
{
value: "feat",
name: "feat: A new feature",
emoji: "",
},
{
value: "fix",
name: "fix: A bug fix",
emoji: "",
},
{
value: "docs",
name: "docs: Documentation only changes",
emoji: "",
},
{
value: "style",
name: "style: Changes that do not affect the meaning of the code",
emoji: "",
},
{
value: "refactor",
name: "refactor: ♻️ A code change that neither fixes a bug nor adds a feature",
emoji: "♻️",
},
{
value: "perf",
name: "perf: ⚡️ A code change that improves performance",
emoji: "⚡️",
},
{
value: "test",
name: "test: ✅ Adding missing tests or correcting existing tests",
emoji: "✅",
},
{
value: "build",
name: "build: ️ Changes that affect the build system or external dependencies",
emoji: "️",
},
{
value: "ci",
name: "ci: Changes to our CI configuration files and scripts",
emoji: "",
},
{
value: "chore",
name: "chore: Other changes that don't modify src or test files",
emoji: "",
},
{
value: "revert",
name: "revert: ⏪️ Reverts a previous commit",
emoji: "⏪️",
},
// 中文版
// { value: "特性", name: "特性: 新增功能", emoji: "" },
// { value: "修复", name: "修复: 修复缺陷", emoji: "" },
// { value: "文档", name: "文档: 文档变更", emoji: "" },
// { value: "格式", name: "格式: 代码格式（不影响功能，例如空格、分号等格式修正）", emoji: "" },
// { value: "重构", name: "重构: ♻️ 代码重构（不包括 bug 修复、功能新增）", emoji: "♻️" },
// { value: "性能", name: "性能: ⚡️ 性能优化", emoji: "⚡️" },
// { value: "测试", name: "测试: ✅ 添加疏漏测试或已有测试改动", emoji: "✅" },
// { value: "构建", name: "构建: ️ 构建流程、外部依赖变更（如升级 npm 包、修改 webpack 配置等）", emoji: "️" },
// { value: "集成", name: "集成: 修改 CI 配置、脚本", emoji: "" },
// { value: "回退", name: "回退: ⏪️ 回滚 commit", emoji: "⏪️" },
// { value: "其他", name: "其他: 对构建过程或辅助工具和库的更改（不影响源文件、测试用例）", emoji: "" }
],
useEmoji: true,
themeColorCode: "",
scopes: [],
allowCustomScopes: true,
allowEmptyScopes: true,
customScopesAlign: "bottom",
customScopesAlias: "custom",
emptyScopesAlias: "empty",
upperCaseSubject: false,
allowBreakingChanges: ["feat", "fix"],
breaklineNumber: 100,
breaklineChar: "|",
skipQuestions: [],
issuePrefixs: [
{ value: "closed", name: "closed: ISSUES has been processed" },
],
customIssuePrefixsAlign: "top",
emptyIssuePrefixsAlias: "skip",
customIssuePrefixsAlias: "custom",
allowCustomIssuePrefixs: true,
allowEmptyIssuePrefixs: true,
confirmColorize: true,
maxHeaderLength: Infinity,
maxSubjectLength: Infinity,
minSubjectLength: 0,
scopeOverrides: undefined,
defaultBody: "",
defaultIssues: "",
defaultScope: "",
defaultSubject: "",
},
};
注意该文件编码需要时 utf-8
vscode git 命令
克隆项目命令
git clone XXXXXX.git
把修改的文件添加到本地git缓存区。
git add . 或者 git add dir/filename # 添加指定文件命令可以
注意：git add . (后面有个点)表示添加目录下所有文件到本地git缓存区。
提交代码命令（-m 必须的 表示添加提交信息）
git commit -m [optional scope]:
如：
git commit -m 'feat: 增加 xxx 功能'
更新本地代码
git pull origin master # master 可以更换为其他分支
推送代码到远程
git push -u origin master # master可以更换为其他分支
创建切换分支
#切换分支
git checkout master
#创建并切换到develop分支
git checkout -b develop
合并其他分支
#1.切换到master分支
#2.合并develop分支代码到master分支
git merge develop
查看代码提交历史
#查看所有历史
git log
#查看指定文件提交历史
git log filePath(如：src\utils\is\index.ts)
代码回滚（可参考博客：https://www.cnblogs.com/Jeffxu/p/16375957.html）
image.png
根据回滚版本所对应的 commit SHA-1值(commit后面的一串数字)来进行回滚操作:
git reset --hard b432f748cffe8
或
git revert b432f748cffe8
区别：
git revert 只回退到上一个版本
git reset 回退到指定版本 该版本后代码都将丢失