@midwayjs/commander 4.0.0-beta.2 → 4.0.0

package/dist/enquirerService.d.ts

@@ -0,0 +1,17 @@
+import { QuestionValue } from './question';
+export interface PromptResult {
+    [key: string]: QuestionValue;
+}
+type QuestionSetModule = new (...args: unknown[]) => object;
+export declare class EnquirerService {
+    private applicationContext;
+    prompt<T extends PromptResult = PromptResult>(questionSet: string, initialAnswers?: PromptResult): Promise<T>;
+    prompt<T extends PromptResult = PromptResult>(questionSet: QuestionSetModule, initialAnswers?: PromptResult): Promise<T>;
+    private resolveQuestionSetModule;
+    private buildQuestions;
+    private applyQuestionFor;
+    private runQuestions;
+    private resolveWhen;
+}
+export {};
+//# sourceMappingURL=enquirerService.d.ts.map

package/dist/enquirerService.js

@@ -0,0 +1,135 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnquirerService = void 0;
+const core_1 = require("@midwayjs/core");
+const enquirer = require("enquirer");
+const question_1 = require("./question");
+let EnquirerService = class EnquirerService {
+    applicationContext;
+    async prompt(questionSet, initialAnswers = {}) {
+        // Resolve question set by name or class reference.
+        const questionSetModule = this.resolveQuestionSetModule(questionSet);
+        const questionSetInstance = (await this.applicationContext.getAsync(questionSetModule));
+        // Build enquirer questions from decorators.
+        const questions = this.buildQuestions(questionSetModule, questionSetInstance);
+        const answers = await this.runQuestions(questions, initialAnswers);
+        return answers;
+    }
+    resolveQuestionSetModule(questionSet) {
+        if (typeof questionSet !== 'string') {
+            return questionSet;
+        }
+        const questionSetName = questionSet;
+        const modules = core_1.DecoratorManager.listModule(question_1.CLI_QUESTION_SET_KEY);
+        for (const module of modules) {
+            const metadata = core_1.MetadataManager.getMetadata(question_1.CLI_QUESTION_SET_KEY, module);
+            if (metadata?.name === questionSetName) {
+                return module;
+            }
+        }
+        throw new core_1.MidwayCommonError(`QuestionSet "${questionSetName}" not found`);
+    }
+    buildQuestions(module, instance) {
+        const questionMetaList = core_1.MetadataManager.getMetadata(question_1.CLI_QUESTION_KEY, module) || [];
+        const questionForMetaList = core_1.MetadataManager.getMetadata(question_1.CLI_QUESTION_FOR_KEY, module) || [];
+        return questionMetaList.map(meta => {
+            const question = {
+                ...meta.options,
+            };
+            if (!question.name) {
+                throw new core_1.MidwayCommonError(`Question name is required in ${module?.name || 'QuestionSet'}`);
+            }
+            const candidate = instance[meta.propertyKey];
+            const handler = typeof candidate === 'function'
+                ? candidate.bind(instance)
+                : undefined;
+            if (handler) {
+                // Question method acts as enquirer "result" transformer.
+                question.result = handler;
+            }
+            const forHandlers = questionForMetaList.filter(item => item.options?.name === question.name);
+            for (const forMeta of forHandlers) {
+                const forCandidate = instance[forMeta.propertyKey];
+                const bound = typeof forCandidate === 'function'
+                    ? forCandidate.bind(instance)
+                    : undefined;
+                if (bound !== undefined) {
+                    this.applyQuestionFor(question, forMeta.type, bound);
+                }
+            }
+            if (question.default !== undefined && question.initial === undefined) {
+                // Align "default" with enquirer "initial".
+                question.initial = question.default;
+                delete question.default;
+            }
+            return question;
+        });
+    }
+    applyQuestionFor(question, type, handler) {
+        switch (type) {
+            case 'default':
+                question.initial = handler;
+                return;
+            case 'validate':
+                question.validate = handler;
+                return;
+            case 'choices':
+                question.choices = handler;
+                return;
+            case 'message':
+                question.message = handler;
+                return;
+            case 'when':
+                question.when = handler;
+                return;
+            default:
+                return;
+        }
+    }
+    async runQuestions(questions, initialAnswers) {
+        const answers = { ...initialAnswers };
+        for (const question of questions) {
+            // Evaluate "when" with accumulated answers to decide whether to ask.
+            const shouldAsk = await this.resolveWhen(question.when, answers);
+            if (!shouldAsk) {
+                continue;
+            }
+            const currentQuestion = { ...question };
+            delete currentQuestion.when;
+            if (!currentQuestion.type) {
+                throw new core_1.MidwayCommonError(`Question "${currentQuestion.name}" type is required`);
+            }
+            const result = await enquirer.prompt(currentQuestion);
+            Object.assign(answers, result);
+        }
+        return answers;
+    }
+    async resolveWhen(whenValue, answers) {
+        if (typeof whenValue === 'function') {
+            return Boolean(await whenValue(answers));
+        }
+        if (typeof whenValue === 'boolean') {
+            return whenValue;
+        }
+        return true;
+    }
+};
+exports.EnquirerService = EnquirerService;
+__decorate([
+    (0, core_1.ApplicationContext)(),
+    __metadata("design:type", Object)
+], EnquirerService.prototype, "applicationContext", void 0);
+exports.EnquirerService = EnquirerService = __decorate([
+    (0, core_1.Provide)(),
+    (0, core_1.Scope)(core_1.ScopeEnum.Singleton)
+], EnquirerService);
+//# sourceMappingURL=enquirerService.js.map

