Skip to content

Commit

Permalink
refactor(projects): import cz-git, czg replace @soybeanjs/cli [引入cz-g…
Browse files Browse the repository at this point in the history
…it、czg替换@soybeanjs/cli]
  • Loading branch information
honghuangdc committed Nov 8, 2022
1 parent a9d58f8 commit 1bdd81a
Show file tree
Hide file tree
Showing 4 changed files with 442 additions and 130 deletions.
2 changes: 1 addition & 1 deletion .husky/commit-msg
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

pnpm soybean git-commit-verify
npx --no-install commitlint --edit "$1"
99 changes: 99 additions & 0 deletions commitlint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
/** @type {import('cz-git').UserConfig} */
module.exports = {
rules: {
'body-leading-blank': [1, 'always'],
'body-max-line-length': [2, 'always', 100],
'footer-leading-blank': [1, 'always'],
'footer-max-line-length': [2, 'always', 100],
'header-max-length': [2, 'always', 100],
'subject-case': [2, 'never', ['sentence-case', 'start-case', 'pascal-case', 'upper-case']],
'subject-empty': [2, 'never'],
'subject-full-stop': [2, 'never', '.'],
'type-case': [2, 'always', 'lower-case'],
'type-empty': [2, 'never'],
'type-enum': [
2,
'always',
['build', 'chore', 'ci', 'docs', 'feat', 'fix', 'perf', 'refactor', 'revert', 'style', 'test']
]
},
prompt: {
alias: { fd: 'docs: fix typos' },
messages: {
type: '选择你要提交的类型 :',
scope: '选择一个提交范围(可选):',
customScope: '请输入自定义的提交范围 :',
subject: '填写简短精炼的变更描述 :\n',
body: '填写更加详细的变更描述(可选)。使用 "|" 换行 :\n',
breaking: '列举非兼容性重大的变更(可选)。使用 "|" 换行 :\n',
footerPrefixsSelect: '选择关联issue前缀(可选):',
customFooterPrefixs: '输入自定义issue前缀 :',
footer: '列举关联issue (可选) 例如: #31, #I3244 :\n',
confirmCommit: '是否提交或修改commit ?'
},
types: [
{ value: 'init', name: 'init: 初始化' },
{ value: 'feat', name: 'feat: 新增功能' },
{ value: 'fix', name: 'fix: 修复缺陷' },
{ value: 'docs', name: 'docs: 文档更新' },
{ value: 'style', name: 'style: 代码格式' },
{ value: 'refactor', name: 'refactor: 代码重构' },
{ value: 'perf', name: 'perf: 性能提升' },
{ value: 'test', name: 'test: 测试相关' },
{ value: 'build', name: 'build: 构建相关' },
{ value: 'ci', name: 'ci: 持续集成' },
{ value: 'revert', name: 'revert: 回退代码' },
{ value: 'chore', name: 'chore: 其他修改' }
],
useEmoji: false,
emojiAlign: 'center',
themeColorCode: '',
scopes: [
['projects', '项目搭建'],
['components', '组件相关'],
['hooks', 'hook 相关'],
['utils', 'utils 相关'],
['types', 'ts类型相关'],
['styles', '样式相关'],
['deps', '项目依赖'],
['auth', '对 auth 修改'],
['release', '版本发布'],
['other', '其他修改']
].map(([value, description]) => {
return {
value,
name: `${value.padEnd(30)} (${description})`
};
}),
allowCustomScopes: true,
allowEmptyScopes: true,
customScopesAlign: 'bottom',
customScopesAlias: 'custom',
emptyScopesAlias: 'empty',
upperCaseSubject: false,
markBreakingChangeMode: false,
allowBreakingChanges: ['feat', 'fix'],
breaklineNumber: 100,
breaklineChar: '|',
skipQuestions: [],
issuePrefixs: [
// 如果使用 gitee 作为开发管理
{ value: 'link', name: 'link: 链接 ISSUES 进行中' },
{ value: 'closed', name: 'closed: 标记 ISSUES 已完成' }
],
customIssuePrefixsAlign: 'top',
emptyIssuePrefixsAlias: 'skip',
customIssuePrefixsAlias: 'custom',
allowCustomIssuePrefixs: true,
allowEmptyIssuePrefixs: true,
confirmColorize: true,
maxHeaderLength: Infinity,
maxSubjectLength: Infinity,
minSubjectLength: 0,
scopeOverrides: undefined,
defaultBody: '',
defaultIssues: '',
defaultScope: '',
defaultSubject: ''
}
};
8 changes: 5 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@
"preview": "vite preview",
"typecheck": "vue-tsc --noEmit --skipLibCheck",
"lint": "eslint . --fix",
"commit": "soybean git-commit",
"commit": "czg",
"cz": "czg",
"esno": "esno",
"cleanup": "esno ./scripts/cleanup.ts",
"update-pkg": "ncu --deep -u",
Expand Down Expand Up @@ -86,9 +87,7 @@
"@amap/amap-jsapi-types": "^0.0.10",
"@iconify/json": "^2.1.133",
"@iconify/vue": "^4.0.0",
"@soybeanjs/cli": "^0.1.2",
"@soybeanjs/router-page": "1.0.3",
"@tauri-apps/cli": "^1.1.1",
"@types/bmapgl": "^0.0.5",
"@types/crypto-js": "^4.1.1",
"@types/node": "18.8.3",
Expand All @@ -98,8 +97,11 @@
"@unocss/vite": "^0.46.3",
"@vitejs/plugin-vue": "^3.2.0",
"@vitejs/plugin-vue-jsx": "^2.1.0",
"commitlint": "^17.2.0",
"conventional-changelog": "^3.1.25",
"cross-env": "^7.0.3",
"cz-git": "^1.3.12",
"czg": "^1.3.12",
"eslint": "^8.27.0",
"eslint-config-soybeanjs-vue": "^0.1.2",
"esno": "^0.16.3",
Expand Down
Loading

1 comment on commit 1bdd81a

@vercel
Copy link

@vercel vercel bot commented on 1bdd81a Nov 8, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.