mixcli 3.2.0 → 3.2.1

package/src/finder.ts

@@ -1,142 +1,142 @@
-import { getPackageJson } from  "flex-tools/package/getPackageJson"
-import { getPackageRootPath } from 'flex-tools/package/getPackageRootPath';
-import type { MixCli } from './cli';
-import {  globSync } from 'glob'
-import { MixCliCommand } from './cli';
-import { importModule, isDebug, outputDebug } from './utils';
-import fs from "node:fs"
-import path from "node:path"
-
-
-/**
- * 
- * 在当前工程中查找符合FlexCli.prefix约定的命令 
- *  
- * - 读取当前包的package.json
- * - 找出所有以cli.prefix开头的依赖
- * - 加载这些依赖的目录下的匹配cli.pattern的命令
- * - 加载加载这样命令
- * 
- */
- 
-
-export function getMatchedDependencies(this:MixCli,entry:string):string[]{
-    const pacakgeMacher = this.options.include
-    if(!(pacakgeMacher instanceof RegExp)) return  []
-    
-    // 找出当前包的所有依赖
-    const { dependencies={},devDependencies={},peerDependencies={},optionalDependencies={},bundleDependencies={} } = getPackageJson(entry)
-    const packageNames = [
-        ...Object.keys(dependencies),
-        ...Object.keys(devDependencies),
-        ...Object.keys(peerDependencies),
-        ...Object.keys(optionalDependencies),
-        ...Object.keys(bundleDependencies)
-    ]
-    return packageNames.filter(name=>name!=="@voerka/cli" && pacakgeMacher.test(name))
-}
-
-function isMatched(str:string,reg?:string | RegExp | string[] | RegExp[]):boolean{
-    // let regexps:RegExp[]=[]
-    const regexps = reg ? (Array.isArray(reg) ? reg : [reg]) : []
-    return regexps.some(regexp=>{
-        if(typeof regexp === "string"){
-            return (new RegExp(regexp)).test(str)
-        }else if(regexp instanceof RegExp){
-            return regexp.test(str)
-        }else{
-            return false
-        }
-    })
-}
-
-export function findCliPaths(this:MixCli,packageName?:string ,entry?:string):string[]{
-    const includeMacher = this.options.include
-    const excludeMacher = this.options.exclude
-    if(!includeMacher) return []
-    const packageRoot = getPackageRootPath(entry || process.cwd())
-    const packagePath = packageName ? path.dirname(require.resolve(packageName,{paths:[packageRoot as string]})) : packageRoot
-
-    if(!packagePath) {
-        outputDebug("MixCli只能运行在Nodejs环境" )
-        return []
-    }
-
-    // 找出当前包的所有依赖
-    const packageNames = getMatchedDependencies.call(this,packagePath)
-
-    const cliDirs:string[]=[]
-    
-    if(entry!==undefined) cliDirs.push(path.join(packagePath,this.options.cliDir))
-    packageNames.filter(name=>{
-            return  isMatched(name,includeMacher) && !isMatched(name,excludeMacher) 
-        })
-        .forEach(name=>{
-            outputDebug("匹配包:{}",`${packageName ? name+" <- "+packageName  : name}`)
-            try{
-                const packageEntry = path.dirname(require.resolve(name,{paths:packagePath ? [packagePath] : [process.cwd()]}))
-                const packageCliDir =path.join(packageEntry,this.options.cliDir!)                
-                // 查找当前包的所属工程的依赖
-                let dependencies = getMatchedDependencies.call(this,packageEntry)
-                cliDirs.push(...dependencies.reduce<string[]>((result,dependencie)=>{
-                    outputDebug("匹配包:{}",`${dependencie} <- ${name}`)
-                    result.push(...findCliPaths.call(this,dependencie,packageEntry))
-                    return result
-                },[])) 
-                if(fs.existsSync(packageCliDir)){
-                    cliDirs.push(packageCliDir)
-                }
-            }catch(e:any){
-                outputDebug("解析包<{}>路径出错：{}",[name,e.stack])
-            }    
-        })
-    // 由于一些包可能存在循环依赖，所以需要去重
-    return [...new Set(cliDirs)]
-}
-
-
-/**
- * 
- *  扫描当前工程中所有符合条件的命令
- * 
- * @param cli 
- * 
- */
-export async function findCommands(cli:MixCli){ 
-    const cliDirs =  findCliPaths.call(cli)
-    const commands:MixCliCommand[] = []
-    const files = [] as string[]
-    cliDirs.forEach(dir=>{
-        globSync("*",{
-            cwd:dir,
-            absolute :true 
-        }).forEach((file:string)=>{  
-            const baseName = path.basename(file)       
-            if(baseName.startsWith("_")) return
-            const ext = path.extname(file).toLowerCase()
-            if([".js",".cjs",".mjs"].includes(ext)){
-                files.push(file)
-            }else if(fs.statSync(file).isDirectory()){
-                files.push(path.join(file,"index.js"))
-                files.push(path.join(file,"index.cjs"))
-                files.push(path.join(file,"index.mjs"))
-            }
-        })
-    })
-    for(let file of files){    
-       if(!fs.existsSync(file)) continue
-        try{
-            outputDebug("导入命令:{}",file)
-            if(file.endsWith(".cjs") || file.endsWith(".js")){
-                commands.push(await importModule(file))
-            }else if(file.endsWith(".mjs")){
-                const cmd = await import(`file://${file}`)
-                commands.push(cmd.default)
-            }            
-        }catch(e:any){
-            outputDebug(e) 
-        }
-    }
-    return commands
-}
-
+import { getPackageJson } from  "flex-tools/package/getPackageJson"
+import { getPackageRootPath } from 'flex-tools/package/getPackageRootPath';
+import type { MixCli } from './cli';
+import {  globSync } from 'glob'
+import { MixCliCommand } from './cli';
+import { importModule, outputDebug } from './utils';
+import fs from "node:fs"
+import path from "node:path"
+
+
+/**
+ * 
+ * 在当前工程中查找符合FlexCli.prefix约定的命令 
+ *  
+ * - 读取当前包的package.json
+ * - 找出所有以cli.prefix开头的依赖
+ * - 加载这些依赖的目录下的匹配cli.pattern的命令
+ * - 加载加载这样命令
+ * 
+ */
+ 
+
+export function getMatchedDependencies(this:MixCli,entry:string):string[]{
+    const pacakgeMacher = this.options.include
+    if(!(pacakgeMacher instanceof RegExp)) return  []
+    
+    // 找出当前包的所有依赖
+    const { dependencies={},devDependencies={},peerDependencies={},optionalDependencies={},bundleDependencies={} } = getPackageJson(entry)
+    const packageNames = [
+        ...Object.keys(dependencies),
+        ...Object.keys(devDependencies),
+        ...Object.keys(peerDependencies),
+        ...Object.keys(optionalDependencies),
+        ...Object.keys(bundleDependencies)
+    ]
+    return packageNames.filter(name=>name!=="@voerka/cli" && pacakgeMacher.test(name))
+}
+
+function isMatched(str:string,reg?:string | RegExp | string[] | RegExp[]):boolean{
+    // let regexps:RegExp[]=[]
+    const regexps = reg ? (Array.isArray(reg) ? reg : [reg]) : []
+    return regexps.some(regexp=>{
+        if(typeof regexp === "string"){
+            return (new RegExp(regexp)).test(str)
+        }else if(regexp instanceof RegExp){
+            return regexp.test(str)
+        }else{
+            return false
+        }
+    })
+}
+
+export function findCliPaths(this:MixCli,packageName?:string ,entry?:string):string[]{
+    const includeMacher = this.options.include
+    const excludeMacher = this.options.exclude
+    if(!includeMacher) return []
+    const packageRoot = getPackageRootPath(entry || process.cwd())
+    const packagePath = packageName ? path.dirname(require.resolve(packageName,{paths:[packageRoot as string]})) : packageRoot
+
+    if(!packagePath) {
+        outputDebug("MixCli只能运行在Nodejs环境" )
+        return []
+    }
+
+    // 找出当前包的所有依赖
+    const packageNames = getMatchedDependencies.call(this,packagePath)
+
+    const cliDirs:string[]=[]
+    
+    if(entry!==undefined) cliDirs.push(path.join(packagePath,this.options.cliDir))
+    packageNames.filter(name=>{
+            return  isMatched(name,includeMacher) && !isMatched(name,excludeMacher) 
+        })
+        .forEach(name=>{
+            outputDebug("匹配包:{}",`${packageName ? name+" <- "+packageName  : name}`)
+            try{
+                const packageEntry = path.dirname(require.resolve(name,{paths:packagePath ? [packagePath] : [process.cwd()]}))
+                const packageCliDir =path.join(packageEntry,this.options.cliDir!)                
+                // 查找当前包的所属工程的依赖
+                let dependencies = getMatchedDependencies.call(this,packageEntry)
+                cliDirs.push(...dependencies.reduce<string[]>((result,dependencie)=>{
+                    outputDebug("匹配包:{}",`${dependencie} <- ${name}`)
+                    result.push(...findCliPaths.call(this,dependencie,packageEntry))
+                    return result
+                },[])) 
+                if(fs.existsSync(packageCliDir)){
+                    cliDirs.push(packageCliDir)
+                }
+            }catch(e:any){
+                outputDebug("解析包<{}>路径出错：{}",[name,e.stack])
+            }    
+        })
+    // 由于一些包可能存在循环依赖，所以需要去重
+    return [...new Set(cliDirs)]
+}
+
+
+/**
+ * 
+ *  扫描当前工程中所有符合条件的命令
+ * 
+ * @param cli 
+ * 
+ */
+export async function findCommands(cli:MixCli){ 
+    const cliDirs =  findCliPaths.call(cli)
+    const commands:MixCliCommand[] = []
+    const files = [] as string[]
+    cliDirs.forEach(dir=>{
+        globSync("*",{
+            cwd:dir,
+            absolute :true 
+        }).forEach((file:string)=>{  
+            const baseName = path.basename(file)       
+            if(baseName.startsWith("_")) return
+            const ext = path.extname(file).toLowerCase()
+            if([".js",".cjs",".mjs"].includes(ext)){
+                files.push(file)
+            }else if(fs.statSync(file).isDirectory()){
+                files.push(path.join(file,"index.js"))
+                files.push(path.join(file,"index.cjs"))
+                files.push(path.join(file,"index.mjs"))
+            }
+        })
+    })
+    for(let file of files){    
+       if(!fs.existsSync(file)) continue
+        try{
+            outputDebug("导入命令:{}",file)
+            if(file.endsWith(".cjs") || file.endsWith(".js")){
+                commands.push(await importModule(file))
+            }else if(file.endsWith(".mjs")){
+                const cmd = await import(`file://${file}`)
+                commands.push(cmd.default)
+            }            
+        }catch(e:any){
+            outputDebug(e) 
+        }
+    }
+    return commands
+}
+

