feat(ts): introduce conventional commit check

x-pt · Aug 31, 2024 · ae1639f · ae1639f
1 parent b5a0558
commit ae1639f
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 4 deletions.
diff --git a/template/ts/{{cookiecutter.project_slug}}/.husky/commit-msg b/template/ts/{{cookiecutter.project_slug}}/.husky/commit-msg
@@ -0,0 +1 @@
+pnpx commitlint --edit $1
diff --git a/template/ts/{{cookiecutter.project_slug}}/.husky/pre-commit b/template/ts/{{cookiecutter.project_slug}}/.husky/pre-commit
@@ -1,2 +1,2 @@
-npm test
-npx lint-staged
+pnpm test
+pnpx lint-staged
diff --git a/template/ts/{{cookiecutter.project_slug}}/commitlint.config.ts b/template/ts/{{cookiecutter.project_slug}}/commitlint.config.ts
@@ -0,0 +1,7 @@
+import type { UserConfig } from "@commitlint/types";
+
+const Configuration: UserConfig = {
+    extends: ["@commitlint/config-conventional"],
+};
+
+export default Configuration;
diff --git a/template/ts/{{cookiecutter.project_slug}}/package.json b/template/ts/{{cookiecutter.project_slug}}/package.json
@@ -12,26 +12,37 @@
         "build": "tsc && ncc build lib/index.js",
         "test": "jest",
         "lint": "biome check --write --no-errors-on-unmatched --files-ignore-unknown=true",
-        "prepare": "husky"
+        "prepare": "husky",
+        "commit": "pnpx git-cz"
     },
     "dependencies": {
         "@actions/core": "^1.10.1",
         "@actions/github": "^6.0.0",
         "@types/node": "^22.5.1",
-        "axios": "^1.7.5",
+        "axios": "^1.7.6",
         "toml": "^3.0.0"
     },
     "devDependencies": {
         "@biomejs/biome": "1.8.3",
+        "@commitlint/cli": "^19.4.1",
+        "@commitlint/config-conventional": "^19.4.1",
+        "@commitlint/cz-commitlint": "^19.4.0",
+        "@commitlint/types": "^19.0.3",
         "@types/jest": "^29.5.12",
         "@vercel/ncc": "^0.38.1",
         "husky": "^9.1.5",
+        "inquirer": "^9.3.6",
         "jest": "^29.7.0",
         "lint-staged": "^15.2.9",
         "ts-jest": "^29.2.5",
         "typescript": "^5.5.4"
     },
     "lint-staged": {
         "*": ["biome check --write --no-errors-on-unmatched --files-ignore-unknown=true"]
+    },
+    "config": {
+        "commitizen": {
+            "path": "@commitlint/cz-commitlint"
+        }
     }
 }