mixcli 3.2.0 → 3.2.2

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { LiteEvent } from 'flex-tools/events/liteEvent';
-import { Option, Command } from 'commander';
+import { OptionValues, Option, Command } from 'commander';
 import { PromptObject } from 'prompts';
 import * as flex_tools__ from 'flex-tools/*';
 
@@ -7,6 +7,8 @@ type PromptType = "text" | "password" | "invisible" | "number" | "confirm" | "li
 type PromptParam = 'auto' | boolean | PromptType | PromptObject;
 type InputPromptParam = PromptParam | ((value: any) => PromptParam) | boolean;
 type PromptParamDefaultValue = string | boolean | string[];
+declare const promptTypeMap: Record<string, string>;
+declare const supportedPromptTypes: string[];
 interface PromptChoice {
     title: string;
     value?: any;
@@ -14,128 +16,112 @@ interface PromptChoice {
     selected?: boolean | undefined;
     description?: string | undefined;
 }
-interface IPromptableOptions {
-    required?: boolean;
-    optional?: boolean;
-    default?: PromptParamDefaultValue;
-    choices?: (PromptChoice | any)[];
-    prompt?: InputPromptParam;
-    validate?: (value: any) => boolean;
-}
-interface IPromptable {
-    name(): string;
-    description?: string;
-    flags: string;
-    promptChoices?: PromptChoice[];
-    argChoices?: string[];
-    variadic?: boolean;
-    defaultValue?: PromptParamDefaultValue;
-    input?: any;
-    required?: boolean;
-    validate?: (value: any) => boolean;
-    getPrompt(inputValue?: any): PromptObject | undefined;
-}
+type PromptParams = Omit<PromptObject, 'name'> | PromptType | boolean | 'auto' | undefined;
 /**
  * 负责生成prompt对象
  *
  */
-declare class PromptManager {
-    args: InputPromptParam;
-    private _promptable;
-    constructor(promptable: IPromptable, promptArgs?: InputPromptParam);
+declare class MixOptionPrompt {
+    cliOption: MixOption;
+    params?: PromptParams;
+    constructor(cliOption: MixOption, promptParams?: PromptParams);
     /**
      * 返回输入的是否是有效的prompt类型
      * @param type
      * @returns
      */
-    isValid(type: any): boolean;
+    isValidPromptType(type: any): boolean;
     /**
      * 推断是否需要提示
      *
+     * 1. 显式指定prompt=true或者提示类型，或者提示对象，则需要提示
+     *
+     *
      */
-    isNeed(input: any, defaultValue?: any): boolean;
+    isNeedPrompt(input: any, defaultValue?: any): boolean;
+    private _getChoices;
     /**
-     * 返回生成prompt对象
+     * 自动推断prompt类型
+     *
+     *
      *
      * @param inputValue   从命令行输入的值
      */
-    get(inputValue?: any): PromptObject<string> | undefined;
+    infer(inputValue?: any): PromptType;
     /**
-     * 推断prompt类型
+     * 返回生成prompt对象
      *
      * @param inputValue   从命令行输入的值
      */
-    infer(inputValue?: any): string;
+    get(inputValue?: any): PromptObject<string> | undefined;
 }
 
-interface MixedOptionParams extends IPromptableOptions {
-    hidden?: boolean;
+interface MixedOptionParams {
+    required?: boolean;
+    optional?: boolean;
+    variadic?: boolean;
+    mandatory?: boolean;
+    negate?: boolean;
+    default?: any;
     defaultDescription?: string;
     conflicts?: string | string[];
-    env?: string;
-    argParser?: <T>(value: string, previous: T) => T;
-    hideHelp?: boolean;
-    mandatory?: boolean;
-    implies?: {
-        [key: string]: any;
-    };
+    argParser?: unknown;
+    implies?: OptionValues;
+    envVar?: string;
+    parseArg?: <T>(value: string, previous: T) => T;
+    hidden?: boolean;
+    choices?: (string | PromptChoice)[] | ((pre: any, answers: any) => (string | PromptChoice)[]);
+    validate?: (value: any) => boolean;
+    preset?: unknown;
+    prompt?: PromptParams;
 }
-declare class MixOption extends Option implements IPromptable {
+declare class MixOption extends Option {
+    params?: MixedOptionParams | undefined;
     __MIX_OPTION__: boolean;
-    prompt?: PromptManager;
-    promptChoices?: PromptChoice[];
-    private _validate?;
-    constructor(flags: string, description?: string | undefined, optsOrDefault?: any);
-    validate(value: any): boolean;
-    choices(values: (PromptChoice | string)[]): void;
-    private resetChoices;
-    addChoice(value: PromptChoice | string): void;
-    removeChoice(value: any): void;
-    clearChoice(): void;
+    prompt?: MixOptionPrompt;
+    constructor(flags: string, description: string, params?: MixedOptionParams | undefined);
+    private _setOption;
     /**
      * 返回选项的提示对象
      *
      * @remarks
-     *
-     *
-     *
      * @param inputValue
      * @returns
      */
     getPrompt(inputValue?: any): PromptObject | undefined;
 }
 
-type ICommandHookListener = ({ args, options, command, }: {
+type IMixCommandHookListener = ({ args, options, command, }: {
     args: any[];
     options: Record<string, any>;
     command: MixCommand;
 }) => void | Promise<void>;
-type BeforeCommandHookListener = ({ args, options, command, }: {
+type BeforeMixCommandHookListener = ({ args, options, command, }: {
     args: any[];
     options: Record<string, any>;
     command: MixCommand;
 }) => void | Promise<void>;
-type AfterCommandHookListener = ({ value, args, options, command, }: {
+type AfterMixCommandHookListener = ({ value, args, options, command, }: {
     value: any;
     args: any[];
     options: Record<string, any>;
     command: MixCommand;
 }) => void | Promise<void>;
-interface ActionOptions {
+interface MixActionOptions {
     id: string;
     at: "replace" | "before" | "after" | "preappend" | "append" | number;
     enhance: boolean;
 }
-interface ActionRegistry extends Omit<ActionOptions, "at"> {
+interface MixActionRegistry extends Omit<MixActionOptions, "at"> {
     fn: Function;
 }
-type OriginalAction = (...args: any[]) => void | Promise<void>;
-type EnhanceAction = ({ args, options, value, command, }: {
+type MixOriginalAction = (...args: any[]) => any | Promise<void>;
+type MixEnhanceAction = ({ args, options, value, command, }: {
     args: any[];
     options: Record<string, any>;
     value: any;
     command: MixCommand;
-}) => void | Promise<any>;
+}) => any | Promise<any>;
 declare const BREAK: unique symbol;
 declare class MixCommand extends Command {
     __MIX_COMMAND__: boolean;
@@ -146,20 +132,18 @@ declare class MixCommand extends Command {
     private _actions;
     private _enable_prompts;
     constructor(name?: string);
-    /**
-     * 是否是根命令
-     */
     get isRoot(): boolean;
-    get actions(): ActionRegistry[];
-    get beforeHooks(): [BeforeCommandHookListener, boolean][];
-    get afterHooks(): [AfterCommandHookListener, boolean][];
+    get optionValues(): Record<string, any>;
+    get actions(): MixActionRegistry[];
+    get beforeHooks(): [BeforeMixCommandHookListener, boolean][];
+    get afterHooks(): [AfterMixCommandHookListener, boolean][];
     get fullname(): string;
     /**
      * 返回根命令
      */
-    root(): MixCommand;
-    action(fn: EnhanceAction, options: ActionOptions): this;
-    action(fn: OriginalAction): this;
+    root(): any;
+    action(fn: MixEnhanceAction, options: MixActionOptions): this;
+    action(fn: MixOriginalAction): this;
     /**
      * 读取命令配置值，包括父命令提供的配置选项
      * @param command
@@ -188,7 +172,7 @@ declare class MixCommand extends Command {
      * @param scope     =false时代表只在本命令执行，=true时代表在本命令及其子命令执行
      * @returns
      */
-    before(listener: BeforeCommandHookListener, scope?: boolean): this;
+    before(listener: BeforeMixCommandHookListener, scope?: boolean): this;
     private executeBeforeHooks;
     /**
      * 添加一个After钩子
@@ -196,7 +180,7 @@ declare class MixCommand extends Command {
      * @param scope     =false时代表只在本命令执行，=true时代表在本命令及其子命令执行
      * @returns
      */
-    after(listener: AfterCommandHookListener, scope?: boolean): this;
+    after(listener: AfterMixCommandHookListener, scope?: boolean): this;
     private executeAfterHooks;
     private preActionHook;
     private isEnablePrompts;
@@ -204,14 +188,14 @@ declare class MixCommand extends Command {
      * 生成选项自动提示
      *
      * @remarks
-     * FlexCli要求所有未提供默认值的Option自动生成提示
+     * 要求所有未提供默认值的Option自动生成提示
      *
      * - 未提供默认值，并且是必选的参数Option
      * - 指定了choices但未提供有效值的Option
      *
      */
     private generateAutoPrompts;
-    option(flags: string, description?: string | undefined, defaultValue?: any): this;
+    option(flags: string, description: string, options?: MixedOptionParams): this;
     /**
      * 添加提示
      *
@@ -219,9 +203,7 @@ declare class MixCommand extends Command {
      *
      * 添加一些自定义提示
      *
-     *
      * @param questions
-     * @param show              是否显示提示信息，auto表示只有在用户没有提供option的值时才显示提示信息,always表示总是显示提示信息，never表示不显示提示信息
      * @returns
      */
     prompt(questions: PromptObject | PromptObject[]): this;
@@ -239,6 +221,9 @@ declare class MixCommand extends Command {
      * 禁用/启用所有提示
      */
     disablePrompts(): this;
+    /**
+     * 启用所有提示
+     */
     enablePrompts(): this;
 }
 
@@ -261,7 +246,7 @@ type MixCliCommand = (cli: MixCli) => MixCommand | MixCommand[] | void;
 type MixCliEvents = "register";
 declare class MixCli extends LiteEvent<any, MixCliEvents> {
     options: Required<MixCliOptions>;
-    root: Command;
+    root: MixCommand;
     private findSignals;
     constructor(options?: MixCliOptions);
     get context(): Record<string, any>;
@@ -331,12 +316,6 @@ declare class MixCli extends LiteEvent<any, MixCliEvents> {
      * 运行命令行程序
      */
     run(): void;
-    /**
-     * 创建一个命令
-     *
-     *
-     */
-    create(): void;
 }
 
 /**
@@ -378,7 +357,7 @@ declare function addBuiltInOptions(command: any): void;
  * 是否命令行中包含了--debug-cli选项
  */
 declare function isDebug(): boolean;
-declare function isEnablePrompts(): boolean;
+declare function isDisablePrompts(): boolean;
 /**
  * 打印调试信息
  * @param message
@@ -389,13 +368,6 @@ declare const fileExists: flex_tools__.AsyncFunction;
 declare const readFile: flex_tools__.AsyncFunction;
 declare const writeFile: flex_tools__.AsyncFunction;
 declare const mkdir: flex_tools__.AsyncFunction;
-/**
- * 基于artTemplate模板生成文件
- *
- * @param {*} tmplFile
- * @param {*} vars
- */
-declare function createFileByTemplate(targetFile: string, tmplFile: string, vars?: Record<string, any>): Promise<string>;
 /**
  * 创建目录
  *
@@ -410,7 +382,8 @@ declare function mkDirs(dirs: string[], { callback, base }: {
     base?: string;
 }): Promise<void>;
 declare function showError(e: any): void;
+declare function hyphenToCamelCase(str: string): string;
 declare function getId(): string;
 declare function importModule(file: string): Promise<any>;
 
-export { type ActionOptions, type ActionRegistry, type AfterCommandHookListener, BREAK, type BeforeCommandHookListener, type EnhanceAction, type ICommandHookListener, MixCli, type MixCliCommand, type MixCliEvents, type MixCliOptions, MixCommand, MixOption, type MixedOptionParams, type OriginalAction, addBuiltInOptions, createFileByTemplate, fileExists, fixIndent, getId, importModule, isDebug, isEnablePrompts, mkDirs, mkdir, outputDebug, outputStr, readFile, showError, writeFile };
+export { type AfterMixCommandHookListener, BREAK, type BeforeMixCommandHookListener, type IMixCommandHookListener, type InputPromptParam, type MixActionOptions, type MixActionRegistry, MixCli, type MixCliCommand, type MixCliEvents, type MixCliOptions, MixCommand, type MixEnhanceAction, MixOption, MixOptionPrompt, type MixOriginalAction, type MixedOptionParams, type PromptChoice, type PromptParam, type PromptParamDefaultValue, type PromptParams, type PromptType, addBuiltInOptions, fileExists, fixIndent, getId, hyphenToCamelCase, importModule, isDebug, isDisablePrompts, mkDirs, mkdir, outputDebug, outputStr, promptTypeMap, readFile, showError, supportedPromptTypes, writeFile };