package/dist/framework.d.ts

@@ -1,7 +1,7 @@
 import { BaseFramework, IMidwayBootstrapOptions } from '@midwayjs/core';
-import { ICommanderConfigurationOptions, IMidwayCommanderApplication, IMidwayContext } from './interface';
+import { ICommanderConfigurationOptions, IMidwayCommanderApplication, IMidwayCommanderContext } from './interface';
 import { Command } from 'commander';
-export declare class MidwayCommanderFramework extends BaseFramework<IMidwayCommanderApplication, IMidwayContext, ICommanderConfigurationOptions> {
+export declare class MidwayCommanderFramework extends BaseFramework<IMidwayCommanderApplication, IMidwayCommanderContext, ICommanderConfigurationOptions> {
     app: IMidwayCommanderApplication;
     protected frameworkLoggerName: string;
     private program;
@@ -16,6 +16,8 @@ export declare class MidwayCommanderFramework extends BaseFramework<IMidwayComma
      * 从而避免测试环境（Jest/Node）对命令行参数的污染。
      */
     runCommand(...args: string[]): Promise<Command>;
+    private handleError;
+    private isCommanderHelpExit;
     private outputResult;
     private outputChunk;
     private isReadableLike;

package/dist/framework.js

@@ -31,7 +31,7 @@ let MidwayCommanderFramework = class MidwayCommanderFramework extends core_1.Bas
             await this.program.parseAsync(process.argv);
         }
         catch (error) {
-            void error;
+            this.handleError(error, true);
         }
     }
     /**
@@ -42,7 +42,31 @@ let MidwayCommanderFramework = class MidwayCommanderFramework extends core_1.Bas
      */
     async runCommand(...args) {
         this.loadCommands();
-        return this.program.parseAsync(args, { from: 'user' });
+        try {
+            return await this.program.parseAsync(args, { from: 'user' });
+        }
+        catch (error) {
+            this.handleError(error, false);
+            throw error;
+        }
+    }
+    handleError(error, useDefault) {
+        const err = error instanceof Error ? error : new Error(String(error));
+        const handler = this.configurationOptions?.errorHandler ??
+            (useDefault
+                ? (err) => {
+                    if (this.isCommanderHelpExit(err)) {
+                        return;
+                    }
+                    this.logger.error(err);
+                    process.exit(1);
+                }
+                : undefined);
+        handler?.(err);
+    }
+    isCommanderHelpExit(err) {
+        const code = err?.code;
+        return code === 'commander.help' || code === 'commander.version';
     }
     async outputResult(result) {
         if (result == null) {
@@ -133,14 +157,62 @@ let MidwayCommanderFramework = class MidwayCommanderFramework extends core_1.Bas
                 }
             }
             cmd.action(async (...args) => {
-                const commandInstance = (await this.applicationContext.getAsync(module));
                 const commandObj = args[args.length - 1];
                 const actualArgs = args.slice(0, -2);
                 const actualOptions = commandObj.opts();
-                if (commandInstance.run) {
-                    const result = await commandInstance.run(actualArgs, actualOptions);
-                    await this.outputResult(result);
-                }
+                const ctx = this.app.createAnonymousContext({
+                    command: commandObj,
+                    args: actualArgs,
+                    options: actualOptions,
+                    commandName: metadata.name,
+                });
+                ctx.command = commandObj;
+                ctx.args = actualArgs;
+                ctx.options = actualOptions;
+                ctx.commandName = metadata.name;
+                const traceService = this.applicationContext.get(core_1.MidwayTraceService);
+                const traceMetaResolver = this.configurationOptions?.tracing
+                    ?.meta;
+                const traceEnabled = this.configurationOptions?.tracing?.enable !== false;
+                const traceExtractor = this.configurationOptions?.tracing
+                    ?.extractor;
+                const entryCarrier = typeof traceExtractor === 'function'
+                    ? traceExtractor({
+                        ctx,
+                        custom: {
+                            commandName: metadata.name,
+                            args: actualArgs,
+                            options: actualOptions,
+                        },
+                    })
+                    : {};
+                const result = await traceService.runWithEntrySpan(`commander ${metadata.name}`, {
+                    enable: traceEnabled,
+                    carrier: entryCarrier,
+                    attributes: {
+                        'midway.protocol': 'commander',
+                        'midway.command.name': metadata.name,
+                    },
+                    meta: traceMetaResolver,
+                    metaArgs: {
+                        ctx,
+                        carrier: entryCarrier,
+                        custom: {
+                            commandName: metadata.name,
+                            args: actualArgs,
+                            options: actualOptions,
+                        },
+                    },
+                }, async () => {
+                    const fn = await this.applyMiddleware(async (ctx) => {
+                        const commandInstance = (await ctx.requestContext.getAsync(module));
+                        if (commandInstance.run) {
+                            return await commandInstance.run(actualArgs, actualOptions);
+                        }
+                    });
+                    return await fn(ctx);
+                });
+                await this.outputResult(result);
             });
         }
         this.isCommandsLoaded = true;

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 export * from './interface';
 export * from './decorator';
