檢查項目 需要有.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: "選擇關(guān)聯(lián)issue前綴(可選):",
// customFooterPrefixs: "輸入自定義issue前綴 :",
// footer: "列舉關(guān)聯(lián)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: "重構(gòu)", name: "重構(gòu): ?? 代碼重構(gòu)(不包括 bug 修復扎酷、功能新增)", emoji: "??" },
// { value: "性能", name: "性能: ?? 性能優(yōu)化", emoji: "??" },
// { value: "測試", name: "測試: ? 添加疏漏測試或已有測試改動", emoji: "?" },
// { value: "構(gòu)建", name: "構(gòu)建: ??? 構(gòu)建流程、外部依賴變更(如升級 npm 包遏匆、修改 webpack 配置等)", emoji: "???" },
// { value: "集成", name: "集成: ?? 修改 CI 配置法挨、腳本", emoji: "??" },
// { value: "回退", name: "回退: ?? 回滾 commit", emoji: "??" },
// { value: "其他", name: "其他: ?? 對構(gòu)建過程或輔助工具和庫的更改(不影響源文件、測試用例)", 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緩存區(qū)幅聘。
git add . 或者 git add dir/filename # 添加指定文件命令可以
注意:git add . (后面有個點)表示添加目錄下所有文件到本地git緩存區(qū)凡纳。
提交代碼命令(-m 必須的 表示添加提交信息)
git commit -m <type>[optional scope]: <description>
如:
git commit -m 'feat: 增加 xxx 功能'
更新本地代碼
git pull origin master # master 可以更換為其他分支
推送代碼到遠程
git push -u origin master # master可以更換為其他分支
創(chuàng)建切換分支
#切換分支
git checkout master
#創(chuàng)建并切換到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)
根據(jù)回滾版本所對應(yīng)的 commit SHA-1值(commit后面的一串數(shù)字)來進行回滾操作:
git reset --hard b432f748cffe8
或
git revert b432f748cffe8
區(qū)別:
git revert 只回退到上一個版本
git reset 回退到指定版本 該版本后代碼都將丟失