feat(cz-git): support types fuzzy search types[name] options

add `typesSearchValueKey` option default types list fuzzy search types `value` options. if choose `false` will search `name` options link #57
Zhengqbbb · Aug 18, 2022 · ba4ce71 · ba4ce71
1 parent 8fb63b0
commit ba4ce71
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/packages/cz-git/src/generator/option.ts b/packages/cz-git/src/generator/option.ts
@@ -24,6 +24,7 @@ export const generateOptions = (config: UserConfig): CommitizenGitOptions => {
     themeColorCode: ___X_CMD_THEME_COLOR_CODE || promptConfig.themeColorCode || defaultConfig.themeColorCode,
     types: promptConfig.types ?? defaultConfig.types,
     typesAppend: promptConfig.typesAppend ?? defaultConfig.typesAppend,
+    typesSearchValueKey: promptConfig.typesSearchValueKey ?? defaultConfig.typesSearchValueKey,
     useEmoji: Boolean(emoji === '1') || promptConfig.useEmoji || defaultConfig.useEmoji,
     emojiAlign: promptConfig.emojiAlign || defaultConfig.emojiAlign,
     scopes: promptConfig.scopes ?? getEnumList(config?.rules?.['scope-enum'] as any),

diff --git a/packages/cz-git/src/generator/question.ts b/packages/cz-git/src/generator/question.ts
@@ -39,7 +39,10 @@ export const generateQuestions = (options: CommitizenGitOptions, cz: any) => {
           options.types?.concat(options.typesAppend || []) || [],
           options.defaultType,
         )
-        return fuzzyFilter(input, typeSource, 'value')
+        const searchTarget = options.typesSearchValueKey
+          ? 'value'
+          : 'name'
+        return fuzzyFilter(input, typeSource, searchTarget)
       },
     },
     {

diff --git a/packages/cz-git/src/shared/types/options.ts b/packages/cz-git/src/shared/types/options.ts
@@ -138,6 +138,12 @@ export interface CommitizenGitOptions {
    */
   typesAppend?: TypesOption[]
 
+  /**
+   * @description: default types list fuzzy search types `value` options. if choose `false` will search `name` options
+   * @default: true
+   */
+  typesSearchValueKey?: boolean
+
   /**
    * @description: Use emoji ？| it will be use typesOption.emoji code
    * @default: false
@@ -380,6 +386,7 @@ export const defaultConfig = Object.freeze({
     { value: 'revert', name: 'revert:   Reverts a previous commit', emoji: ':rewind:' },
   ],
   typesAppend: [],
+  typesSearchValueKey: true,
   themeColorCode: '',
   useEmoji: false,
   emojiAlign: 'center',