package/src/index.ts

@@ -1,4 +1,5 @@
-export * from "./cli"
-export * from "./utils"
-export * from "./command"
-export * from "./option"
+export * from "./cli"
+export * from "./utils"
+export * from "./command"
+export * from "./option"
+export * from "./prompt"

package/src/option.ts

@@ -1,99 +1,57 @@
-import { Option } from 'commander'
+import { Option, OptionValues } from 'commander'
 import { PromptObject } from 'prompts'
-import { IPromptable, IPromptableOptions, PromptChoice, PromptManager } from './prompt'
+import {  PromptChoice, MixOptionPrompt,PromptParams } from  './prompt'
+ 
 
-
-export interface MixedOptionParams extends IPromptableOptions{
-    hidden?:boolean
-    defaultDescription?:string          // 默认值的描述    
-    conflicts?:string | string[]
-    env?:string
-    argParser?:<T>(value: string, previous: T) => T 
-    hideHelp?:boolean
-    mandatory?: boolean 
-    implies?:{[key:string]:any}  
+export interface MixedOptionParams {
+    required?               : boolean; // A value must be supplied when the option is specified.
+    optional?               : boolean; // A value is optional when the option is specified.
+    variadic?               : boolean; 
+    mandatory?              : boolean; // The option must have a value after parsing, which usually means it must be specified on command line.
+    negate?                 : boolean;
+    default?                : any;
+    defaultDescription?     : string;
+    conflicts?              : string | string[];
+    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
 }
 
 
-export class MixOption extends Option implements IPromptable{
+export class MixOption extends Option{
     __MIX_OPTION__ = true
-    // 是否提示用户输入
-    prompt?: PromptManager     
-    promptChoices?:PromptChoice[]
-    private _validate?: (value: any) => boolean       
-    constructor(flags: string, description?: string | undefined,optsOrDefault?:any) {
-        super(flags, description)
-        let params:MixedOptionParams = {}
-        if(arguments.length==3 && typeof arguments[2] == "object"){
-            params = Object.assign({ },arguments[2])  
-        }else if(arguments.length==3){
-            params.default = arguments[2]
-        }
-        if(params.prompt===undefined) params.prompt = 'auto'
+    prompt?                 : MixOptionPrompt      
+    constructor(flags: string, description: string,public params?: MixedOptionParams) {
+        super(flags, description)                
+        this._setOption(params || {})        
+        this.prompt = new MixOptionPrompt(this,params?.prompt)    
+    } 
+    private _setOption(params:MixedOptionParams){        
         if(params.default) this.default(params.default,params.defaultDescription)
-        if(params.choices) this.choices(params.choices)
         if(params.conflicts) this.conflicts(params.conflicts)
-        if(params.env) this.env(params.env)
-        if(params.argParser) this.argParser(params.argParser)
-        if(params.hideHelp) this.hideHelp(params.hideHelp)
+        if(params.envVar) this.env(params.envVar)
+        if(params.parseArg) this.argParser(params.parseArg) 
         if(params.hidden) this.hidden = params.hidden
         if(params.mandatory) this.makeOptionMandatory(params.mandatory)
         if(params.implies) this.implies(params.implies) 
         if(params.optional) this.optional=params.optional
-        if(typeof(params.validate)=='function') this._validate = params.validate.bind(this)
-        if(params.required) {
-            this.required = params.required
-            if(!this._validate ) this._validate  = (value:any)=>String(value).length>0
-        }
-        this.prompt = new PromptManager(this as IPromptable,params.prompt)
-    } 
-    validate(value: any): boolean {
-        if(typeof(this._validate)=='function'){
-            return this._validate(value)
-        }else{
-            return true
-        }
-    }
-    // @ts-ignore
-    choices(values:(PromptChoice | string)[]){
-        if(!this.promptChoices){
-            this.promptChoices = values.map(choice=>{
-                if(typeof(choice)=='object'){
-                    return choice
-                }else{
-                    return {title:choice,value:choice}                    
-                }
-            })
-        }        
-        super.choices(this.promptChoices.map((item:any)=>item.value))    
-    }    
-
-    private resetChoices(){
-        super.choices(this.promptChoices!.map((item:any)=>item.value))    
-    }
-
-    addChoice(value:PromptChoice | string){
-        if(!this.promptChoices || !Array.isArray(this.promptChoices)) this.promptChoices = []
-        this.promptChoices!.push(typeof(value)=='string' ? {title:value,value} : value)
-        this.resetChoices()
-    }
-    removeChoice(value:any){
-        this.promptChoices =this.promptChoices?.filter(choice=>choice.value!==value)
-        this.resetChoices()
-    }
-    clearChoice(){
-        this.promptChoices = []
-        this.resetChoices()
-    }
-
-        
+        if(params.variadic) this.variadic = params.variadic
+        if(params.negate) this.negate = params.negate
+        if(params.preset) this.preset(params.preset)
+        if(params.required) this.required = params.required   
+        if(Array.isArray(params.choices)) this.choices(params.choices.map(choice=>typeof(choice)=='string' ? choice : choice.value))
+    }  
+    
     /**
      * 返回选项的提示对象
      * 
-     * @remarks
-     * 
-     *
-     * 
+     * @remarks 
      * @param inputValue 
      * @returns 
      */