zcatalyst-cli 1.26.2 → 1.27.0

package/lib/init/features/slate/prompt-fields.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.slateAddPromptFields = void 0;
+const register_fields_1 = require("../../../prompt/register-fields");
+exports.slateAddPromptFields = (0, register_fields_1.definePromptFields)([
+    {
+        name: 'name',
+        cliOption: {
+            option: '--name <name>',
+            description: 'Specify the name of the Slate application'
+        }
+    },
+    {
+        name: 'framework',
+        cliOption: {
+            option: '--framework <framework_name>',
+            description: 'Specify the frontend framework (e.g., React, Angular, Vue)'
+        }
+    },
+    {
+        name: 'source',
+        cliOption: {
+            option: '--source <path>',
+            description: 'Specify the source directory of the Slate application'
+        }
+    },
+    {
+        name: 'template',
+        cliOption: {
+            option: '--template <template_url>',
+            description: 'Provide a template URL to initialize your Slate application'
+        }
+    },
+    {
+        name: 'default',
+        cliOption: {
+            option: '--default',
+            description: 'Use default application configurations without prompting'
+        }
+    }
+]);

package/lib/init/index.js

@@ -38,7 +38,8 @@ function init() {
             });
         }
         const MODULE = features_1.default[feature];
-        (0, index_1.info)((0, ansi_colors_1.bold)('\n' + (0, ansi_colors_1.white)('===> ') + js_1.JS.camelToTitleCase(feature) + ' Setup'));
+        (0, index_1.info)();
+        (0, index_1.info)((0, ansi_colors_1.bold)((0, ansi_colors_1.white)('===> ') + js_1.JS.camelToTitleCase(feature) + ' Setup'));
         yield MODULE();
         runtime_store_1.default.set('context.payload.features', runtime_store_1.default.get('context.payload.features', []).concat(feature));
         return init();

package/lib/init/util/client.js

@@ -52,11 +52,13 @@ exports.addDependency = addDependency;
 const ansi_colors_1 = require("ansi-colors");
 const runtime_store_js_1 = __importDefault(require("../../runtime-store.js"));
 const index_js_1 = __importDefault(require("../../error/index.js"));
-const index_js_2 = __importDefault(require("../../prompt/index.js"));
+const index_js_2 = __importStar(require("../../prompt/index.js"));
+const prompt_fields_1 = require("../features/client/prompt-fields");
 const regex_js_1 = __importDefault(require("../../util_modules/constants/lib/regex.js"));
 const ASYNC = __importStar(require("../../util_modules/fs/lib/async.js"));
 const index_1 = require("../../util_modules/logger/index");
 const js_js_1 = require("../../util_modules/js.js");