+export * from './question';
+export * from './enquirerService';
 export * from './response';
 export { MidwayCommanderFramework as Framework } from './framework';
 export { CommanderConfiguration as Configuration } from './configuration';

package/dist/index.js

@@ -17,6 +17,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Configuration = exports.Framework = void 0;
 __exportStar(require("./interface"), exports);
 __exportStar(require("./decorator"), exports);
+__exportStar(require("./question"), exports);
+__exportStar(require("./enquirerService"), exports);
 __exportStar(require("./response"), exports);
 var framework_1 = require("./framework");
 Object.defineProperty(exports, "Framework", { enumerable: true, get: function () { return framework_1.MidwayCommanderFramework; } });

package/dist/interface.d.ts

@@ -1,10 +1,18 @@
 import { IConfigurationOptions, IMidwayApplication, IMidwayContext } from '@midwayjs/core';
+import { Command } from 'commander';
 export { IMidwayContext } from '@midwayjs/core';
 export interface ICommanderConfigurationOptions extends IConfigurationOptions {
+    errorHandler?: (err: Error) => void;
 }
-export type IMidwayCommanderApplication = IMidwayApplication<IMidwayContext>;
+export interface IMidwayCommanderContext extends IMidwayContext {
+    command?: Command;
+    args?: string[];
+    options?: Record<string, any>;
+    commandName?: string;
+}
+export type IMidwayCommanderApplication = IMidwayApplication<IMidwayCommanderContext>;
 export type Application = IMidwayCommanderApplication;
-export type Context = IMidwayContext;
+export type Context = IMidwayCommanderContext;
 export interface CommandRunner {
     run(passedParams: string[], options?: Record<string, any>): unknown | Promise<unknown>;
 }

package/dist/question.d.ts

