czg 1.9.4 → 1.10.0-beta.2

package/README.md

@@ -38,7 +38,7 @@ Interactive Commitizen CLI that generate standardized git commit message
 <br/>
 
 - 🤖 **OpenAI Support.** Let the AI generate your git commit message description.
-- ⚡️ **Lightweight** : Zero Dependencies (1.6MB)
+- ⚡️ **Lightweight** : Zero Dependencies (1.31MB)
 - 🤗 **Simpler and Faster** : No plugin, No adapter, No extra steps, You can use `npx` | `npm script` | `global install`... quick start CLI in your any project
 - 😎 **Highly Customizable** : Internally contains the core of cz-git. Extend all the features of cz-git. Same behavior, Same configuration loader... You can customize the commit CLI according to your need
 
@@ -88,10 +88,15 @@ OPTIONS:
     --config=        Specify the configuration file to use
 
   OpenAI:
-    -N=,--ai-num=    Setting AI return number subjects and Turn on choose mode
+    -N=,--ai-num=    Sets AI return multiple subjects and Turn on choose mode
+    -M=,--ai-model=  Sets AI model in this session
+                     [default: "gpt-4o-mini"]
+                     [example: "gpt-3.5-turbo", "gpt-4o", "gpt-4o-mini" ...]
     --api-key=       Setup request OpenAI API secret key to local (.config/.czrc)
+    --api-model=     Setup request OpenAI API model      to local (.config/.czrc)
     --api-proxy=     Setup request OpenAI API proxy      to local (.config/.czrc)
     --api-endpoint=  Setup request OpenAI API endpoint   to local (.config/.czrc)
+                     [default: "https://api.openai.com/v1"]
 
 FLAG:
     -r, --retry      Directly retry submit by the last message
@@ -106,7 +111,7 @@ EXAMPLES:
     czg :fd
     czg --config="./config/cz.json"
     czg --api-key="sk-XXXXX"
-    czg ai -N=3
+    czg ai -N=3 -M="gpt-4o"
 
 Extends 'git commit' options.
 See 'git commit --help' for more information.
@@ -178,7 +183,19 @@ brew install czg
 
 ## LICENSE
 
