chore: #250 refresh and refactor commit wizard workflow

Author: thescientist13

.cz.json

@@ -1,3 +1,3 @@
 {
-  "path": "@commitlint/cz-commitlint"
+  "path": "./cz-config.js"
 }

.github/workflows/ci.yml

@@ -36,4 +36,4 @@ jobs:
           npm run build
       - name: Commitlint Check
         if: github.event_name == 'push'
-        run: npm run commit:lint --last --verbose
+        run: npm run commit:lint

.husky/pre-commit

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

CONTRIBUTING.md

@@ -318,15 +318,18 @@ For links to `/discord/`, a redirect is configured in _netlify.toml_ to redirect
 
 ## Pull Requests
 
-To best help facilitate contributions to the project, we have Conventional Commits configured for the project to walk you through preparing commits in the format of `<type>(<scope>): <summary of change>`, e.g. _bug(cli): fixed bug with the thing_. This workflow will also run your files through Prettier.
+To best help facilitate contributions to the project, we have Conventional Commits configured for the project to walk you through preparing commits in the format of `<type>: #<issue> <summary-of-change>`, e.g. _bug: #123 fixed bug with the thing_.
 
-After staging the files you ready to commit with git add, you can initiate the commit "wizard" by running:
+Make sure you have run `npm run lint`, `npm run format` and `npm run test` to prepare your commit. Then, after staging your files with `git add`, you can initiate the commit "wizard" by running:
 
 ```sh
 $ npm run commit
 ```
 
-The PR title should match the conventional commits format as well. If you make the PR after one commit, GitHub will automatically use the first commit as the.
+The following will be required:
+
+- **type**
+- **issue reference** (can technically be empty)
 
 ## Continuous Integration
 

commitlint.config.js

@@ -8,68 +8,8 @@ export default {
       ["feat", "enhancement", "fix", "chore", "content", "docs", "revert"],
     ],
     "type-empty": [2, "never"],
-    "scope-empty": [2, "always"],
     "subject-case": [2, "always", "lower-case"],
     "body-case": [2, "always", "lower-case"],
     "header-case": [2, "always", "lower-case"],
   },
-  // emojis don't actually work
-  // https://github.com/conventional-changelog/commitlint/issues/4534
-  prompt: {
-    settings: {
-      enableMultipleScopes: false,
-      scopeEnumSeparator: ",",
-    },
-    questions: {
-      type: {
-        description: "Select the type of change that you're committing:",
-        enum: {
-          feat: {
-            description: "A new feature",
-            title: "Features",
-            emoji: "✨",
-          },
-          enhancement: {
-            description: "A code change that neither fixes a bug nor adds a feature",
-            title: "Code Refactoring",
-            emoji: "💪",
-          },
-          fix: {
-            description: "A bug fix",
-            title: "Bug Fixes",
-            emoji: "🐛",
-          },
-          chore: {
-            description: "Other changes that don't modify src files",
-            title: "Chores",
-            emoji: "🛠",
-          },
-          docs: {
-            description: "Docs or guide changes",
-            title: "Documentation",
-            emoji: "📚",
-          },
-          content: {
-            description: "Copy only changes or blog posts",
-            title: "Content",
-            emoji: "📝",
-          },
-          revert: {
-            description: "Reverts a previous commit",
-            title: "Reverts",
-            emoji: "🗑",
-          },
-        },
-      },
-      subject: {
-        description: "Write a short, imperative tense description of the change",
-      },
-      isIssueAffected: {
-        description: "Does this change affect any open issues?",
-      },
-      issues: {
-        description: 'Add issue references (e.g. "#123")',
-      },
-    },
-  },
 };

cz-config.js

@@ -0,0 +1,62 @@
+// NOTE: need to keep types and scope consistent with commitlint.config.js
+// https://commitizen.github.io/cz-cli/
+const types = [
+  { value: "feature", name: "feature:         ✨  A new feature" },
+  {
+    value: "enhancement",
+    name: "enhancement:     💪  A code change that neither fixes a bug nor adds a feature",
+  },
+  { value: "fix", name: "fix:             🐛  A bug fix" },
+  { value: "docs", name: "docs:            📚  Docs or guides content changes" },
+  { value: "content", name: "content:            📝  Copy only changes or blog posts" },
+  { value: "chore", name: "chore:           🛠   Other changes that don't modify src files" },
+  { value: "revert", name: "revert:          🗑   Reverts a previous commit" },
+];
+
+export default {
+  prompter: async (cz, commit) => {
+    const { type } = await cz.prompt([
+      {
+        type: "list",
+        name: "type",
+        message: "Select the type of the change",
+        choices: types,
+      },
+    ]);
+
+    const { subject } = await cz.prompt([
+      {
+        type: "input",
+        name: "subject",
+        message: "Write a short, imperative description of the change",
+        validate: (input) => {
+          if (input.length === 0) {
+            return "Subject is required";
+          }
+
+          return true;
+        },
+      },
+    ]);
+
+    const { issue } = await cz.prompt([
+      {
+        type: "input",
+        name: "issue",
+        message: "Enter the issue associated with this change (e.g. 123)",
+        validate: (input) => {
+          if (input.startsWith("#")) {
+            return "Please do not include the #";
+          }
+
+          return true;
+        },
+      },
+    ]);
+
+    const issueFormat = issue === "" ? "" : `#${issue} `;
+    const message = `${type}: ${issueFormat}${subject}`;
+
+    commit(message);
+  },
+};