build: add conventional commits pre-commit (#70)

Adds a husky pre-commit according to the conventional commits specification to ensure git commits follow a given standard.

Closes #31

Author: christopher-buss

.husky/commit-msg

@@ -0,0 +1 @@
+pnpm commitlint \

commitlint.config.ts

@@ -0,0 +1,16 @@
+/* eslint-disable ts/no-magic-numbers -- Ignore magic numbers for RuleConfigSeverity. */
+import { RuleConfigSeverity, type UserConfig } from "@commitlint/types";
+
+const Configuration: UserConfig = {
+	extends: ["@commitlint/config-conventional"],
+	rules: {
+		"header-max-length": [RuleConfigSeverity.Error, "always", 72],
+		"scope-enum": [
+			RuleConfigSeverity.Error,
+			"always",
+			["core", "deps", "dev", "lint", "ui", "audio", "assets"],
+		],
+	},
+};
+
+export default Configuration;

package.json

@@ -19,7 +19,8 @@
 		"eslint-config": "npx @eslint/config-inspector",
 		"lint": "eslint --max-warnings 0 .",
 		"upload-assets": "asphalt sync && eslint src/shared/assets.d.ts --fix",
-		"prepare": "node .husky/install.js"
+		"prepare": "node .husky/install.js",
+		"commit": "commit"
 	},
 	"dependencies": {
 		"@flamework/components": "1.2.3",
@@ -52,6 +53,10 @@
 		"rbxts-transform-env": "2.2.0"
 	},
 	"devDependencies": {
+		"@commitlint/cli": "^19.3.0",
+		"@commitlint/config-conventional": "^19.2.2",
+		"@commitlint/prompt-cli": "^19.3.1",
+		"@commitlint/types": "^19.0.3",
 		"@eslint-react/eslint-plugin": "1.5.16",
 		"@eslint/config-inspector": "0.4.11",
 		"@isentinel/eslint-config": "0.6.1",