chore: add commit lint and script

This commit is contained in:
MrWindlike 2022-05-20 11:36:44 +08:00
parent c33a3ffbcb
commit ccad1f4fe2
7 changed files with 2324 additions and 1455 deletions

63
.cz-config.js Normal file
View File

@ -0,0 +1,63 @@
module.exports = {
// types,
types: [
{
value: 'feat',
name: '✨ A new feature',
},
{
value: 'fix',
name: '🐛 A bug fix',
},
{
value: 'docs',
name: '📝 Documentation only changes',
},
{
value: 'style',
name: '💄 Updating the UI and style files.',
},
{
value: 'test',
name: '🧪 Adding or changing the tests.',
},
{
value: 'refactor',
name: '🔨 A code change that neither fixes a bug nor adds a feature.',
},
{
value: 'chore',
name: '🚧 Updating grunt tasks etc; no production code change.',
},
{
value: 'pref',
name: '⚡️ Improving the performance.',
},
{
value: 'build',
name: '📦️ Building stuff.',
}
],
scopes: [],
scopeOverrides: {
':wrench: docs': [{ name: ':wrench: docs' }, { name: ':bulb: docs_code' }],
},
// override the messages, defaults are as follows
messages: {
type: "Select the type of change that you're committing:",
scope: '\nDenote the SCOPE of this change (optional):',
// used if allowCustomScopes is true
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):\n',
footer: 'List any ISSUES CLOSED by this change (optional). E.g.: #31, #34:\n',
confirmCommit: 'Are you sure you want to proceed with the commit above?',
},
allowCustomScopes: false,
allowBreakingChanges: ['feat', 'fix'],
};

1
.czrc Normal file
View File

@ -0,0 +1 @@
{ "path": "cz-customizable" }

1
.husky/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
_

4
.husky/commit-msg Executable file
View File

@ -0,0 +1,4 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"
npx --no -- commitlint --edit "${1}"

1
commitlint.config.js Normal file
View File

@ -0,0 +1 @@
module.exports = {extends: ['@commitlint/config-conventional']}

View File

@ -8,11 +8,17 @@
"lint": "eslint packages --ext .ts --ext .tsx",
"fix-lint": "eslint --fix packages --ext .ts --ext .tsx",
"release": "lerna publish",
"release:canary": "branch=$(git rev-parse --abbrev-ref HEAD); lerna publish --canary --preid $branch"
"release:canary": "branch=$(git rev-parse --abbrev-ref HEAD); lerna publish --canary --preid $branch",
"commit": "git cz",
"prepare": "husky install"
},
"devDependencies": {
"@commitlint/cli": "^17.0.0",
"@commitlint/config-conventional": "^17.0.0",
"@typescript-eslint/eslint-plugin": "^4.31.1",
"@typescript-eslint/parser": "^4.31.1",
"commitizen": "^4.0.4",
"cz-customizable": "^6.2.0",
"eslint": "^7.32.0",
"eslint-config-prettier": "^8.3.0",
"eslint-config-standard": "^16.0.3",
@ -30,7 +36,8 @@
],
"husky": {
"hooks": {
"pre-commit": "lint-staged"
"pre-commit": "lint-staged",
"commit-msg": "commitlint --edit $1"
}
},
"lint-staged": {

3698
yarn.lock

File diff suppressed because it is too large Load Diff