+const env_js_1 = require("../../util_modules/env.js");
 const fillClientInitPayload = (source, name) => {
     runtime_store_js_1.default.set('context.payload.client.source', source);
     runtime_store_js_1.default.set('context.payload.client.name', name);
@@ -64,14 +66,15 @@ const fillClientInitPayload = (source, name) => {
 exports.fillClientInitPayload = fillClientInitPayload;
 function directoryOverridePrompt(dir) {
     return __awaiter(this, void 0, void 0, function* () {
-        const foldeExists = yield ASYNC.dirExists(dir);
-        if (foldeExists) {
-            const overwriteAns = yield index_js_2.default.ask(index_js_2.default.question('overwrite', 'Directory ' + (0, ansi_colors_1.underline)(dir) + ' already exists. Overwrite ?', {
-                type: 'confirm',
-                defaultAns: false
+        const folderExists = yield ASYNC.dirExists(dir);
+        if (folderExists) {
+            const overwriteAns = yield index_js_2.default.ask((0, index_js_2.overwritePromptQuestion)({
+                fieldOrName: prompt_fields_1.clientPromptFields.get('overwrite'),
+                resourceName: dir,
+                defaultAns: (0, env_js_1.isNonInteractiveMode)() ? null : false
             }));
             if (!overwriteAns.overwrite) {
-                throw new index_js_1.default('Skipping client setup since unable to override the already existing client', { exit: 0, errorId: 'CLIENT-UTILS-6', arg: [ansi_colors_1.italic.red(dir)] });
+                throw new index_js_1.default('Skipping client setup since the client source directory already exists and not overwritten.', { exit: 0, errorId: 'CLIENT-UTILS-6', arg: [ansi_colors_1.italic.red(dir)] });
             }
             yield ASYNC.deleteDir(dir);
         }
@@ -79,7 +82,7 @@ function directoryOverridePrompt(dir) {
 }
 function clientNamePrompt(question, defaultAns) {
     return __awaiter(this, void 0, void 0, function* () {
-        const namePrompt = yield index_js_2.default.ask(index_js_2.default.question('name', question, {
+        const namePrompt = yield index_js_2.default.ask(index_js_2.default.question(prompt_fields_1.clientPromptFields.get('name'), question, {
             type: 'input',
             defaultAns,
             validate: (ans) => {

package/lib/init/util/common.d.ts

@@ -10,3 +10,5 @@ export declare function getRuntimePromptAnswer(question: string, fnType?: keyof
     runtime: string;
     lang: 'node' | 'java';
 }>;
+export declare function ignorableOptsTest(optNames: Array<string> | string, warnMsg: string, removeFromOpts?: boolean): void;
+export declare function niIgnorableOptsTest(optNames: Array<string> | string, warnMsg: string, removeFromOpts?: boolean): void;

package/lib/init/util/common.js

@@ -15,12 +15,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRuntimeDetails = getRuntimeDetails;
 exports.getRuntimeChoices = getRuntimeChoices;
 exports.getRuntimePromptAnswer = getRuntimePromptAnswer;
+exports.ignorableOptsTest = ignorableOptsTest;
+exports.niIgnorableOptsTest = niIgnorableOptsTest;
+const ansi_colors_1 = require("ansi-colors");
 const catalyst_details_js_1 = __importDefault(require("../../endpoints/lib/catalyst-details.js"));
 const index_js_1 = __importDefault(require("../../error/index.js"));
 const index_js_2 = __importDefault(require("../../prompt/index.js"));
 const index_js_3 = require("../../util_modules/constants/index.js");
 const logger_1 = require("../../util_modules/logger");
 const index_1 = require("../../util_modules/logger/index");
+const option_js_1 = require("../../util_modules/option.js");
+const prompt_fields_js_1 = require("./prompt-fields.js");
+const env_js_1 = require("../../util_modules/env.js");
 function getRuntimeDetails(fnType) {
     const catalystDetailsAPI = new catalyst_details_js_1.default();
     return catalystDetailsAPI.getDetails('runtime', fnType ? index_js_3.REMOTE_REF.functions.type[fnType] : undefined);
@@ -88,16 +94,40 @@ function getRuntimeChoices(_a) {
 function getRuntimePromptAnswer(question, fnType) {
     return __awaiter(this, void 0, void 0, function* () {
         const runtimeChoices = yield getRuntimeChoices({ fnType });
-        const runtimeAns = yield index_js_2.default.ask(index_js_2.default.question('runtime', question, {
+        const runtimeAns = yield index_js_2.default.ask(index_js_2.default.question(prompt_fields_js_1.initCommonPromptFields.get('stack'), question, {
             type: 'list',
             choices: runtimeChoices,
             when: () => {
                 return runtimeChoices.length > 1;
             }
         }));
-        if (runtimeAns === undefined || runtimeAns.runtime === undefined) {
+        if (runtimeAns === undefined || runtimeAns.stack === undefined) {
             throw new index_js_1.default('Selected runtime is invalid.', { exit: 2 });
         }
-        return runtimeAns.runtime;
+        return runtimeAns.stack;
     });
 }
+function ignorableOptsTest(optNames, warnMsg, removeFromOpts = true) {
+    if (typeof optNames === 'string')
+        optNames = [optNames];
+    const ignorableOpts = optNames.filter((optName) => {
+        const optValue = (0, option_js_1.getOptionValue)(optName, undefined);
+        return optValue !== undefined;
+    });
+    if (ignorableOpts.length > 0) {
+        (0, logger_1.warning)(`${warnMsg}\nIgnored options: ${ignorableOpts
+            .map((_opt) => (0, ansi_colors_1.italic)(`--${_opt}`))
+            .join(', ')}.`);
+        if (removeFromOpts) {
+            ignorableOpts.forEach((optName) => {
+                (0, option_js_1.unsetOption)(optName);
+            });
+        }
+    }
+}
+function niIgnorableOptsTest(optNames, warnMsg, removeFromOpts = true) {
+    if (!(0, env_js_1.isNonInteractiveMode)()) {
+        return;
+    }
+    return ignorableOptsTest(optNames, warnMsg, removeFromOpts);
+}

package/lib/init/util/prompt-fields.d.ts

@@ -0,0 +1,7 @@
+export declare const initCommonPromptFields: import("../../prompt/register-fields").PromptFieldsRegistry<readonly [{
+    readonly name: "stack";
+    readonly cliOption: {
+        readonly option: "--stack <stack>";
+        readonly description: "catalyst runtime stack to scaffold (for example node18, java17, python_3_9)";
+    };
+}]>;

package/lib/init/util/prompt-fields.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initCommonPromptFields = void 0;
+const register_fields_1 = require("../../prompt/register-fields");
+exports.initCommonPromptFields = (0, register_fields_1.definePromptFields)([
+    {
+        name: 'stack',
+        cliOption: {
+            option: '--stack <stack>',
+            description: 'catalyst runtime stack to scaffold (for example node18, java17, python_3_9)'
+        }
+    }
+]);

package/lib/internal/command.d.ts

@@ -11,6 +11,7 @@ declare class Command {
     private beforeRunners;
     private optIgnores;
     private helpText;
+    private niHelpText;
     private allowUnknownOptions;
     client: Client | null;
     private subCommand;
@@ -25,8 +26,10 @@ declare class Command {
     argument(name: string, description: string, defaultValue?: string): Command;
     allowUnknownOpts(): Command;
     option(...args: Array<string>): Command;
+    option(optionTuple: ReadonlyArray<string>): Command;
     needs(fn: 'auth' | 'config' | 'rc', args?: unknown): Command;
     help(text: string): Command;
+    niHelp(text: string): Command;
     addSubCommand(...commands: Array<Command>): Command;
     ci(value: boolean): Command;
     helpConfig(config: HelpConfiguration): Command;

package/lib/internal/command.js

@@ -72,6 +72,7 @@ class Command {
         this.beforeRunners = [];
         this.optIgnores = [];
         this.helpText = null;
+        this.niHelpText = null;
         this.client = null;
         this.allowUnknownOptions = false;
     }
@@ -91,8 +92,16 @@ class Command {
         this.allowUnknownOptions = true;
         return this;
     }
-    option(...args) {
-        this.cmdOptions.push(args);
+    option(firstOrTuple, ...rest) {
+        if (firstOrTuple === undefined) {
+            this.cmdOptions.push(rest.length > 0 ? rest : []);
+            return this;
+        }
+        if (typeof firstOrTuple === 'string') {
+            this.cmdOptions.push([firstOrTuple, ...rest]);
+            return this;
+        }
+        this.cmdOptions.push([...firstOrTuple, ...rest]);
         return this;
     }
     needs(fn, args) {
@@ -106,6 +115,13 @@ class Command {
         this.helpText = text;
         return this;
     }
+    niHelp(text) {
+        this.niHelpText = `\nNon-Interactive Mode help: \n${text
+            .split('\n')
+            .map((line) => '    ' + line)
+            .join('\n')}`;
+        return this;
+    }
     addSubCommand(...commands) {
         commands.forEach((command) => {
             this.subCommand.push(command);
@@ -159,6 +175,13 @@ class Command {
                 (0, index_1.info)(this.helpText);
             });
         }
+        if (this.niHelpText !== null) {
+            cmd.on('--help', () => {
+                if (!(0, env_1.isNonInteractiveMode)())
+                    return;
+                (0, index_1.info)(this.niHelpText);
+            });
+        }
         if (this._helpConfig) {
             cmd.configureHelp(this._helpConfig);
         }
@@ -266,5 +289,5 @@ class Command {
         });
     }
 }
-Command.globalOpts = ['project', 'token', 'dc', 'org', 'verbose'];
+Command.globalOpts = ['project', 'token', 'dc', 'org', 'verbose', 'nonInteractive'];
 exports.default = Command;

package/lib/migration/global/1.27.0.d.ts

@@ -0,0 +1,2 @@
+export declare const isRequire: () => boolean;
+export declare const migrate: () => void;

package/lib/migration/global/1.27.0.js

@@ -0,0 +1,39 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.migrate = exports.isRequire = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const config_store_js_1 = __importDefault(require("../../util_modules/config-store.js"));
+const index_1 = require("../../util_modules/logger/index");
+const LEGACY_CLI_CONFIG_NAME = 'zcatalyst-cli';
+const getLegacyConfigPath = () => {
+    const configDir = config_store_js_1.default.path;
+    return configDir ? (0, path_1.join)(configDir, `${LEGACY_CLI_CONFIG_NAME}.json`) : undefined;
+};
+const isRequire = () => {
+    const legacyPath = getLegacyConfigPath();
+    if (!legacyPath || !(0, fs_1.existsSync)(legacyPath)) {
+        return false;
+    }
+    return Object.keys(config_store_js_1.default.store).every((key) => key === 'migration');
+};
+exports.isRequire = isRequire;
+const migrate = () => {
+    const legacyPath = getLegacyConfigPath();
+    if (!legacyPath) {
+        return;
+    }
+    try {
+        const legacyContent = JSON.parse((0, fs_1.readFileSync)(legacyPath, 'utf8'));
+        config_store_js_1.default.store = Object.assign(Object.assign({}, legacyContent), { migration: config_store_js_1.default.store.migration });
+        (0, index_1.debug)('legacy config migrated to zcatalyst-cli-v1.json');
+    }
+    catch (e) {
+        (0, index_1.debug)('legacy config migration failed');
+        throw e;
+    }
+};
+exports.migrate = migrate;

package/lib/prompt/choice.d.ts

@@ -0,0 +1,2 @@
+import type { IChoice } from './index';
+export declare const choice: (name: string, { id, value, short, disabled, checked, ...otherOpts }?: IChoice) => IChoice;

package/lib/prompt/choice.js

@@ -0,0 +1,24 @@
+'use strict';
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.choice = void 0;
+const choice = (name, _a = {}) => {
+    var { id = name, value = name, short = name, disabled = false, checked = false } = _a, otherOpts = __rest(_a, ["id", "value", "short", "disabled", "checked"]);
+    return Object.assign({ id,
+        name,
+        value,
+        short,
+        disabled,
+        checked }, otherOpts);
+};
+exports.choice = choice;

package/lib/prompt/cli-option-key.d.ts

@@ -0,0 +1 @@
+export declare function commanderOptionKey(option: string): string;

package/lib/prompt/cli-option-key.js

@@ -0,0 +1,10 @@
+'use strict';
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.commanderOptionKey = commanderOptionKey;
+function commanderOptionKey(option) {
+    const parts = option.split(',');
+    const tail = parts[parts.length - 1].trim();
+    const long = tail.match(/^--([\w-]+)/);
+    const kebab = long ? long[1] : tail.replace(/^-+/, '');
+    return kebab.replace(/-([a-z])/gi, (_, c) => c.toUpperCase());
+}

package/lib/prompt/index.d.ts

@@ -1,26 +1,6 @@
 import inquirer from 'inquirer';
-import Separator from 'inquirer/lib/objects/separator';
 import PromptUI from 'inquirer/lib/ui/prompt';
-import { TreeData, TreeNode } from './types/tree';
-export interface IChoice extends inquirer.ChoiceOptions, inquirer.ListChoiceOptions, inquirer.CheckboxChoiceOptions {
-    id?: string;
-}
-export interface IQuestion extends inquirer.Question, inquirer.ListQuestionOptions {
-    name: string;
-    type?: inquirer.QuestionTypeName | 'file-path' | 'tree' | 'search-box' | 'with-desc';
-    defaultAns?: unknown;
-    choices?: Array<IChoice | TSeparator> | Array<string | TSeparator>;
-    treeChoices?: Array<TreeNode | TreeData>;
-    rootPath?: string;
-    exclude?: Array<string>;
-    excludeDir?: boolean;
-    ignoreFiles?: boolean;
-    depth?: number;
-    empTxt?: string;
-    validatingText?: string;
-    description?: string;
-}
-export type TSeparator = Separator;
+import { buildQuestion, IChoice, IQuestion, TSeparator } from './question-factory';
 declare const _default: {
     register: (type: "file-path" | "tree" | "search-box" | "with-desc") => Promise<void>;
     deregister: (type: "file-path" | "tree" | "search-box") => void;
@@ -29,6 +9,10 @@ declare const _default: {
     ask: (...questions: Array<IQuestion>) => (Promise<inquirer.Answers> & {
         ui: PromptUI;
     }) | Promise<inquirer.Answers>;
-    question: (name: string, question: string, { type, defaultAns, choices, validate, filter, when, prefix, suffix, ...otheropts }?: Omit<IQuestion, "name">) => IQuestion;
+    question: typeof buildQuestion;
 };
 export default _default;
+export { overwritePromptQuestion } from './overwrite-prompt';
+export { definePromptFields, PromptFieldHandle, PromptFieldsRegistry } from './register-fields';
+export type { DefinedPromptFields, PromptFieldDef, PromptFieldNames } from './register-fields';
+export type { IQuestion, IChoice, TSeparator } from './question-factory';