feat: 🎸 add git-cz + husky + commitlint

add git-cz + husky + commitlint

.commitlintrc.js

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

.czrc

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

.husky/commit-msg

@@ -0,0 +1,10 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+# npm test
+# npx --no-install commitlint --edit "$1"
+npx commitlint --edit "${1}"
+
+# npx husky add .husky/commit-msg "npx --no-install commitlint -e $HUSKY_GIT_PARAMS"
+
+# npx --no-install commitlint -e $HUSKY_GIT_PARAMS

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged

.lintstagedrc

@@ -0,0 +1,6 @@
+{
+  "./**/*.{ts,js,tsx,jsx,vue}": [
+    "eslint --fix",
+    "git add ."
+  ]
+}

README.md

@@ -2,8 +2,23 @@
 
 monorepo-templates
 
+## eslint
+
 pnpm install -D -w eslint  typescript @typescript-eslint/eslint-plugin @typescript-eslint/parser vue-eslint-parser eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-vue
 
+## stylelint
+
+## git-cz + husky + commitlint
+
+```
+pnpm add -D -w git-cz
+pnpm add -D -w  @commitlint/cli @commitlint/config-conventional commitlint
+pnpm add -D -w husky lint-staged
+
+npx husky add .husky/commit-msg 'npx --no -- commitlint --edit "$1"'
+npx husky add .husky/pre-commit "pnpm run lint-staged"
+```
+
 ## 子模块的添加
 
 添加子模块非常简单，命令如下：

changelog.config.js

@@ -0,0 +1,70 @@
+module.exports = {
+  disableEmoji: false,
+  format: '{type}{scope}: {emoji}{subject}',
+  list: [ 'test', 'feat', 'fix', 'chore', 'docs', 'refactor', 'style', 'ci', 'perf' ],
+  maxMessageLength: 64,
+  minMessageLength: 3,
+  questions: [ 'type', 'scope', 'subject', 'body', 'breaking', 'issues', 'lerna' ],
+  scopes: [],
+  types: {
+    chore: {
+      description: 'Build process or auxiliary tool changes',
+      emoji: '🤖',
+      value: 'chore',
+    },
+    ci: {
+      description: 'CI related changes',
+      emoji: '🎡',
+      value: 'ci',
+    },
+    docs: {
+      description: 'Documentation only changes',
+      emoji: '✏️',
+      value: 'docs',
+    },
+    feat: {
+      description: 'A new feature',
+      emoji: '🎸',
+      value: 'feat',
+    },
+    fix: {
+      description: 'A bug fix',
+      emoji: '🐛',
+      value: 'fix',
+    },
+    perf: {
+      description: 'A code change that improves performance',
+      emoji: '⚡️',
+      value: 'perf',
+    },
+    refactor: {
+      description: 'A code change that neither fixes a bug or adds a feature',
+      emoji: '💡',
+      value: 'refactor',
+    },
+    release: {
+      description: 'Create a release commit',
+      emoji: '🏹',
+      value: 'release',
+    },
+    style: {
+      description: 'Markup, white-space, formatting, missing semi-colons...',
+      emoji: '💄',
+      value: 'style',
+    },
+    test: {
+      description: 'Adding missing tests',
+      emoji: '💍',
+      value: 'test',
+    },
+    messages: {
+      type: 'Select the type of change that you\'re committing:',
+      customScope: 'Select the scope this component affects:',
+      subject: 'Write a short, imperative mood description of the change:\n',
+      body: 'Provide a longer description of the change:\n ',
+      breaking: 'List any breaking changes:\n',
+      footer: 'Issues this commit closes, e.g #123:',
+      confirmCommit: 'The packages that this commit has affected\n',
+    },
+  },
+};

examples/react/vite.config.ts

@@ -1,7 +1,7 @@
-import { defineConfig } from 'vite'
-import react from '@vitejs/plugin-react'
+import { defineConfig } from 'vite';
+import react from '@vitejs/plugin-react';
 
 // https://vitejs.dev/config/
 export default defineConfig({
-  plugins: [react()]
-})
+  plugins: [ react() ],
+});

package.json

@@ -7,20 +7,30 @@
     "pnpm": ">=7"
   },
   "scripts": {
+    "prepare": "husky install",
     "commit": "git-cz",
+    "cz": "git-cz",
+    "eslint": "eslint . --ext .js,.jsx,.ts,.tsx,.vue",
     "dev:demo1": "cd projects/vite-project && pnpm install && pnpm dev",
     "pull": "git pull && cd .vscode && git pull && cd .. && cd config && git pull && cd .."
   },
   "devDependencies": {
+    "@commitlint/cli": "^17.1.2",
+    "@commitlint/config-conventional": "^17.1.0",
     "@typescript-eslint/eslint-plugin": "^5.38.1",
     "@typescript-eslint/parser": "^5.38.1",
+    "commitlint": "^17.1.2",
     "eslint": "^8.24.0",
     "eslint-plugin-jsx-a11y": "^6.6.1",
     "eslint-plugin-react": "^7.31.8",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-vue": "^9.5.1",
+    "git-cz": "^4.9.0",
+    "husky": "^8.0.1",
+    "lint-staged": "^13.0.3",
+    "react": "^18.2.0",
     "typescript": "^4.6.4",
     "vite": "^3.1.3",
     "vue-eslint-parser": "^9.1.0"
   }
-}
+}