feat(cz-git): add defaultType options

it will pin type item the top of the types list (if match item value)

link #30

Author: Zhengqbbb

docs/guide/options-show.md

@@ -104,21 +104,27 @@ Try running `emoji=1 cz` to **enable output emoji mode in the current session**
 
 ---
 
+<br/>
+<br/>
+<br/>
+
 :::tip
 Using ==default value== can produce many ways to make the tool more suitable for you or your team's habits, [⇒ see the recipes](/guide/recipes.html#default)
 :::
 
+## defaultType
+
+- **description** : pin type item the top of the types list (match item value)
+- **type** : `string`
+- **default** : `""`
+
 ## defaultScope
 
 - **description** : Whether to use display default value in **custom scope**
 - **type** : `string`
 - **default** : `""`
 - **use** : when you want the default value to appear on the command line just press the "Enter" key
-
-:::tip
-If `defaultScope` matches the scope list item `value`.
-It will be pinned to the top of scope list.
-:::
+<Badge type="tip" text="Tip" vertical="middle" /> pin scope item the top of the scope list (match item value)
 
 ## defaultSubject
 

docs/zh/guide/options-show.md

@@ -104,20 +104,28 @@ export ___X_CMD_THEME_COLOR_CODE="38;5;043"
 
 ---
 
+<br/>
+<br/>
+<br/>
+
 :::tip
 使用==默认值==可以产生很多种玩法让工具更契合你或团队的习惯，[⇒ 查看小窍门](/zh/guide/recipes.html#default)
 :::
 
+## defaultType
+
+- **描述** : 如果 defaultType 与在选择范围列表项中的 value 相匹配就会进行星标置顶操作。
+- **类型** : `string`
+- **默认** : `""`
+
 ## defaultScope
 
 - **描述** : 在 **自定义范围** 中是否使用显示默认值
 - **类型** : `string`
 - **默认** : `""`
 - **使用** : 当你想要命令行中出现的默认值只需要按下 "Enter" 键即可
 
-:::tip
-如果 `defaultScope` 与在选择范围列表项中的 `value` 相匹配就会进行星标置顶操作。
-:::
+<Badge type="tip" text="提示" vertical="middle" /> 如果 defaultScope 与在选择范围列表项中的 value 相匹配就会进行星标置顶操作。
 
 ## defaultSubject
 

packages/cz-git/src/generator/option.ts

@@ -53,6 +53,7 @@ export const generateOptions = (config: UserConfig): CommitizenGitOptions => {
     maxHeaderLength: promptConfig.maxHeaderLength ?? getMaxLength(config?.rules?.["header-max-length"] as any),
     maxSubjectLength: promptConfig.maxSubjectLength ?? getMaxLength(config?.rules?.["subject-max-length"] as any),
     minSubjectLength: promptConfig.minSubjectLength ?? getMinLength(config?.rules?.["subject-min-length"] as any),
+    defaultType: promptConfig.defaultType ?? defaultConfig.defaultType,
     defaultScope: promptConfig.defaultScope ?? defaultConfig.defaultScope,
     defaultSubject: promptConfig.defaultSubject ?? defaultConfig.defaultSubject,
     defaultBody: promptConfig.defaultBody ?? defaultConfig.defaultBody,

packages/cz-git/src/generator/question.ts

@@ -6,13 +6,14 @@
 
 import type { Answers, CommitizenGitOptions, Option } from "../shared";
 import {
+  isSingleItem,
+  getCurrentScopes,
   getProcessSubject,
   getMaxSubjectLength,
+  handlePinListTop,
   handleStandardScopes,
   handleCustomTemplate,
-  log,
-  isSingleItem,
-  getCurrentScopes
+  log
 } from "../shared";
 import { generateMessage } from "./message";
 import { fuzzyFilter, style } from "@cz-git/inquirer";
@@ -33,7 +34,10 @@ export const generateQuestions = (options: CommitizenGitOptions, cz: any) => {
       message: options.messages?.type,
       themeColorCode: options?.themeColorCode,
       source: (_: unknown, input: string) => {
-        const typeSource = options.types?.concat(options.typesAppend || []) || [];
+        const typeSource = handlePinListTop(
+          options.types?.concat(options.typesAppend || []) || [],
+          options.defaultType
+        );
         return fuzzyFilter(input, typeSource, "value");
       }
     },

packages/cz-git/src/shared/types/options.ts

@@ -285,7 +285,13 @@ export interface CommitizenGitOptions {
   minSubjectLength?: number;
 
   /**
-   * @description: default value show scope custom prompt
+   * @description: pin type item the top of the types list (match item value)
+   */
+  defaultType?: string;
+
+  /**
+   * @description: Whether to use display default value in custom scope
+   * @tip pin scope item the top of the scope list (match item value)
    * @example: When you want to use default, just keybord <Enter> it
    */
   defaultScope?: string;
@@ -369,8 +375,9 @@ export const defaultConfig = Object.freeze({
    minSubjectLength: 0,
    scopeOverrides: undefined,
    scopeFilters: [".DS_Store"],
-   defaultBody: "",
+   defaultType: "",
    defaultScope: "",
+   defaultBody: "",
    defaultSubject: "",
    defaultFooterPrefix: "",
    defaultIssues: ""

packages/cz-git/src/shared/utils/util.ts

@@ -54,6 +54,19 @@ export const getMaxSubjectLength = (
   return countLength(optionMaxLength, typeLength, scopeLength, emojiLength);
 };
 
+export const handlePinListTop = (
+  arr: {
+    name: string;
+    value: any;
+  }[],
+  defaultValue?: string
+) => {
+  if (!defaultValue || defaultValue === "") return arr;
+  const index = arr.findIndex((i) => i.value === defaultValue);
+  if (!~index) return arr;
+  return [arr[index], ...arr.slice(0, index), ...arr.slice(index + 1)];
+};
+
 const filterCustomEmptyByOption = (
   target: {
     name: string;
@@ -88,14 +101,8 @@ export const handleCustomTemplate = (
   if (!Array.isArray(target)) {
     return result;
   } else if (defaultValue !== "") {
-    // put the defaultValue to the top
-    const targetIndex = target.findIndex((i) => i.value === defaultValue);
-    if (targetIndex !== -1)
-      target = [
-        target[targetIndex],
-        ...target.slice(0, targetIndex),
-        ...target.slice(targetIndex + 1)
-      ];
+    // pin the defaultValue to the top
+    target = handlePinListTop(target, defaultValue);
   }
   // prettier-ignore
   switch (align) {

tsconfig.build.json

@@ -1,9 +1,9 @@
 {
   "extends": "./tsconfig.base.json",
   "references": [
-    { "path": "./packages/cz-git/tsconfig.json" },
     { "path": "./packages/@cz-git/plugin-loader/tsconfig.json" },
     { "path": "./packages/@cz-git/plugin-inquirer/tsconfig.json" },
+    { "path": "./packages/cz-git/tsconfig.json" },
   ],
   "files": []
 }