cz-git - npm Package Compare versions

Comparing version 1.7.1 to 1.8.0

lib/index.d.ts

@@ -19,7 +19,7 @@ import { Interface } from 'node:readline';
     /**
-     * @description: origin choices
+     * @description origin choices
      */
     choices: ChoiceType<Separator['type']>[];
     /**
-     * @description: filter Separator choices
+     * @description filter Separator choices
      */
@@ -38,4 +38,4 @@ realChoices: ChoiceType<string>[];
     /**
-     * @description: support rgb color code. e.g: `38;5;042`
-     * @default: cyan
+     * @description support rgb color code. e.g: `38;5;042`
+     * @default cyan
      * @tip the rgb color see to check your number: https://github.com/sindresorhus/xterm-colors
@@ -45,3 +45,7 @@ */
     /**
-     * @description:
+     * @description default checked item's value array on initial
+     */
+    initialCheckedValue?: string[] | string;
+    /**
+     * @description
      * Function to determine what options to display to user.
@@ -52,8 +56,8 @@ * Called with previous answers object and the current user input each time the user types, it must return a promise.
     /**
-     * @description: The number of elements to show on each page.
+     * @description The number of elements to show on each page.
      */
     pageSize?: number | undefined;
     /**
-     * @description:
-     * default false. Setting it to true turns the input into a normal text input.
+     * @description Setting it to true turns the input into a normal text input.
+     * @default false
      */
@@ -267,2 +271,3 @@ isInitDefault?: boolean | undefined;
     private themeColorCode?;
+    private initialCheckedValue?;
     private initialValue;
@@ -352,2 +357,3 @@ private lastSearchInput?;
     separator?: undefined;
+    initialCheckedValue?: undefined;
     validate?: undefined;
@@ -363,4 +369,5 @@ when?: undefined;
     message: string | string[] | undefined;
+    separator: string | undefined;
     themeColorCode: string | undefined;
-    separator: string | undefined;
+    initialCheckedValue: string | string[] | undefined;
     source: (answer: Answers, input: string) => FilterArrayItemType[];
@@ -379,3 +386,3 @@ validate: (input: string | Array<string>) => string | true;
     validate: (input: string | Array<string>) => string | true;
-    when: (answers: Answers) => boolean | undefined;
+    when: (answers: Answers) => boolean;
     transformer: (input: string) => string;
@@ -385,2 +392,3 @@ themeColorCode?: undefined;
     separator?: undefined;
+    initialCheckedValue?: undefined;
     filter?: undefined;
@@ -392,9 +400,10 @@ default?: undefined;
     message: string | undefined;
+    completeValue: string | undefined;
     validate: (subject: string, answers: Answers) => string | boolean;
     transformer: (subject: string, answers: Answers) => string;
     filter: (subject: string) => string;
-    completeValue: string | undefined;
     themeColorCode?: undefined;
     source?: undefined;
     separator?: undefined;
+    initialCheckedValue?: undefined;
     when?: undefined;
@@ -411,2 +420,3 @@ default?: undefined;
     separator?: undefined;
+    initialCheckedValue?: undefined;
     validate?: undefined;
@@ -425,2 +435,3 @@ when?: undefined;
     separator?: undefined;
+    initialCheckedValue?: undefined;
     validate?: undefined;
@@ -440,2 +451,3 @@ completeValue?: undefined;
     separator?: undefined;
+    initialCheckedValue?: undefined;
     validate?: undefined;
@@ -452,2 +464,3 @@ filter?: undefined;
     separator?: undefined;
+    initialCheckedValue?: undefined;
     validate?: undefined;
@@ -632,3 +645,3 @@ completeValue?: undefined;
     minSubjectLength?: number;
-    defaultScope?: string;
+    defaultScope?: string | string[];
     defaultSubject?: string;
@@ -768,3 +781,3 @@ defaultBody?: string;
     type?: string;
-    defaultScope?: string;
+    defaultScope?: string | string[];
     maxSubjectLength?: number;
@@ -1057,7 +1070,9 @@ upperCaseSubject?: boolean;
     /**
-     * @description: Whether to use display default value in custom scope
+     * @description Whether to use display default value in custom scope
      * @tip pin scope item the top of the scope list (match item value)
+     *
+     * `string[]` for checkbox mode will default-select the options whose values match those within the `scopes` range list.
      * @example: When you want to use default, just keyboard <Enter> it
      */
-    defaultScope?: string;
+    defaultScope?: string | string[];
     /**
@@ -1064,0 +1079,0 @@ * @description: default value show subject template prompt

package.json

 {
   "name": "cz-git",
-  "version": "1.7.1",
+  "version": "1.8.0",
   "description": "A better customizable and git support commitizen adapter",
@@ -52,4 +52,4 @@ "author": "Zhengqbbb <[e-mail]> (https://github.com/Zhengqbbb)",
     "rimraf": "3.0.2",
-    "@cz-git/inquirer": "1.7.1",
-    "@cz-git/loader": "1.7.1"
+    "@cz-git/inquirer": "1.8.0",
+    "@cz-git/loader": "1.8.0"
   },
@@ -56,0 +56,0 @@ "scripts": {

No alert changes

Improved metrics

Total package byte prevSize

1937047

increased by0.27%

Lines of code

44929

increased by0.52%

No dependency changes