build(package): Install git hook

Author: rizqyfahmi

.husky/commit-msg

@@ -0,0 +1 @@
+npx --no -- commitlint --edit $1

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged && npm run lint &&  npm run test && npm run build

commitlint.config.cjs

@@ -0,0 +1,14 @@
+const commitlintConfig = {
+    extends: ["@commitlint/config-conventional"],
+    rules: {
+        "type-enum": [
+            2,
+            "always",
+            ["feat", "fix", "build", "chore", "ci", "docs", "style", "refactor", "perf", "test"],
+        ],
+        "scope-empty": [2, "never"],
+        "subject-case": [2, "always", ["sentence-case"]],
+    },
+}
+
+module.exports = commitlintConfig

cz.config.cjs

@@ -0,0 +1,64 @@
+const { definePrompt } = require("cz-git")
+
+module.exports = definePrompt({
+    alias: { fd: "docs: fix typos" },
+    messages: {
+        type: "Select the type of change that you're committing:",
+        scope: "Denote the SCOPE of this change (optional):",
+        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). Use "|" to break new line:\n",
+        footerPrefixesSelect: "Select the ISSUES type of changeList by this change (optional):",
+        customFooterPrefix: "Input ISSUES prefix:",
+        footer: "List any ISSUES by this change. E.g.: #31, #34:\n",
+        generatingByAI: "Generating your AI commit subject...",
+        generatedSelectByAI: "Select suitable subject by AI generated:",
+        confirmCommit: "Are you sure you want to proceed with the commit above?",
+    },
+    types: [
+        { value: "feat", name: "feat:     A new feature", emoji: ":sparkles:" },
+        { value: "fix", name: "fix:      A bug fix", emoji: ":bug:" },
+        { value: "docs", name: "docs:     Documentation only changes", emoji: ":memo:" },
+        { value: "style", name: "style:    Changes that do not affect the meaning of the code", emoji: ":lipstick:" },
+        { value: "refactor", name: "refactor: A code change that neither fixes a bug nor adds a feature", emoji: ":recycle:" },
+        { value: "perf", name: "perf:     A code change that improves performance", emoji: ":zap:" },
+        { value: "test", name: "test:     Adding missing tests or correcting existing tests", emoji: ":white_check_mark:" },
+        { value: "build", name: "build:    Changes that affect the build system or external dependencies", emoji: ":package:" },
+        { value: "ci", name: "ci:       Changes to our CI configuration files and scripts", emoji: ":ferris_wheel:" },
+        { value: "chore", name: "chore:    Other changes that don\"t modify src or test files", emoji: ":hammer:" },
+        { value: "revert", name: "revert:   Reverts a previous commit", emoji: ":rewind:" },
+    ],
+    useEmoji: false,
+    emojiAlign: "center",
+    useAI: false,
+    aiNumber: 1,
+    themeColorCode: "",
+    scopes: [],
+    allowCustomScopes: true,
+    allowEmptyScopes: false,
+    customScopesAlign: "bottom",
+    customScopesAlias: "custom",
+    emptyScopesAlias: "empty",
+    upperCaseSubject: null,
+    markBreakingChangeMode: false,
+    allowBreakingChanges: ["feat", "fix"],
+    breaklineNumber: 100,
+    breaklineChar: "|",
+    skipQuestions: ["body", "footer"],
+    issuePrefixes: [{ value: "closed", name: "closed:   ISSUES has been processed" }],
+    customIssuePrefixAlign: "top",
+    emptyIssuePrefixAlias: "skip",
+    customIssuePrefixAlias: "custom",
+    allowCustomIssuePrefix: true,
+    allowEmptyIssuePrefix: true,
+    confirmColorize: true,
+    maxHeaderLength: Infinity,
+    maxSubjectLength: Infinity,
+    minSubjectLength: 0,
+    scopeOverrides: undefined,
+    defaultBody: "",
+    defaultIssues: "",
+    defaultScope: "",
+    defaultSubject: "",
+})

eslint.config.js renamed to eslint.config.cjs

@@ -1,9 +1,8 @@
-// eslint.config.js
-import parser from "@typescript-eslint/parser";
-import eslintPlugin from "@typescript-eslint/eslint-plugin";
-import stylistic from "@stylistic/eslint-plugin"
+const parser = require("@typescript-eslint/parser");
+const eslintPlugin = require("@typescript-eslint/eslint-plugin");
+const stylistic = require("@stylistic/eslint-plugin");
 
-export default [
+const eslintConfig = [
     {
         files: ["**/*.ts", "**/*.tsx"],
         languageOptions: {
@@ -20,17 +19,20 @@ export default [
         },
         rules: {
             ...eslintPlugin.configs.recommended.rules,
-            "@stylistic/comma-spacing": ["error", { "before": false, "after": true }],
+            "@stylistic/comma-spacing": ["error", { before: false, after: true }],
             "@stylistic/indent": ["error", 4],
             "@stylistic/key-spacing": ["error"],
             "@stylistic/space-before-blocks": "error",
             "@stylistic/quotes": ["error", "double"],
             "@stylistic/no-multi-spaces": "error",
             "@stylistic/no-trailing-spaces": "error",
             "@stylistic/semi": ["error", "never"],
-            "@stylistic/space-before-function-paren": ["error", {
-                "asyncArrow": "ignore"
-            }],
+            "@stylistic/space-before-function-paren": [
+                "error",
+                { asyncArrow: "ignore" },
+            ],
         },
     },
 ];
+
+module.exports = eslintConfig;

lint-staged.config.cjs

@@ -0,0 +1,3 @@
+module.exports = {
+    '**/*.{js,ts,tsx}': ['eslint src/ --ext .ts']
+};

package.json

@@ -4,9 +4,11 @@
   "main": "dist/index.js",
   "scripts": {
     "lint": "npx eslint src/ --ext .ts",
+    "commit": "git-cz",
     "build": "tsc",
     "test": "jest --coverage",
-    "clean": "rm -rf node_modules && rm package-lock.json && npm cache clean --force && npm install"
+    "clean": "rm -rf node_modules && rm package-lock.json && npm cache clean --force && npm install",
+    "prepare": "husky"
   },
   "files": [
     "dist/",
@@ -20,7 +22,10 @@
   "keywords": [
     "commitlint",
     "commitlintplugin",
-    "commitlint-plugin"
+    "commitlint-plugin",
+    "scope",
+    "pattern",
+    "scope-pattern"
   ],
   "author": "Ahmad Yulia Rizqy Fahmi <https://github.com/rizqyfahmi>",
   "license": "MIT",
@@ -33,6 +38,8 @@
   "homepage": "https://github.com/rizqyfahmi/commitlint-plugin-prevenger#readme",
   "description": "A Commitlint plugin that is containing some toolkits for checking the commit message",
   "devDependencies": {
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
     "@commitlint/types": "^19.8.1",
     "@eslint/eslintrc": "^3.3.1",
     "@semantic-release/changelog": "^6.0.3",
@@ -46,11 +53,21 @@
     "@types/jest": "^30.0.0",
     "@typescript-eslint/eslint-plugin": "^8.37.0",
     "@typescript-eslint/parser": "^8.37.0",
+    "commitizen": "^4.3.1",
+    "cz-conventional-changelog": "^3.3.0",
+    "cz-git": "^1.12.0",
     "eslint": "^9.31.0",
+    "husky": "^9.1.7",
     "jest": "^29.7.0",
+    "lint-staged": "^16.1.2",
     "semantic-release": "^24.2.7",
     "ts-jest": "^29.4.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.8.3"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-git"
+    }
   }
 }