@@ -0,0 +1,46 @@
+export declare const CLI_QUESTION_SET_KEY = "commander:questionSet";
+export declare const CLI_QUESTION_KEY = "commander:question";
+export declare const CLI_QUESTION_FOR_KEY = "commander:questionFor";
+export interface QuestionSetOptions {
+    name?: string;
+}
+export type QuestionValue = unknown;
+export type QuestionWhen = (answers: Record<string, QuestionValue>) => boolean | Promise<boolean>;
+export type QuestionValidate = (value: QuestionValue, answers?: Record<string, QuestionValue>) => boolean | string | Promise<boolean | string>;
+export type QuestionChoices = Array<unknown> | ((answers?: Record<string, QuestionValue>) => Array<unknown> | Promise<Array<unknown>>);
+export type QuestionMessage = string | ((answers?: Record<string, QuestionValue>) => string | Promise<string>);
+export type QuestionInitial = QuestionValue | ((answers?: Record<string, QuestionValue>) => QuestionValue | Promise<QuestionValue>);
+export type QuestionResult = (value: QuestionValue, answers?: Record<string, QuestionValue>) => QuestionValue | Promise<QuestionValue>;
+export interface QuestionOptions {
+    name: string;
+    type?: string;
+    message?: QuestionMessage;
+    choices?: QuestionChoices;
+    validate?: QuestionValidate;
+    when?: QuestionWhen | boolean;
+    default?: QuestionInitial;
+    initial?: QuestionInitial;
+    result?: QuestionResult;
+    [key: string]: unknown;
+}
+export interface QuestionMeta {
+    propertyKey: string | symbol;
+    options: QuestionOptions;
+}
+export type QuestionForType = 'validate' | 'choices' | 'message' | 'default' | 'when';
+export interface QuestionForOptions {
+    name: string;
+}
+export interface QuestionForMeta {
+    propertyKey: string | symbol;
+    options: QuestionForOptions;
+    type: QuestionForType;
+}
+export declare function QuestionSet(options?: QuestionSetOptions): ClassDecorator;
+export declare function Question(options: QuestionOptions): MethodDecorator;
+export declare function ValidateFor(options: QuestionForOptions): MethodDecorator;
+export declare function ChoicesFor(options: QuestionForOptions): MethodDecorator;
+export declare function MessageFor(options: QuestionForOptions): MethodDecorator;
+export declare function DefaultFor(options: QuestionForOptions): MethodDecorator;
+export declare function WhenFor(options: QuestionForOptions): MethodDecorator;
+//# sourceMappingURL=question.d.ts.map

package/dist/question.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CLI_QUESTION_FOR_KEY = exports.CLI_QUESTION_KEY = exports.CLI_QUESTION_SET_KEY = void 0;
+exports.QuestionSet = QuestionSet;
+exports.Question = Question;
+exports.ValidateFor = ValidateFor;
+exports.ChoicesFor = ChoicesFor;
+exports.MessageFor = MessageFor;
+exports.DefaultFor = DefaultFor;
+exports.WhenFor = WhenFor;
+const core_1 = require("@midwayjs/core");
+exports.CLI_QUESTION_SET_KEY = 'commander:questionSet';
+exports.CLI_QUESTION_KEY = 'commander:question';
+exports.CLI_QUESTION_FOR_KEY = 'commander:questionFor';
+function QuestionSet(options = {}) {
+    return (target) => {
+        core_1.DecoratorManager.saveModule(exports.CLI_QUESTION_SET_KEY, target);
+        core_1.MetadataManager.defineMetadata(exports.CLI_QUESTION_SET_KEY, options, target);
+        (0, core_1.Scope)(core_1.ScopeEnum.Singleton)(target);
+    };
+}
+function Question(options) {
+    return (target, propertyKey, _descriptor) => {
+        void _descriptor;
+        core_1.MetadataManager.attachMetadata(exports.CLI_QUESTION_KEY, {
+            propertyKey,
+            options,
+        }, target.constructor);
+    };
+}
+function ValidateFor(options) {
+    return (target, propertyKey, descriptor) => {
+        void descriptor;
+        core_1.MetadataManager.attachMetadata(exports.CLI_QUESTION_FOR_KEY, {
+            propertyKey,
+            type: 'validate',
+            options,
+        }, target.constructor);
+    };
+}
+function ChoicesFor(options) {
+    return (target, propertyKey, descriptor) => {
+        void descriptor;
+        core_1.MetadataManager.attachMetadata(exports.CLI_QUESTION_FOR_KEY, {
+            propertyKey,
+            type: 'choices',
+            options,
+        }, target.constructor);
+    };
+}
+function MessageFor(options) {
+    return (target, propertyKey, descriptor) => {
+        void descriptor;
+        core_1.MetadataManager.attachMetadata(exports.CLI_QUESTION_FOR_KEY, {
+            propertyKey,
+            type: 'message',
+            options,
+        }, target.constructor);
+    };
+}
+function DefaultFor(options) {
+    return (target, propertyKey, descriptor) => {
+        void descriptor;
+        core_1.MetadataManager.attachMetadata(exports.CLI_QUESTION_FOR_KEY, {
+            propertyKey,
+            type: 'default',
+            options,
+        }, target.constructor);
+    };
+}
+function WhenFor(options) {
+    return (target, propertyKey, descriptor) => {
+        void descriptor;
+        core_1.MetadataManager.attachMetadata(exports.CLI_QUESTION_FOR_KEY, {
+            propertyKey,
+            type: 'when',
+            options,
+        }, target.constructor);
+    };
+}
+//# sourceMappingURL=question.js.map

