@serverless-devs/engine 0.0.1-beta.3 → 0.0.1-beta.30

package/lib/actions/index.d.ts

@@ -14,9 +14,88 @@ declare class Actions {
     private inputs;
     constructor(actions?: IAction[], option?: IOptions);
     setValue(key: string, value: any): void;
-    start(hookType: `${IHookType}`, inputs?: Record<string, any>): Promise<Record<string, any>>;
+    /**
+     * Initiates the execution of actions based on the given hook type.
+     *
+     * This function will attempt to execute the appropriate actions based on the hook type provided.
+     * If there's an error during the process, especially for GLOBAL hook level, it logs the failure.
+     *
+     * @param hookType The type of hook (e.g. PRE, POST) that determines which actions should be executed.
+     * @param inputs Optional inputs that might be used during the execution of actions.
+     * @returns Returns a record containing relevant data from the execution.
+     *
+     * @throws {DevsError} Throws a DevsError if there's an error during the action execution.
+     *
+     * @example
+     * const result = await actionsInstance.start('pre');
+     */
+    start(hookType: `${IHookType}`, inputs?: Record<string, any>): Promise<{}>;
+    /**
+     * Executes actions post the initial starting phase based on the given hook type.
+     *
+     * This is an internal function primarily used after the initial start of the actions
+     * to handle the actual execution of the actions based on the hook type.
+     * It filters the actions to be executed based on the hook type, logs their start,
+     * and then dispatches them to their respective handler methods based on their action type.
+     *
+     * @private
+     *
+     * @param {string} hookType - The type of hook (e.g. PRE, POST) determining which actions should be executed.
+     * @param {Record<string, any>} [inputs={}] - Optional inputs that might be used during the execution of actions.
+     *
+     * @returns {Promise<Record<string, any>>} - Returns a record containing relevant data from the execution.
+     *
+     * @throws {DevsError} - Throws a DevsError if there's an error during the action execution.
+     *
+     * @example
+     * const result = await actionsInstance.afterStart('PRE');
+     */
+    private afterStart;
+    /**
+     * Monitors the completion of a given command process.
+     *
+     * @param cp - The command process to be monitored.
+     *
+     * @returns Promise<object> - Resolves with an empty object if the command process completes successfully.
+     *                            Rejects with an error if the command process encounters an error.
+     */
+    private onFinish;
+    /**
+     * Executes the action specified by the provided hook.
+     *
+     * @param hook - The action hook specifying the command to run and its associated configurations.
+     *
+     * @throws DevsError - Throws an error if the command execution fails or if the specified directory does not exist.
+     *
+     * @returns Promise<void> - Resolves once the command has been executed.
+     */
     private run;
+    /**
+     * Loads and executes a specified plugin.
+     *
+     * This function attempts to load a plugin component, then invokes it with the appropriate inputs.
+     * If the plugin execution fails and the failure is allowed (based on the record's allowFailure setting),
+     * it gracefully handles the error without throwing. Otherwise, it throws a DevsError.
+     *
+     * @param hook - An object representing the plugin action to be executed.
+     *
+     * @throws DevsError - Throws a DevsError if the plugin execution fails and the failure is not allowed.
+     */
     private plugin;
+    /**
+     * Loads and executes a specified component command.
+     *
+     * This function tries to load a given component and run the specified command for it.
+     * If the component command execution fails and the failure is allowed (based on the record's allowFailure setting),
+     * it gracefully handles the error without throwing. If the command does not exist for the component,
+     * it throws an error indicating the missing command.
+     *
+     * @param hook - An object representing the component action to be executed.
+     *
+     * @throws DevsError - Throws a DevsError if:
+     *                     1. The component command execution fails and the failure is not allowed.
+     *                     2. The specified command does not exist for the component.
+     */
     private component;
 }
 export default Actions;

package/lib/actions/index.js

@@ -38,12 +38,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const parse_spec_1 = require("@serverless-devs/parse-spec");
 const lodash_1 = require("lodash");
 const utils = __importStar(require("@serverless-devs/utils"));
+const utils_1 = require("@serverless-devs/utils");
 const fs_extra_1 = __importDefault(require("fs-extra"));
-const execa_1 = __importDefault(require("execa"));
+const execa_1 = require("execa");
 const load_component_1 = __importDefault(require("@serverless-devs/load-component"));
 const string_argv_1 = __importDefault(require("string-argv"));
-const utils_1 = require("../utils");
+const utils_2 = require("../utils");
 const chalk_1 = __importDefault(require("chalk"));