-MIT
-Copyright (c) 2022-present Qiubin Zheng <zhengqbbb@gmail.com> (https://github.com/Zhengqbbb)
+MIT Copyright (c) 2022-present Qiubin Zheng <zhengqbbb@gmail.com> (https://github.com/Zhengqbbb)
 
-> I just do my best to make thing well, Could you give a [star ⭐](https://github.com/Zhengqbbb/cz-git) to encourage me ?
+<p align="center">
+    <table>
+        <tbody>
+        <td align="center">
+            <br>
+            I just try my best to make thing well.<br>
+            Could you give a star ⭐ to encourage me 🤗
+            <br>
+            If possible, can to be my <a href="https://github.com/sponsors/Zhengqbbb">💖 Sponsor 💖</a> to support my work
+            <img width="800" height="0" />
+        </td>
+        </tbody>
+    </table>
+</p>

package/lib/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * @description: fork by "@commitlint/types" v16.2.1
+ * @description fork by "@commitlint/types" v16.2.1
  */
 /** ========== rules ========== */
 /**
@@ -135,10 +135,10 @@ interface CommitReference {
 type TargetCaseType = 'camel-case' | 'kebab-case' | 'snake-case' | 'pascal-case' | 'start-case' | 'upper-case' | 'uppercase' | 'sentence-case' | 'sentencecase' | 'lower-case' | 'lowercase' | 'lowerCase';
 
 /**
- * @description: cz-git types
- * @author: @Zhengqbbb (zhengqbbb@gmail.com)
- * @license: MIT
- * @copyright: Copyright (c) 2022-present Qiubin Zheng
+ * @description cz-git types
+ * @author @Zhengqbbb (zhengqbbb@gmail.com)
+ * @license MIT
+ * @copyright Copyright (c) 2022-present Qiubin Zheng
  */
 
 /** cz-git + commitlint configure */
@@ -212,19 +212,20 @@ type ScopesType = string[] | Array<{
 }>;
 interface Option {
     /**
-     * @description: show prompt name
+     * show terminal prompt name
      */
     name: string;
     /**
-     * @description: output real value
+     * output real value
      */
     value: string;
 }
 interface TypesOption extends Option {
     /**
-     * @description: Submit emoji commit string
-     * @see: https://gitmoji.dev/
-     * @example: ":bug:" => 🐛
+     * Submit emoji commit string
+     *
+     * @see https://gitmoji.dev/
+     * @example ":bug:" => 🐛
      */
     emoji?: string;
 }
@@ -233,31 +234,36 @@ interface TypesOption extends Option {
  */
 interface CommitMessageOptions {
     /**
-     * @description: choose type list value
+     * choose type list value
+     *
      * @example: 'feat'
      */
     type: string;
     /**
-     * @description: choose or custom scope value
+     * choose or custom scope value
+     *
      * @example: 'app'
      */
     scope: string;
     /**
-     * @description: choose type list emoji code. need turn on `useEmoji` options
+     * choose type list emoji code. need turn on `useEmoji` options
+     *
      * @example: ':sparkles:'
      */
     emoji: string;
     /**
-     * @description: express is a breaking change message
+     * express is a breaking change message
+     *
      * @example `!`
      */
     markBreaking: string;
     /**
-     * @description: input subject
+     * input subject
      */
     subject: string;
     /**
-     * @description: base Angular format default header
+     * base Angular format default header
+     *
      * @example `feat(app): add a feature`
      */
     defaultHeader: string;
@@ -265,7 +271,7 @@ interface CommitMessageOptions {
     breaking: string;
     footer: string;
     /**
-     * @description: base Angular format default all message
+     * base Angular format default all message
      */
     defaultMessage: string;
 }
@@ -279,7 +285,8 @@ interface GenerateAIPromptType {
 /** cz-git configure */
 interface CommitizenGitOptions {
     /**
-     * @description: define commonly used commit message alias
+     * define commonly used commit message alias
+     *
      * @default { fd: "docs: fix typos" }
      * @use commitizen CLI: "cz_alias=fd cz"
      * @use czg CLI: "czg --alias=fd" | "czg :fd"
@@ -287,11 +294,12 @@ interface CommitizenGitOptions {
      */
     alias?: Record<string, string>;
     /**
-     * @description: Customize prompt questions
+     * Customize prompt questions
      */
     messages?: Answers;
     /**
-     * @description: the prompt inquirer primary color
+     * the prompt inquirer primary color
+     *
      * @rule `38;5;${color_code}`
      * @tip the color_code can get by https://github.com/sindresorhus/xterm-colors
      * @example "38;5;043"
@@ -299,19 +307,21 @@ interface CommitizenGitOptions {
      */
     themeColorCode?: string;
     /**
-     * @description: Customize prompt type
+     * Customize prompt type
      */
     types?: TypesOption[];
     /**
-     * @description: Add extra types to default types
+     * Add extra types to default types
+     *
      * @use Use when you don't want to add bloated defaults and don't want to adjust the default order in configuration
      * @example `typesAppend: [ { value: "workflow", name: "workflow:  Workflow changes"} ],`
      * @default []
      */
     typesAppend?: TypesOption[];
     /**
-     * @description: default types list fuzzy search types `value` key of list.
-     * if choose `false` will search `name` key of list
+     * Default types list fuzzy search types `value` key of list.
+     * If choose `false` will search `name` key of list.
+     *
      * @use Using emoji unicode as `value` and that can't be searched
      * @default true
      */
@@ -319,110 +329,134 @@ interface CommitizenGitOptions {
     /** @deprecated Please use `typesSearchValue` field instead. */
     typesSearchValueKey?: boolean;
     /**
-     * @description: Use OpenAI to auto generate short description for commit message
+     * Use OpenAI to auto generate short description for commit message
+     *
      * @default false
      */
     useAI?: boolean;
     /**
-     * @description: If >1 will turn on select mode, select generate options like returned by OpenAI
+     * Choose the AI model you want to use
+     *
+     * @see https://platform.openai.com/docs/models/model-endpoint-compatibility => /v1/chat/completions
+     * @example "gpt-3.5-turbo" | "gpt-4" | "gpt-4o" | "gpt-4o-mini"
+     * @default "gpt-4o-mini"
+     */
+    aiModel?: string;
+    /**
+     * If >1 will turn on select mode, select generate options like returned by OpenAI
+     *
      * @default 1
      */
     aiNumber?: number;
     /**
-     * @description: To ignore selection codes when sending AI API requests
+     * To ignore selection codes when sending AI API requests
+     *
      * @default [ "package-lock.json", "yarn.lock", "pnpm-lock.yaml" ]
-     * @example: [ "pnpm-lock.yaml", "docs/public" ]
+     * @example [ "pnpm-lock.yaml", "docs/public" ]
      */
     aiDiffIgnore?: string[];
     /**
-     * Choose the AI model you want to use: gpt-3.5-turbo | text-davinci-003
-     * gpt-3.5-turbo: Lower price consumption (10x) and faster
-     * text-davinci-003: Get more reliable information
-     *
-     * @default openAI-Turbo
+     * Save on "$HOME/.config/.czrc" or "$HOME/.czrc". Do not save on project.
+     * `npx czg --api-key=sk-xxxxx`
      */
-    aiType?: 'openAI-Turbo' | 'openAI-Davinci';
+    openAIToken?: string;
     /**
-     * @description: Alert!!! Save on "$HOME/.czrc" or "$HOME/.config/.czrc". Do not save on project
+     * `npx czg --api-model=<model>` - to setup the AI model in local
+     *
+     * @note If the global or project has an `aiModel` field, set by --api-model=<value> will be overridden.
+     * @default "gpt-4o-mini"
      */
-    openAIToken?: string;
+    apiModel?: string;
     /**
      * It is recommended to use the command to configure the local
      * `npx czg --api-proxy=<http_proxy>`
-     * e.g: `npx czg --api-proxy="http://127.0.0.1:1080"` or `npx czg --api-proxy="socks5://127.0.0.1:1080"`
+     *
+     * @example `npx czg --api-proxy="http://127.0.0.1:1080"` or `npx czg --api-proxy="socks5://127.0.0.1:1080"`
      */
     apiProxy?: string;
     /**
      * `npx czg --api-endpoint=<url>`
+     *
      * @default "https://api.openai.com/v1"
      */
     apiEndpoint?: string;
     /**
-     * @description: Use the callback fn can customize edit information AI question information
-     * @param GenerateAIPromptType: provide some known parameters
+     * Use the callback fn can customize edit information AI question information
+     *
+     * @param aiParam provide some known parameters
      * @default generateSubjectDefaultPrompt
      */
     aiQuestionCB?: (aiParam: GenerateAIPromptType) => string;
     /**
-     * @description: Use emoji ？| it will be use typesOption.emoji code
+     * Use emoji ？It will be use typesOption.emoji code
+     *
      * @default false
      */
     useEmoji?: boolean;
     /**
-     * @description: Set the location of emoji in header
+     * Set the location of emoji in header
+     *
      * @default "center"
      */
     emojiAlign?: 'left' | 'center' | 'right';
     /**
-     * @description: Provides a select of prompt to select module scopes
-     * @note it auto import value from rule "scope-enum" with `@commitlint`
-     * @use want to add scopes description or when you not use commitlint
+     * Provides a select of prompt to select module scopes
+     *
+     * @commitlint it auto import value from rule "scope-enum"
      */
     scopes?: ScopesType;
     /**
-     * @description: default scope list fuzzy search types `name` key of list.
-     * if choose `true` will search `value` key of list.
+     * Default scope list fuzzy search types `name` key of list.
+     * If choose `true` will search `value` key of list.
+     *
      * @use If have long description of scope. can use it to enhanced search.
      * @default false
      */
     scopesSearchValue?: boolean;
     /**
-     * @description: Provides an overriding select of prompt to select module scopes under specific type
+     * Provides an overriding select of prompt to select module scopes under specific type
+     *
      * @note use this option should set `scopes` option to realize distinguish
-     * @example: [test] => provide select e2eTest unitTest
+     * @example { "test": ["e2eTest", "unitTest"] }
      */
     scopeOverrides?: {
         [type: string]: ScopesType;
     };
     /**
-     * @description: Filter select of prompt to select module scopes by the scope.value
+     * Filter select of prompt to select module scopes by the scope.value
+     *
      * @default ['.DS_Store']
      */
     scopeFilters?: string[];
     /**
-     * @description: Whether to enable scope multiple mode
+     * Whether to enable scope multiple mode
+     *
      * @default false
      */
     enableMultipleScopes?: boolean;
     /**
-     * @description: Multiple choice scope separator
+     * Multiple choice scope separator
+     *
      * @default ","
      */
     scopeEnumSeparator?: string;
     /**
-     * @description: Whether to show "custom" when selecting scopes
+     * Whether to show "custom" when selecting scopes
+     *
      * @note it auto check rule "scope-enum" set the option with `@commitlint`
      * @use when you not use commitlint
      * @default true
      */
     allowCustomScopes?: boolean;
     /**
-     * @description: Whether to show "empty" when selecting scopes
+     * Whether to show "empty" when selecting scopes
+     *
      * @default true
      */
     allowEmptyScopes?: boolean;
     /**
-     * @description: Set the location of empty option (empty) and custom option (custom) in selection range
+     * Set the location of empty option (empty) and custom option (custom) in selection range
+     *
      * @default "bottom"
      */
     customScopesAlign?: 'top' | 'bottom' | 'top-bottom' | 'bottom-top';
@@ -435,30 +469,34 @@ interface CommitizenGitOptions {
      */
     emptyScopesAlias?: string;
     /**
-     * @description: Subject is need upper case first.
+     * Subject is need upper case first.
+     *
      * @default false
      */
     upperCaseSubject?: boolean;
     /**
-     * @description: Whether to add extra prompt BREAKCHANGE ask. to add an extra "!" to the header
+     * Whether to add extra prompt BREAKCHANGE ask. to add an extra "!" to the header
+     *
      * @see: https://cz-git.qbb.sh/recipes/breakingchange
      * @default false
      */
     markBreakingChangeMode?: boolean;
     /**
-     * @description: Allow breaking changes in the included types output box
+     * Allow breaking changes in the included types output box
+     *
      * @default ['feat', 'fix']
      */
     allowBreakingChanges?: string[];
     /**
-     * @description: set body and BREAKING CHANGE max length to break-line
+     * set body and BREAKING CHANGE max length to break-line
+     *
      * @default 100
-     * @note it auto check rule "body-max-line-length" set the option with `@commitlint`.
-     * @use when you not use commitlint
+     * @commitlint it auto check rule "body-max-line-length".
      */
     breaklineNumber?: number;
     /**
-     * @description: body and BREAKINGCHANGES new line char
+     * body and BREAKINGCHANGES new line char
+     *
      * @default "|"
      */
     breaklineChar?: string;
@@ -468,7 +506,8 @@ interface CommitizenGitOptions {
      */
     issuePrefixs?: Option[];
     /**
-     * @description: Provides a select issue prefix box in footer
+     * Provides a select issue prefix box in footer
+     *
      * @default issuePrefixes: [{ value: "closed", name: "ISSUES has been processed" }]
      */
     issuePrefixes?: Option[];
@@ -505,7 +544,8 @@ interface CommitizenGitOptions {
      */
     allowCustomIssuePrefixs?: boolean;
     /**
-     * @description: Whether to show "custom" selecting issue prefixes
+     * Whether to show "custom" selecting issue prefixes
+     *
      * @default true
      */
     allowCustomIssuePrefix?: boolean;
@@ -515,92 +555,105 @@ interface CommitizenGitOptions {
      */
     allowEmptyIssuePrefixs?: boolean;
     /**
-     * @description: Whether to show "skip(empty)" when selecting issue prefixes
+     * Whether to show "skip(empty)" when selecting issue prefixes
+     *
      * @default true
      */
     allowEmptyIssuePrefix?: boolean;
     /**
-     * @description: Prompt final determination whether to display the color
+     * Prompt final determination whether to display the color
+     *
      * @default true
      */
     confirmColorize?: boolean;
     /**
-     * @description: List of questions you want to skip
+     * List of questions you want to skip
+     *
      * @default []
-     * @example: ['body']
+     * @example ['body']
      */
     skipQuestions?: Array<'scope' | 'body' | 'breaking' | 'footerPrefix' | 'footer' | 'confirmCommit'>;
     /**
-     * @description: Force set max header length | Equivalent setting maxSubjectLength.
-     * @note it auto check rule "header-max-length" set the option with `@commitlint`.
+     * Force set max header length | Equivalent setting maxSubjectLength.
+     *
+     * @commitlint it auto check rule and use value from "header-max-length".
      * @use when you not use commitlint
      */
     maxHeaderLength?: number;
     /**
-     * @description: Force set max subject length.
-     * @note it auto check rule "subject-max-length" set the option with `@commitlint`.
+     * Force set max subject length.
+     *
+     * @commitlint it auto check rule and use value from "subject-max-length".
      * @use when you not use commitlint
      */
     maxSubjectLength?: number;
     /**
-     * @description: Is not strict subject rule. Just provide prompt word length warning.
-     * Effected maxHeader and maxSubject commitlint
+     * Is not strict subject rule. Just provide prompt word length warning.
+     * Effected maxHeader and maxSubject commitlint.
+     *
      * @example [1, 'always', 80] 1: mean warning. will be true
      * @default false
      */
     isIgnoreCheckMaxSubjectLength?: boolean;
     /**
-     * @description: Force set header width.
-     * @note it auto check rule "subject-min-length" set the option with `@commitlint`.
+     * Force set header width.
+     *
+     * @commitlint it auto check rule and use value from "subject-min-length".
      * @use when you not use commitlint
      */
     minSubjectLength?: number;
     /**
-     * @description: pin type item the top of the types list (match item value)
+     * 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)
+     * Whether to use display default value in custom scope
      *
-     * `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
+     * @tip
+     * 1. pin scope item the top of the scope list (match item value)
+     * 2. `string[]` for checkbox mode will default-select the options whose values match those within the `scopes` range list.
+     * @usage When you want to use default, just keyboard `Enter` it
      */
     defaultScope?: string | string[];
     /**
-     * @description: default value show subject template prompt
-     * @example: If you want to use template complete. just keyboard <Tab> or <Right Arrow> it
-     * @example: If you want to use default, just keyboard <Enter> it
+     * default value show subject template prompt
+     *
+     * @usage If you want to use template complete. just keyboard `Tab` or `Right Arrow` it
+     * @usage If you want to use default, just keyboard `Enter` it
      */
     defaultSubject?: string;
     /**
-     * @description: default value show body and BREAKINGCHANGES template prompt
-     * @example: If you want to use template complete. just keyboard <Tab> or <Right Arrow> it
-     * @example: When you want to use default, just keyboard <Enter> it
+     * default value show body and BREAKINGCHANGES template prompt
+     *
+     * @usage If you want to use template complete. just keyboard `Tab` or `Right Arrow` it
+     * @usage When you want to use default, just keyboard `Enter` it
      */
     defaultBody?: string;
     /**
-     * @description: default value show issuePrefixes custom template prompt
-     * @example: If you want to use template complete. just keyboard <Tab> or <Right Arrow> it
-     * @example: When you want to use default, just keyboard <Enter> it
+     * default value show issuePrefixes custom template prompt
+     *
+     * @usage If you want to use template complete. just keyboard `Tab` or `Right Arrow` it
+     * @usage When you want to use default, just keyboard `Enter` it
      */
     defaultFooterPrefix?: string;
     /**
-     * @description: default value show issue foot template prompt
-     * @example: If you want to use template complete. just keyboard <Tab> or <Right Arrow> it
-     * @example: When you want to use default, just keyboard <Enter> it
+     * default value show issue foot template prompt
+     *
+     * @usage If you want to use template complete. just keyboard `Tab` or `Right Arrow` it
+     * @usage When you want to use default, just keyboard `Enter` it
      */
     defaultIssues?: string;
     /**
-     * @description: Whether to use GPG sign commit message (git commit -S -m)
+     * Whether to use GPG sign commit message (git commit -S -m)
      * @note the options only support `czg` cz-git cli and no support git hooks mode
-     * @usage_see https://github.com/Zhengqbbb/cz-git/issues/58
+     * @see https://github.com/Zhengqbbb/cz-git/issues/58
      * @default false
      */
     useCommitSignGPG?: boolean;
     /**
-     * @description: provide user custom finally message, can use the callback to change format
-     * @param CommitMessageOptions: provide subdivides each message part
+     * provide user custom finally message, can use the callback to change format
+     *
+     * @param messageMod provide subdivides each message part
      * @default ({ defaultMessage }) => defaultMessage
      */
     formatMessageCB?: (messageMod: CommitMessageOptions) => string;