feat: add commitlint #33

README.md

@@ -144,11 +144,6 @@ Install dependencies
 yarn install
 ```
 
-Enable `simple-git-hooks`
-```bash
-yarn dlx simple-git-hooks
-```
-
 Serve the demo page
 ```bash
 yarn dev

commitlint.config.ts

@@ -0,0 +1,7 @@
+import type { UserConfig } from '@commitlint/types'
+
+const Configuration: UserConfig = {
+  extends: ['@commitlint/config-conventional'],
+}
+
+export default Configuration

package.json

@@ -34,6 +34,7 @@
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "preversion": "yarn build",
+    "prepare": "simple-git-hooks",
     "preview": "vite preview",
     "test": "vitest"
   },
@@ -44,13 +45,16 @@
   },
   "devDependencies": {
     "@antfu/eslint-config": "^3.9.2",
+    "@commitlint/cli": "^19.6.0",
+    "@commitlint/config-conventional": "^19.6.0",
     "eslint": "^9.15.0",
     "lint-staged": "^15.2.10",
     "simple-git-hooks": "^2.11.1",
     "typescript": "^5.6.2",
     "vite": "^5.4.4"
   },
   "simple-git-hooks": {
+    "commit-msg": "yarn dlx commitlint --edit $1",
     "pre-commit": "yarn dlx lint-staged",
     "preserveUnused": true
   },