+const constants_1 = require("../constants");
 const debug = require('@serverless-cd/debug')('serverless-devs:engine');
 class Actions {
     constructor(actions = [], option = {}) {
@@ -53,25 +55,80 @@ class Actions {
         this.inputs = {};
         this.logger = option.logger;
     }
+    // Set value to the record of the action.
     setValue(key, value) {
         if (this.option.skipActions)
             return;
         (0, lodash_1.set)(this.record, key, value);
     }
+    /**
+     * Initiates the execution of actions based on the given hook type.
+     *
+     * This function will attempt to execute the appropriate actions based on the hook type provided.
+     * If there's an error during the process, especially for GLOBAL hook level, it logs the failure.
+     *
+     * @param hookType The type of hook (e.g. PRE, POST) that determines which actions should be executed.
+     * @param inputs Optional inputs that might be used during the execution of actions.
+     * @returns Returns a record containing relevant data from the execution.
+     *
+     * @throws {DevsError} Throws a DevsError if there's an error during the action execution.
+     *
+     * @example
+     * const result = await actionsInstance.start('pre');
+     */
     start(hookType, inputs = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return yield this.afterStart(hookType, inputs);
+            }
+            catch (error) {
+                let err = error;
+                if (this.option.hookLevel === parse_spec_1.IActionLevel.GLOBAL) {
+                    this.logger.write(`${chalk_1.default.red('✖')} ${chalk_1.default.gray(`${parse_spec_1.IActionLevel.GLOBAL} ${hookType}-action failed to [${this.record.command}] (${(0, utils_2.getProcessTime)(this.record.startTime)}s)`)}`);
+                }
+                throw error;
+            }
+        });
+    }
+    /**
+     * Executes actions post the initial starting phase based on the given hook type.
+     *
+     * This is an internal function primarily used after the initial start of the actions
+     * to handle the actual execution of the actions based on the hook type.
+     * It filters the actions to be executed based on the hook type, logs their start,
+     * and then dispatches them to their respective handler methods based on their action type.
+     *
+     * @private
+     *
+     * @param {string} hookType - The type of hook (e.g. PRE, POST) determining which actions should be executed.
+     * @param {Record<string, any>} [inputs={}] - Optional inputs that might be used during the execution of actions.
+     *
+     * @returns {Promise<Record<string, any>>} - Returns a record containing relevant data from the execution.
+     *
+     * @throws {DevsError} - Throws a DevsError if there's an error during the action execution.
+     *
+     * @example
+     * const result = await actionsInstance.afterStart('PRE');
+     */
+    afterStart(hookType, inputs = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.option.skipActions)
                 return {};
             this.inputs = inputs;
-            const hooks = (0, lodash_1.filter)(this.actions, (item) => item.hookType === hookType);
+            const hooks = (0, lodash_1.filter)(this.actions, item => item.hookType === hookType);
             if ((0, lodash_1.isEmpty)(hooks))
                 return {};
-            this.logger.info(`Start the ${hookType}-action in ${this.option.hookLevel === parse_spec_1.IActionLevel.PROJECT
-                ? `${this.option.projectName} project`
-                : parse_spec_1.IActionLevel.GLOBAL}`);
+            this.record.startTime = Date.now();
+            this.record.lable = this.option.hookLevel === parse_spec_1.IActionLevel.PROJECT ? `[${this.option.projectName}]` : parse_spec_1.IActionLevel.GLOBAL;
+            this.logger.debug(`Start executing the ${hookType}-action in ${this.record.lable}`);
             const newHooks = (0, parse_spec_1.getInputs)(hooks, this.record.magic);
+            // post-action应获取componentProps, 先清空pluginOutput
+            if (hookType !== parse_spec_1.IHookType.PRE) {
+                this.record.pluginOutput = {};
+            }
             for (const hook of newHooks) {
-                debug(`${hook.level} action item: ${(0, utils_1.stringify)(hook)}`);
+                debug(`${hook.level} action item: ${(0, utils_2.stringify)(hook)}`);
+                this.record.allowFailure = this.record.step && 'allow_failure' in this.record.step ? (0, lodash_1.get)(this.record, 'step.allow_failure') : hook.allow_failure;
                 if (hook.actionType === parse_spec_1.IActionType.RUN) {
                     yield this.run(hook);
                 }
@@ -83,62 +140,200 @@ class Actions {
                     yield this.component(hook);
                 }
             }
-            this.logger.info(`End the ${hookType}-action in ${this.option.hookLevel === parse_spec_1.IActionLevel.PROJECT
-                ? `${this.option.projectName} project`
-                : parse_spec_1.IActionLevel.GLOBAL}`);
-            return this.record.pluginOutput;
+            this.logger.debug(`The ${hookType}-action successfully to execute in ${this.record.lable}`);
+            if (this.option.hookLevel === parse_spec_1.IActionLevel.GLOBAL) {
+                this.logger.write(`${chalk_1.default.green('✔')} ${chalk_1.default.gray(`${parse_spec_1.IActionLevel.GLOBAL} ${hookType}-action completed (${(0, utils_2.getProcessTime)(this.record.startTime)})`)}`);
+            }
+            return this.record;
         });
     }