package/dist/response.d.ts

@@ -1,6 +1,7 @@
-import { IMidwayContext, ServerResponse, ServerStreamOptions } from '@midwayjs/core';
+import { ServerResponse, ServerStreamOptions } from '@midwayjs/core';
 import { Transform } from 'stream';
-export declare class CliStreamResponse<CTX extends IMidwayContext = IMidwayContext> extends Transform {
+import { IMidwayCommanderContext } from './interface';
+export declare class CliStreamResponse<CTX extends IMidwayCommanderContext = IMidwayCommanderContext> extends Transform {
     private readonly ctx;
     private readonly options;
     constructor(ctx: CTX, options?: ServerStreamOptions<CTX>);
@@ -8,8 +9,8 @@ export declare class CliStreamResponse<CTX extends IMidwayContext = IMidwayConte
     send(data: unknown): void;
     sendError(error: Error): void;
 }
-export declare class CliServerResponse<CTX extends IMidwayContext = IMidwayContext> extends ServerResponse<CTX> {
-    static STREAM_TPL: <CTX_1 extends IMidwayContext>(data: unknown, _ctx: CTX_1) => unknown;
+export declare class CliServerResponse<CTX extends IMidwayCommanderContext = IMidwayCommanderContext> extends ServerResponse<CTX> {
+    static STREAM_TPL: <CTX_1 extends IMidwayCommanderContext>(data: unknown, _ctx: CTX_1) => unknown;
     stream(options?: ServerStreamOptions<CTX>): CliStreamResponse<any>;
 }
 //# sourceMappingURL=response.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/commander",
-  "version": "4.0.0-beta.2",
+  "version": "4.0.0",
   "description": "Midway Commander Framework",
   "main": "dist/index.js",
   "typings": "index.d.ts",
@@ -15,22 +15,24 @@
     "dist/**/*.d.ts",
     "index.d.ts"
   ],
+  "scripts": {
+    "build": "tsc",
+    "test": "node -r ts-node/register ../../node_modules/jest/bin/jest.js --runInBand",
+    "cov": "node -r ts-node/register ../../node_modules/jest/bin/jest.js --runInBand --coverage --forceExit",
+    "ci": "npm run test",
+    "lint": "mwts check"
+  },
   "dependencies": {
-    "commander": "14.0.2",
-    "@midwayjs/core": "^4.0.0-beta.9"
+    "@midwayjs/core": "^4.0.0",
+    "commander": "14.0.3",
+    "enquirer": "2.4.1"
   },
   "devDependencies": {
-    "@midwayjs/mock": "^4.0.0-beta.9"
+    "@midwayjs/mock": "^4.0.0"
   },
   "engines": {
     "node": ">=20"
   },
   "license": "MIT",
-  "scripts": {
-    "build": "tsc",
-    "test": "node -r ts-node/register ../../node_modules/jest/bin/jest.js --runInBand",
-    "cov": "node -r ts-node/register ../../node_modules/jest/bin/jest.js --runInBand --coverage --forceExit",
-    "ci": "npm run test",
-    "lint": "mwts check"
-  }
-}
+  "gitHead": "014f32c23ebc1d5ac21777c76be2fd373ce992d8"
+}