Merge pull request #3 from jmaicaaan/feat/support-extending-commit-types

✨- feat: Support extending commit types
jmaicaaan · Apr 27, 2020 · 17d022b · 17d022b
2 parents 20461e3 + ec718cc
commit 17d022b
Show file tree

Hide file tree

Showing 5 changed files with 60 additions and 6 deletions.
diff --git a/packages/core/src/types/settings.ts b/packages/core/src/types/settings.ts
@@ -1,10 +1,12 @@
 import { App } from '../constants';
+import { CommitType } from './commitType';
 
 export type JiraWorkflowTransition = Record<'key' | 'label' | 'workflowTransitionName', string>;
 
 export type Settings = {
   workflow: App.BasicWorkflow | App.JiraWorkflow;
   format?: string;
+  commitTypes?: CommitType[],
   jira: {
     allowWorkflowTransitionPrompt: false;
     workflowTransitions: JiraWorkflowTransition[];

diff --git a/packages/vscode-ext/package.json b/packages/vscode-ext/package.json
@@ -53,6 +53,57 @@
           "description": "Set the commit format you wanted to use",
           "scope": "application"
         },
+        "commitji.commitTypes": {
+          "type": "array",
+          "default": [],
+          "description": "Extend the current commit types based on your needs",
+          "items": {
+            "type": "object",
+            "title": "Extended Commit Types",
+            "description": "Commit Type Properties",
+            "properties": {
+              "name": {
+                "type": "string",
+                "description": "Commit Type name",
+                "examples": [
+                  "fix",
+                  "feat"
+                ]
+              },
+              "description": {
+                "type": "string",
+                "description": "The Commit Type description",
+                "examples": [
+                  "A bug fix",
+                  "A new feature"
+                ]
+              },
+              "emoji": {
+                "type": "object",
+                "title": "The emoji to be used on the Commit Type",
+                "description": "The name of the workflow with the hashtag",
+                "properties": {
+                  "unicode": {
+                    "type": "string",
+                    "description": "The emoji unicode represnetation",
+                    "examples": [
+                      "🐛",
+                      "✨"
+                    ]
+                  },
+                  "shortcode": {
+                    "type": "string",
+                    "description": "The emoji shortcode represnetation",
+                    "examples": [
+                      ":bug:",
+                      ":sparkles:"
+                    ]
+                  }
+                }
+              }
+            }
+          }
+        },
         "commitji.jira.allowWorkflowTransitionPrompt": {
           "type": "boolean",
           "default": false,

diff --git a/packages/vscode-ext/src/commitjiCommit/utils/showCommitTypePicker.ts b/packages/vscode-ext/src/commitjiCommit/utils/showCommitTypePicker.ts
@@ -1,17 +1,18 @@
 import { QuickPickItem, window } from 'vscode';
 
-import { commitTypes, CommitType, Message } from '@commitji/core';
+import { commitTypes, CommitType, Message, Settings } from '@commitji/core';
 
 type ShowCommitTypePickerResult = CommitType;
 
 const findCommitTypeByName = (name: string) => (commitType: CommitType) => commitType.name === name;
 
-export const showCommitTypePicker = async (): Promise<ShowCommitTypePickerResult> => {
+export const showCommitTypePicker = async (settings: Settings): Promise<ShowCommitTypePickerResult> => {
   const commitTypeToQuickPickDisplay = (commitType: CommitType): QuickPickItem => ({
     label: [commitType.emoji.unicode, commitType.name, '-', commitType.description].join(' '),
   });
+  const mergedCommitTypes = [...commitTypes, ...settings.commitTypes];
 
-  const quickPickItems = commitTypes.map(commitTypeToQuickPickDisplay);
+  const quickPickItems = mergedCommitTypes.map(commitTypeToQuickPickDisplay);
 
   const result = await window.showQuickPick(quickPickItems, {
     placeHolder: 'What type of task did you do?',
@@ -26,7 +27,7 @@ export const showCommitTypePicker = async (): Promise<ShowCommitTypePickerResult
   const [commitTypeWithEmojiUnicode] = result.label.split('-');
   const [, commitTypeName] = commitTypeWithEmojiUnicode.split(' ');
   const commitTypeFromTheResult = findCommitTypeByName(commitTypeName);
-  const commitTypeFromResult = commitTypes.find(commitTypeFromTheResult);
+  const commitTypeFromResult = mergedCommitTypes.find(commitTypeFromTheResult);
 
   if (!commitTypeFromResult) {
     throw new Error(Message.Error.MissingCommitType);

diff --git a/packages/vscode-ext/src/commitjiCommit/workflows/basicWorkflow.ts b/packages/vscode-ext/src/commitjiCommit/workflows/basicWorkflow.ts
@@ -3,7 +3,7 @@ import { formatter, basicCommitParser, Settings } from '@commitji/core';
 import { showCommitTypePicker, showCommitBodyInputBox, writeCommitToTerminal } from '../utils';
 
 export const basicWorkflow = async (settings: Settings) => {
-  const commitType = await showCommitTypePicker();
+  const commitType = await showCommitTypePicker(settings);
   const commitMessage = await showCommitBodyInputBox();
   const parser = basicCommitParser({
     format: settings.format,

diff --git a/packages/vscode-ext/src/commitjiCommit/workflows/jiraWorkflow.ts b/packages/vscode-ext/src/commitjiCommit/workflows/jiraWorkflow.ts
@@ -9,7 +9,7 @@ import {
 } from '../utils';
 
 export const jiraWorkflow = async (settings: Settings) => {
-  const commitType = await showCommitTypePicker();
+  const commitType = await showCommitTypePicker(settings);
   const issueKey = await showJiraIssueKeyInputBox();
   const commitMessage = await showCommitBodyInputBox();
   const workflowTransition = await showJiraWorkflowTransitionPicker(