+    /**
+     * Monitors the completion of a given command process.
+     *
+     * @param cp - The command process to be monitored.
+     *
+     * @returns Promise<object> - Resolves with an empty object if the command process completes successfully.
+     *                            Rejects with an error if the command process encounters an error.
+     */
+    onFinish(cp) {
+        return new Promise((resolve, reject) => {
+            // Arrays to store stdout and stderr data from the command process.
+            const stdout = [];
+            const stderr = [];
+            // Listen to the 'data' event of stdout. Append the data chunk to the logger and the stdout array.
+            cp.stdout.on('data', (chunk) => {
+                this.logger.append(chunk.toString());
+                stdout.push(chunk);
+            });
+            // Listen to the 'data' event of stderr. Append the data chunk to the logger and the stderr array.
+            cp.stderr.on('data', (chunk) => {
+                this.logger.append(chunk.toString());
+                stderr.push(chunk);
+            });
+            // Listen to the 'exit' event of the command process.
+            // If the process exits with a code of 0, resolve the promise.
+            // If the process exits with a non-zero code, reject the promise with the accumulated stderr as the error message.
+            cp.on('exit', (code) => {
+                code === 0 ? resolve({}) : reject(new Error(Buffer.concat(stderr).toString()));
+            });
+        });
+    }
+    /**
+     * Executes the action specified by the provided hook.
+     *
+     * @param hook - The action hook specifying the command to run and its associated configurations.
+     *
+     * @throws DevsError - Throws an error if the command execution fails or if the specified directory does not exist.
+     *
+     * @returns Promise<void> - Resolves once the command has been executed.
+     */
     run(hook) {
         return __awaiter(this, void 0, void 0, function* () {
+            // Check if the provided path exists and is a directory.
             if (fs_extra_1.default.existsSync(hook.path) && fs_extra_1.default.lstatSync(hook.path).isDirectory()) {
                 try {
-                    execa_1.default.sync(hook.value, {
+                    // Execute the command in the specified directory.
+                    const cp = (0, execa_1.command)(hook.value, {
                         cwd: hook.path,
-                        stdio: 'inherit',
                         shell: true,
                     });
+                    yield this.onFinish(cp);
                 }
                 catch (e) {
                     const error = e;
-                    // pre hook, throw error
-                    if (hook.hookType !== parse_spec_1.IHookType.PRE)
-                        return;
+                    // If the current environment is Windows, log additional debugging information.
                     if (utils.isWindow()) {
                         debug('Command run execution environment：CMD');
                         debug('Please check whether the actions section of yaml can be executed in the current environment.');
                     }
-                    (0, utils_1.throwError)('Global pre-action failed to execute:' + error.message);
+                    // Check if the error can be safely ignored.
+                    const useAllowFailure = (0, utils_2.getAllowFailure)(this.record.allowFailure, {
+                        exitCode: constants_1.EXIT_CODE.RUN,
+                        command: this.record.command,
+                    });
+                    if (useAllowFailure)
+                        return;
+                    throw new utils_1.DevsError(error.message, {
+                        data: (0, lodash_1.get)(e, 'data'),
+                        stack: error.stack,
+                        exitCode: constants_1.EXIT_CODE.RUN,
+                        prefix: `${this.record.lable} ${hook.hookType}-action failed to [${this.record.command}]:`,
+                    });
                 }
+                return;
             }
+            // Check if the error related to a non-existent directory can be safely ignored.
+            const useAllowFailure = (0, utils_2.getAllowFailure)(this.record.allowFailure, {
+                exitCode: constants_1.EXIT_CODE.DEVS,
+                command: this.record.command,
+            });
+            if (useAllowFailure)
+                return;
+            throw new utils_1.DevsError(`The ${hook.path} directory does not exist.`, {
+                exitCode: constants_1.EXIT_CODE.DEVS,
+                prefix: `${this.record.lable} ${hook.hookType}-action failed to [${this.record.command}]:`,
+            });
         });
     }
+    /**
+     * Loads and executes a specified plugin.
+     *
+     * This function attempts to load a plugin component, then invokes it with the appropriate inputs.
+     * If the plugin execution fails and the failure is allowed (based on the record's allowFailure setting),
+     * it gracefully handles the error without throwing. Otherwise, it throws a DevsError.
+     *
+     * @param hook - An object representing the plugin action to be executed.
+     *
+     * @throws DevsError - Throws a DevsError if the plugin execution fails and the failure is not allowed.
+     */
     plugin(hook) {
         return __awaiter(this, void 0, void 0, function* () {
-            const instance = yield (0, load_component_1.default)(hook.value);
-            // TODO: inputs
-            const inputs = (0, lodash_1.isEmpty)(this.record.pluginOutput) ? this.inputs : this.record.pluginOutput;
-            this.record.pluginOutput = yield instance(inputs, hook.args);
+            try {
+                // Load the plugin component.
+                const instance = yield (0, load_component_1.default)(hook.value);
+                // Determine the inputs for the plugin based on the record's pluginOutput.
+                const inputs = (0, lodash_1.isEmpty)(this.record.pluginOutput) ? this.inputs : this.record.pluginOutput;
+                // Execute the plugin with the determined inputs and provided arguments.
+                this.record.pluginOutput = yield instance(inputs, hook.args);
+            }
+            catch (e) {
+                const error = e;
+                // Check if the failure is allowed based on the record's allowFailure setting.
+                const useAllowFailure = (0, utils_2.getAllowFailure)(this.record.allowFailure, {
+                    exitCode: constants_1.EXIT_CODE.PLUGIN,
+                    command: this.record.command,
+                });
+                if (useAllowFailure)
+                    return;
+                throw new utils_1.DevsError(error.message, {
+                    data: (0, lodash_1.get)(e, 'data'),
+                    stack: error.stack,
+                    exitCode: constants_1.EXIT_CODE.PLUGIN,
+                    prefix: `${this.record.lable} ${hook.hookType}-action failed to [${this.record.command}]:`,
+                });
+            }
         });
     }
+    /**
+     * Loads and executes a specified component command.
+     *
+     * This function tries to load a given component and run the specified command for it.
+     * If the component command execution fails and the failure is allowed (based on the record's allowFailure setting),
+     * it gracefully handles the error without throwing. If the command does not exist for the component,
+     * it throws an error indicating the missing command.
+     *
+     * @param hook - An object representing the component action to be executed.
+     *
+     * @throws DevsError - Throws a DevsError if:
+     *                     1. The component command execution fails and the failure is not allowed.
+     *                     2. The specified command does not exist for the component.
+     */
     component(hook) {
         return __awaiter(this, void 0, void 0, function* () {
+            // Parse the command and arguments from the hook value.
             const argv = (0, string_argv_1.default)(hook.value);
             const { _ } = utils.parseArgv(argv);
-            const [componentName, method] = _;
+            const [componentName, command] = _;
+            // Load the specified component.
             const instance = yield (0, load_component_1.default)(componentName, { logger: this.logger });
-            if (instance[method]) {
+            // Check if the specified command exists for the component.
+            if (instance[command]) {
                 // 方法存在，执行报错，退出码101
-                const newInputs = Object.assign(Object.assign({}, this.record.componentProps), { argv: (0, lodash_1.filter)(argv.slice(2), (o) => !(0, lodash_1.includes)([componentName, method], o)) });
+                const newInputs = Object.assign(Object.assign({}, this.record.componentProps), { argv: (0, lodash_1.filter)(argv.slice(2), o => !(0, lodash_1.includes)([componentName, command], o)) });
                 try {
-                    return yield instance[method](newInputs);
+                    // Execute the command for the component with the prepared inputs.
+                    return yield instance[command](newInputs);
                 }
-                catch (error) {
-                    (0, utils_1.throw101Error)(error, `${hook.actionType}-action failed to execute:`);
+                catch (e) {
+                    const error = e;
+                    // Check if the failure is allowed based on the record's allowFailure setting.
+                    const useAllowFailure = (0, utils_2.getAllowFailure)(this.record.allowFailure, {
+                        exitCode: constants_1.EXIT_CODE.COMPONENT,
+                        command: this.record.command,
+                    });
+                    if (useAllowFailure)
+                        return;
+                    throw new utils_1.DevsError(error.message, {
+                        data: (0, lodash_1.get)(e, 'data'),
+                        stack: error.stack,
+                        exitCode: constants_1.EXIT_CODE.COMPONENT,
+                        prefix: `${this.record.lable} ${hook.hookType}-action failed to [${this.record.command}]:`,
+                    });
                 }
             }
+            // Check if the failure (due to missing command) is allowed.
+            const useAllowFailure = (0, utils_2.getAllowFailure)(this.record.allowFailure, {
+                exitCode: constants_1.EXIT_CODE.DEVS,
+                command: this.record.command,
+            });
+            if (useAllowFailure)
+                return;
             // 方法不存在，此时系统将会认为是未找到组件方法，系统的exit code为100；
-            (0, utils_1.throw100Error)(`The [${method}] command was not found.`, `Please check the component ${componentName} has the ${method} method. Serverless Devs documents：${chalk_1.default.underline('https://github.com/Serverless-Devs/Serverless-Devs/blob/master/docs/zh/command')}`);
+            throw new utils_1.DevsError(`The [${command}] command was not found.`, {
+                exitCode: constants_1.EXIT_CODE.DEVS,
+                prefix: `${this.record.lable} ${hook.hookType}-action failed to [${this.record.command}]:`,
+                tips: `Please check the component ${componentName} has the ${command} command. Serverless Devs documents：${chalk_1.default.underline('https://github.com/Serverless-Devs/Serverless-Devs/blob/master/docs/zh/command')}`,
+            });
         });
     }
 }

package/lib/actions/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/actions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4DASqC;AACrC,mCAAwD;AACxD,8DAAgD;AAChD,wDAA0B;AAC1B,kDAA0B;AAC1B,qFAA4D;AAC5D,8DAAqC;AACrC,oCAA+E;AAC/E,kDAA0B;AAG1B,MAAM,KAAK,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC,wBAAwB,CAAC,CAAC;AAexE,MAAM,OAAO;IAIX,YAAoB,UAAqB,EAAE,EAAU,SAAS,EAAc;QAAxD,YAAO,GAAP,OAAO,CAAgB;QAAU,WAAM,GAAN,MAAM,CAAiB;QAHpE,WAAM,GAAG,EAAa,CAAC;QAEvB,WAAM,GAAwB,EAAE,CAAC;QAEvC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAC9B,CAAC;IACM,QAAQ,CAAC,GAAW,EAAE,KAAU;QACrC,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW;YAAE,OAAO;QACpC,IAAA,YAAG,EAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IAC/B,CAAC;IACY,KAAK,CAAC,QAAwB,EAAE,SAA8B,EAAE;;YAC3E,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW;gBAAE,OAAO,EAAE,CAAC;YACvC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;YACrB,MAAM,KAAK,GAAG,IAAA,eAAM,EAAC,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;YACzE,IAAI,IAAA,gBAAO,EAAC,KAAK,CAAC;gBAAE,OAAO,EAAE,CAAC;YAC9B,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,aAAa,QAAQ,cACnB,IAAI,CAAC,MAAM,CAAC,SAAS,KAAK,yBAAY,CAAC,OAAO;gBAC5C,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,UAAU;gBACtC,CAAC,CAAC,yBAAY,CAAC,MACnB,EAAE,CACH,CAAC;YACF,MAAM,QAAQ,GAAG,IAAA,sBAAS,EAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACrD,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE;gBAC3B,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,iBAAiB,IAAA,iBAAS,EAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACvD,IAAI,IAAI,CAAC,UAAU,KAAK,wBAAW,CAAC,GAAG,EAAE;oBACvC,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;iBACtB;gBACD,IAAI,IAAI,CAAC,UAAU,KAAK,wBAAW,CAAC,MAAM,EAAE;oBAC1C,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;iBACzB;gBACD,sBAAsB;gBACtB,IAAI,IAAI,CAAC,UAAU,KAAK,wBAAW,CAAC,SAAS,IAAI,IAAI,CAAC,KAAK,KAAK,yBAAY,CAAC,OAAO,EAAE;oBACpF,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;iBAC5B;aACF;YACD,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,WAAW,QAAQ,cACjB,IAAI,CAAC,MAAM,CAAC,SAAS,KAAK,yBAAY,CAAC,OAAO;gBAC5C,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,UAAU;gBACtC,CAAC,CAAC,yBAAY,CAAC,MACnB,EAAE,CACH,CAAC;YACF,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;QAClC,CAAC;KAAA;IACa,GAAG,CAAC,IAAgB;;YAChC,IAAI,kBAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,kBAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE;gBACrE,IAAI;oBACF,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;wBACrB,GAAG,EAAE,IAAI,CAAC,IAAI;wBACd,KAAK,EAAE,SAAS;wBAChB,KAAK,EAAE,IAAI;qBACZ,CAAC,CAAC;iBACJ;gBAAC,OAAO,CAAC,EAAE;oBACV,MAAM,KAAK,GAAG,CAAU,CAAC;oBACzB,wBAAwB;oBACxB,IAAI,IAAI,CAAC,QAAQ,KAAK,sBAAS,CAAC,GAAG;wBAAE,OAAO;oBAC5C,IAAI,KAAK,CAAC,QAAQ,EAAE,EAAE;wBACpB,KAAK,CAAC,uCAAuC,CAAC,CAAC;wBAC/C,KAAK,CACH,8FAA8F,CAC/F,CAAC;qBACH;oBACD,IAAA,kBAAU,EAAC,sCAAsC,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;iBACpE;aACF;QACH,CAAC;KAAA;IACa,MAAM,CAAC,IAAmB;;YACtC,MAAM,QAAQ,GAAG,MAAM,IAAA,wBAAa,EAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACjD,eAAe;YACf,MAAM,MAAM,GAAG,IAAA,gBAAO,EAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;YAC1F,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,MAAM,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/D,CAAC;KAAA;IACa,SAAS,CAAC,IAAsB;;YAC5C,MAAM,IAAI,GAAG,IAAA,qBAAU,EAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACpC,MAAM,EAAE,CAAC,EAAE,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACpC,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;YAClC,MAAM,QAAQ,GAAG,MAAM,IAAA,wBAAa,EAAC,aAAa,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;YAC7E,IAAI,QAAQ,CAAC,MAAM,CAAC,EAAE;gBACpB,mBAAmB;gBACnB,MAAM,SAAS,mCACV,IAAI,CAAC,MAAM,CAAC,cAAc,KAC7B,IAAI,EAAE,IAAA,eAAM,EAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAA,iBAAQ,EAAC,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,GAC1E,CAAC;gBACF,IAAI;oBACF,OAAO,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC;iBAC1C;gBAAC,OAAO,KAAK,EAAE;oBACd,IAAA,qBAAa,EAAC,KAAc,EAAE,GAAG,IAAI,CAAC,UAAU,4BAA4B,CAAC,CAAC;iBAC/E;aACF;YACD,2CAA2C;YAC3C,IAAA,qBAAa,EACX,QAAQ,MAAM,0BAA0B,EACxC,8BAA8B,aAAa,YAAY,MAAM,sCAAsC,eAAK,CAAC,SAAS,CAChH,gFAAgF,CACjF,EAAE,CACJ,CAAC;QACJ,CAAC;KAAA;CACF;AAED,kBAAe,OAAO,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/actions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4DAAmK;AACnK,mCAA6D;AAC7D,8DAAgD;AAChD,kDAAmD;AACnD,wDAA0B;AAC1B,iCAAgC;AAChC,qFAA4D;AAC5D,8DAAqC;AACrC,oCAAsE;AACtE,kDAA0B;AAE1B,4CAAyC;AAGzC,MAAM,KAAK,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC,wBAAwB,CAAC,CAAC;AAoBxE,MAAM,OAAO;IAIX,YAAoB,UAAqB,EAAE,EAAU,SAAS,EAAc;QAAxD,YAAO,GAAP,OAAO,CAAgB;QAAU,WAAM,GAAN,MAAM,CAAiB;QAHpE,WAAM,GAAG,EAAa,CAAC;QAEvB,WAAM,GAAwB,EAAE,CAAC;QAEvC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAC9B,CAAC;IACD,yCAAyC;IAClC,QAAQ,CAAC,GAAW,EAAE,KAAU;QACrC,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW;YAAE,OAAO;QACpC,IAAA,YAAG,EAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACG,KAAK,CAAC,QAAwB,EAAE,SAA8B,EAAE;;YACpE,IAAI;gBACF,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;aAChD;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI,GAAG,GAAG,KAAc,CAAC;gBACzB,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,KAAK,yBAAY,CAAC,MAAM,EAAE;oBACjD,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,GAAG,eAAK,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,eAAK,CAAC,IAAI,CAAC,GAAG,yBAAY,CAAC,MAAM,IAAI,QAAQ,sBAAsB,IAAI,CAAC,MAAM,CAAC,OAAO,MAAM,IAAA,sBAAc,EAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAC9J,CAAC;iBACH;gBACD,MAAM,KAAK,CAAC;aACb;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACW,UAAU,CAAC,QAAwB,EAAE,SAA8B,EAAE;;YACjF,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW;gBAAE,OAAO,EAAE,CAAC;YACvC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;YACrB,MAAM,KAAK,GAAG,IAAA,eAAM,EAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;YACvE,IAAI,IAAA,gBAAO,EAAC,KAAK,CAAC;gBAAE,OAAO,EAAE,CAAC;YAC9B,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACnC,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,KAAK,yBAAY,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,yBAAY,CAAC,MAAM,CAAC;YAC1H,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,uBAAuB,QAAQ,cAAc,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;YACpF,MAAM,QAAQ,GAAG,IAAA,sBAAS,EAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACrD,gDAAgD;YAChD,IAAI,QAAQ,KAAK,sBAAS,CAAC,GAAG,EAAE;gBAC9B,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,EAAE,CAAC;aAC/B;YACD,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE;gBAC3B,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,iBAAiB,IAAA,iBAAS,EAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACvD,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,eAAe,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,YAAG,EAAC,IAAI,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC;gBACjJ,IAAI,IAAI,CAAC,UAAU,KAAK,wBAAW,CAAC,GAAG,EAAE;oBACvC,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;iBACtB;gBACD,IAAI,IAAI,CAAC,UAAU,KAAK,wBAAW,CAAC,MAAM,EAAE;oBAC1C,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;iBACzB;gBACD,sBAAsB;gBACtB,IAAI,IAAI,CAAC,UAAU,KAAK,wBAAW,CAAC,SAAS,IAAI,IAAI,CAAC,KAAK,KAAK,yBAAY,CAAC,OAAO,EAAE;oBACpF,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;iBAC5B;aACF;YACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,QAAQ,sCAAsC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;YAE5F,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,KAAK,yBAAY,CAAC,MAAM,EAAE;gBACjD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,eAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,eAAK,CAAC,IAAI,CAAC,GAAG,yBAAY,CAAC,MAAM,IAAI,QAAQ,sBAAsB,IAAA,sBAAc,EAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;aAC1J;YACD,OAAO,IAAI,CAAC,MAAM,CAAC;QACrB,CAAC;KAAA;IAED;;;;;;;OAOG;IACK,QAAQ,CAAC,EAAO;QACtB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,mEAAmE;YACnE,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,MAAM,MAAM,GAAa,EAAE,CAAC;YAE5B,kGAAkG;YAClG,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE;gBACrC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;gBACrC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACrB,CAAC,CAAC,CAAC;YAEH,kGAAkG;YAClG,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE;gBACrC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;gBACrC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACrB,CAAC,CAAC,CAAC;YAEH,qDAAqD;YACrD,8DAA8D;YAC9D,kHAAkH;YAClH,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE;gBAC7B,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;YACjF,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACW,GAAG,CAAC,IAAgB;;YAChC,wDAAwD;YACxD,IAAI,kBAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,kBAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE;gBACrE,IAAI;oBACF,kDAAkD;oBAClD,MAAM,EAAE,GAAG,IAAA,eAAO,EAAC,IAAI,CAAC,KAAK,EAAE;wBAC7B,GAAG,EAAE,IAAI,CAAC,IAAI;wBACd,KAAK,EAAE,IAAI;qBACZ,CAAC,CAAC;oBACH,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;iBACzB;gBAAC,OAAO,CAAC,EAAE;oBACV,MAAM,KAAK,GAAG,CAAU,CAAC;oBACzB,+EAA+E;oBAC/E,IAAI,KAAK,CAAC,QAAQ,EAAE,EAAE;wBACpB,KAAK,CAAC,uCAAuC,CAAC,CAAC;wBAC/C,KAAK,CAAC,8FAA8F,CAAC,CAAC;qBACvG;oBACD,4CAA4C;oBAC5C,MAAM,eAAe,GAAG,IAAA,uBAAe,EAAC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;wBAChE,QAAQ,EAAE,qBAAS,CAAC,GAAG;wBACvB,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;qBAC7B,CAAC,CAAC;oBACH,IAAI,eAAe;wBAAE,OAAO;oBAC5B,MAAM,IAAI,iBAAS,CAAC,KAAK,CAAC,OAAO,EAAE;wBACjC,IAAI,EAAE,IAAA,YAAG,EAAC,CAAC,EAAE,MAAM,CAAC;wBACpB,KAAK,EAAE,KAAK,CAAC,KAAK;wBAClB,QAAQ,EAAE,qBAAS,CAAC,GAAG;wBACvB,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,sBAAsB,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI;qBAC3F,CAAC,CAAC;iBACJ;gBACD,OAAO;aACR;YACD,gFAAgF;YAChF,MAAM,eAAe,GAAG,IAAA,uBAAe,EAAC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;gBAChE,QAAQ,EAAE,qBAAS,CAAC,IAAI;gBACxB,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;aAC7B,CAAC,CAAC;YACH,IAAI,eAAe;gBAAE,OAAO;YAC5B,MAAM,IAAI,iBAAS,CAAC,OAAO,IAAI,CAAC,IAAI,4BAA4B,EAAE;gBAChE,QAAQ,EAAE,qBAAS,CAAC,IAAI;gBACxB,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,sBAAsB,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI;aAC3F,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;;;;;;OAUG;IACW,MAAM,CAAC,IAAmB;;YACtC,IAAI;gBACF,6BAA6B;gBAC7B,MAAM,QAAQ,GAAG,MAAM,IAAA,wBAAa,EAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACjD,0EAA0E;gBAC1E,MAAM,MAAM,GAAG,IAAA,gBAAO,EAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;gBAC1F,wEAAwE;gBACxE,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,MAAM,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;aAC9D;YAAC,OAAO,CAAC,EAAE;gBACV,MAAM,KAAK,GAAG,CAAU,CAAC;gBACzB,8EAA8E;gBAC9E,MAAM,eAAe,GAAG,IAAA,uBAAe,EAAC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;oBAChE,QAAQ,EAAE,qBAAS,CAAC,MAAM;oBAC1B,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;iBAC7B,CAAC,CAAC;gBACH,IAAI,eAAe;oBAAE,OAAO;gBAC5B,MAAM,IAAI,iBAAS,CAAC,KAAK,CAAC,OAAO,EAAE;oBACjC,IAAI,EAAE,IAAA,YAAG,EAAC,CAAC,EAAE,MAAM,CAAC;oBACpB,KAAK,EAAE,KAAK,CAAC,KAAK;oBAClB,QAAQ,EAAE,qBAAS,CAAC,MAAM;oBAC1B,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,sBAAsB,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI;iBAC3F,CAAC,CAAC;aACJ;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;OAaG;IACW,SAAS,CAAC,IAAsB;;YAC5C,uDAAuD;YACvD,MAAM,IAAI,GAAG,IAAA,qBAAU,EAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACpC,MAAM,EAAE,CAAC,EAAE,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACpC,MAAM,CAAC,aAAa,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;YAEnC,gCAAgC;YAChC,MAAM,QAAQ,GAAG,MAAM,IAAA,wBAAa,EAAC,aAAa,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;YAE7E,2DAA2D;YAC3D,IAAI,QAAQ,CAAC,OAAO,CAAC,EAAE;gBACrB,mBAAmB;gBACnB,MAAM,SAAS,mCACV,IAAI,CAAC,MAAM,CAAC,cAAc,KAC7B,IAAI,EAAE,IAAA,eAAM,EAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,IAAA,iBAAQ,EAAC,CAAC,aAAa,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,GACzE,CAAC;gBACF,IAAI;oBACF,kEAAkE;oBAClE,OAAO,MAAM,QAAQ,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC;iBAC3C;gBAAC,OAAO,CAAC,EAAE;oBACV,MAAM,KAAK,GAAG,CAAU,CAAC;oBACzB,8EAA8E;oBAC9E,MAAM,eAAe,GAAG,IAAA,uBAAe,EAAC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;wBAChE,QAAQ,EAAE,qBAAS,CAAC,SAAS;wBAC7B,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;qBAC7B,CAAC,CAAC;oBACH,IAAI,eAAe;wBAAE,OAAO;oBAC5B,MAAM,IAAI,iBAAS,CAAC,KAAK,CAAC,OAAO,EAAE;wBACjC,IAAI,EAAE,IAAA,YAAG,EAAC,CAAC,EAAE,MAAM,CAAC;wBACpB,KAAK,EAAE,KAAK,CAAC,KAAK;wBAClB,QAAQ,EAAE,qBAAS,CAAC,SAAS;wBAC7B,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,sBAAsB,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI;qBAC3F,CAAC,CAAC;iBACJ;aACF;YAED,4DAA4D;YAC5D,MAAM,eAAe,GAAG,IAAA,uBAAe,EAAC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;gBAChE,QAAQ,EAAE,qBAAS,CAAC,IAAI;gBACxB,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;aAC7B,CAAC,CAAC;YACH,IAAI,eAAe;gBAAE,OAAO;YAC5B,2CAA2C;YAC3C,MAAM,IAAI,iBAAS,CAAC,QAAQ,OAAO,0BAA0B,EAAE;gBAC7D,QAAQ,EAAE,qBAAS,CAAC,IAAI;gBACxB,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,sBAAsB,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI;gBAC1F,IAAI,EAAE,8BAA8B,aAAa,YAAY,OAAO,uCAAuC,eAAK,CAAC,SAAS,CACxH,gFAAgF,CACjF,EAAE;aACJ,CAAC,CAAC;QACL,CAAC;KAAA;CACF;AAED,kBAAe,OAAO,CAAC"}

package/lib/constants/index.d.ts

@@ -0,0 +1,6 @@
+export declare const EXIT_CODE: {
+    DEVS: number;
+    COMPONENT: number;
+    PLUGIN: number;
+    RUN: number;
+};

package/lib/constants/index.js

@@ -1,2 +1,14 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EXIT_CODE = void 0;
+exports.EXIT_CODE = {
+    // CLI 执行错误
+    DEVS: 100,
+    // 组件 执行错误
+    COMPONENT: 101,
+    // 插件 执行错误
+    PLUGIN: 101,
+    // shell 执行错误
+    RUN: 101,
+};
 //# sourceMappingURL=index.js.map

package/lib/constants/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/constants/index.ts"],"names":[],"mappings":""}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/constants/index.ts"],"names":[],"mappings":";;;AAAa,QAAA,SAAS,GAAG;IACvB,WAAW;IACX,IAAI,EAAE,GAAG;IACT,UAAU;IACV,SAAS,EAAE,GAAG;IACd,UAAU;IACV,MAAM,EAAE,GAAG;IACX,aAAa;IACb,GAAG,EAAE,GAAG;CACT,CAAC"}

package/lib/index.d.ts

@@ -1,5 +1,12 @@
 import { IEngineOptions, IContext } from './types';
-export { IEngineOptions, IContext } from './types';
+export * from './types';
+/**
+ * Engine Class
+ *
+ * This class provides an engine to handle Serverless Devs operations and steps.
+ * It operates based on the xstate state machine library, ensuring that execution follows
+ * the predefined flow and states.
+ */
 declare class Engine {
     private options;
     context: IContext;
@@ -11,18 +18,85 @@ declare class Engine {
     private globalActionInstance;
     private actionInstance;
     constructor(options: IEngineOptions);
+    /**
+     * Initialization steps before starting the engine.
+     */
+    private beforeStart;
+    /**
+     * Start the engine.
+     *
+     * This is the primary execution function for the engine. It is responsible for starting
+     * the entire engine and handling each step.
+     *
+     * @note engine应收敛所有的异常，不应该抛出异常
+     */
     start(): Promise<IContext>;
-    output(): void;
+    /**
+     * Extracts and returns an object containing the output of each step.
+     * The object's key is the project name and the value is the output of that project.
+     */
+    private getOutput;
+    /**
+     * Validates the 'steps' and 'command' present in 'this.spec'.
+     * Throws an error if either 'steps' or 'command' are missing.
+     */
     private validate;
+    /**
+     * Asynchronously downloads and initializes the given steps.
+     * For each step, it loads the specified component and associates a logger with it.
+     * Returns an array containing the initialized steps.
+     */
     private download;
     private getLogger;
+    /**
+     * Updates the context for the given step based on the provided options.
+     *
+     * @param item - The current step being processed.
+     * @param options - An object containing details like status, error, output, etc. to update the step's context.
+     */
     private recordContext;
+    /**
+     * Generates a context data for the given step containing details like cwd, vars, and other steps' outputs and props.
+     * @param item - The current step being processed.
+     * @returns - The generated context data.
+     */
     private getFilterContext;
+    /**
+     * Handles the subsequent operations after a step has been completed.
+     * 1. Marks the step as completed.
+     * 2. If the step status is FAILURE, attempts to trigger the global FAIL hook.
+     * 3. If the step status is SUCCESS, attempts to trigger the global SUCCESS hook.
+     * 4. Regardless of the step's status, tries to trigger the global COMPLETE hook to denote completion.
+     */
     private doCompleted;
+    /**
+     * Handles the execution process for a project step.
+     * @param item - The project step to handle.
+     */
     private handleSrc;
+    /**
+     * Handles the logic after a project step's execution.
+     * @param item - The project step to handle.
+     */
     private handleAfterSrc;
+    /**
+     * Retrieve properties for a specific project step.
+     * @param item - The project step for which properties are to be retrieved.
+     * @returns An object containing properties related to the project step.
+     */
     private getProps;
+    /**
+     * Executes the appropriate action based on the provided project step.
+     * @param item - The project step to be executed.
+     * @param data - Additional data which may contain plugin output.
+     * @returns Result of the executed action, if applicable.
+     */
     private doSrc;
+    /**
+     * Handles the project step that is marked to be skipped.
+     * @param item - The project step to be skipped.
+     * @returns A resolved Promise.
+     */
     private doSkip;
 }
 export default Engine;