@twin.org/cli-core 0.0.1-next.9 → 0.0.2-next.10

package/dist/cjs/index.cjs

@@ -81,7 +81,7 @@ class CLIDisplay {
         if (lineBreaks) {
             CLIDisplay.writeError("\n");
         }
-        const formatted = core.ErrorHelper.formatErrors(error);
+        const formatted = core.ErrorHelper.formatErrors(error, true);
         CLIDisplay.writeError(chalk.red(formatted.map(e => `\t${e}`).join("\n")));
         if (lineBreaks) {
             CLIDisplay.writeError("\n");
@@ -139,6 +139,15 @@ class CLIDisplay {
         CLIDisplay.write(node_util.inspect(obj, false, undefined, true));
         CLIDisplay.write("\n");
     }
+    /**
+     * Display a warning.
+     * @param label The label for the warning.
+     */
+    static warning(label) {
+        CLIDisplay.write("⚠️  ");
+        CLIDisplay.write(chalk.hex("#FFA500").bold(label));
+        CLIDisplay.write("\n\n");
+    }
     /**
      * Display the processing is done.
      */
@@ -298,6 +307,17 @@ class CLIUtils {
             });
         });
     }
+    /**
+     * Run a shell command.
+     * @param command The app to run in the shell.
+     * @param args The args for the app.
+     * @param cwd The working directory to execute the command in.
+     * @returns Promise to wait for command execution to complete.
+     */
+    static async runShellCmd(command, args, cwd) {
+        const osCommand = process.platform.startsWith("win") ? `${command}.cmd` : command;
+        return CLIUtils.runShellApp(osCommand, args, cwd);
+    }
     /**
      * Run a shell app.
      * @param app The app to run in the shell.
@@ -305,10 +325,9 @@ class CLIUtils {
      * @param cwd The working directory to execute the command in.
      * @returns Promise to wait for command execution to complete.
      */
-    static async runShellCmd(app, args, cwd) {
+    static async runShellApp(app, args, cwd) {
         return new Promise((resolve, reject) => {
-            const osCommand = process.platform.startsWith("win") ? `${app}.cmd` : app;
-            const sp = node_child_process.spawn(osCommand, args, {
+            const sp = node_child_process.spawn(app, args, {
                 shell: true,
                 cwd
             });
@@ -346,7 +365,7 @@ class CLIUtils {
             CLIDisplay.task(core.I18n.formatMessage("cli.progress.writingJsonFile"), filename);
             CLIDisplay.break();
             await promises.mkdir(path.dirname(filename), { recursive: true });
-            await promises.writeFile(filename, JSON.stringify(core.ObjectHelper.merge(currentJson, data), undefined, "\t"));
+            await promises.writeFile(filename, `${JSON.stringify(core.ObjectHelper.merge(currentJson, data), undefined, "\t")}\n`);
         }
     }
     /**
@@ -377,7 +396,7 @@ class CLIUtils {
                 for (const line of data) {
                     const parts = line.split("=");
                     const currentIndex = outputKeys.indexOf(parts[0]);
-                    if (currentIndex >= 0) {
+                    if (currentIndex !== -1) {
                         outputKeys.splice(currentIndex, 1);
                     }
                     outputKeys.push(parts[0]);
@@ -433,7 +452,7 @@ function handleGlobalOptions(command) {
         const resolvedEnv = loadEnv.map(e => path.resolve(e));
         CLIDisplay.task(core.I18n.formatMessage("cli.progress.loadingEnvFiles"), resolvedEnv.join(", "));
         CLIDisplay.break();
-        dotenv__namespace.config({ path: resolvedEnv });
+        dotenv__namespace.config({ path: resolvedEnv, quiet: true });
     }
 }
 /**
@@ -500,6 +519,9 @@ class CLIBase {
                 // eslint-disable-next-line no-restricted-syntax
                 throw new Error(err.code === "commander.help" ? "0" : err.exitCode.toString());
             });
+            if (options.showDevToolWarning ?? false) {
+                program.hook("preAction", () => CLIDisplay.warning(core.I18n.formatMessage("warn.common.devOnlyTool")));
+            }
             this.configureRoot(program);
             addGlobalOptions(program, options.supportsLang ?? true, options.supportsEnvFiles ?? false);
             // We parse the options before building the command
@@ -627,7 +649,7 @@ class CLIParam {
         return optionValue;
     }
     /**
-     * Check the option to see if it exists.
+     * Check the option to see if the String exists.
      * @param optionName The name of the option.
      * @param optionValue The option value.
      * @param allowEnvVar Allow the option to be read from an env var.
@@ -640,7 +662,21 @@ class CLIParam {
         return optionValue;
     }
     /**
-     * Check the option to see if it a url.
+     * Check the option to see if the value exists in the specific array.
+     * @param optionName The name of the option.
+     * @param optionValue The option value.
+     * @param validValues The valid values.
+     * @param allowEnvVar Allow the option to be read from an env var.
+     * @returns The final option value.
+     * @throws An error if the option is invalid.
+     */
+    static arrayOneOf(optionName, optionValue, validValues, allowEnvVar = true) {
+        optionValue = CLIParam.env(optionName, optionValue, allowEnvVar);
+        core.Guards.arrayOneOf("commands", optionName, optionValue, validValues);
+        return optionValue;
+    }
+    /**
+     * Check the option to see if it is a url.
      * @param optionName The name of the option.
      * @param optionValue The option value.
      * @param allowEnvVar Allow the option to be read from an env var.

package/dist/esm/index.mjs

@@ -60,7 +60,7 @@ class CLIDisplay {
         if (lineBreaks) {
             CLIDisplay.writeError("\n");
         }
-        const formatted = ErrorHelper.formatErrors(error);
+        const formatted = ErrorHelper.formatErrors(error, true);
         CLIDisplay.writeError(chalk.red(formatted.map(e => `\t${e}`).join("\n")));
         if (lineBreaks) {
             CLIDisplay.writeError("\n");
@@ -118,6 +118,15 @@ class CLIDisplay {
         CLIDisplay.write(inspect(obj, false, undefined, true));
         CLIDisplay.write("\n");
     }
+    /**
+     * Display a warning.
+     * @param label The label for the warning.
+     */
+    static warning(label) {
+        CLIDisplay.write("⚠️  ");
+        CLIDisplay.write(chalk.hex("#FFA500").bold(label));
+        CLIDisplay.write("\n\n");
+    }
     /**
      * Display the processing is done.
      */
@@ -277,6 +286,17 @@ class CLIUtils {
             });
         });
     }
+    /**
+     * Run a shell command.
+     * @param command The app to run in the shell.
+     * @param args The args for the app.
+     * @param cwd The working directory to execute the command in.
+     * @returns Promise to wait for command execution to complete.
+     */
+    static async runShellCmd(command, args, cwd) {
+        const osCommand = process.platform.startsWith("win") ? `${command}.cmd` : command;
+        return CLIUtils.runShellApp(osCommand, args, cwd);
+    }
     /**
      * Run a shell app.
      * @param app The app to run in the shell.
@@ -284,10 +304,9 @@ class CLIUtils {
      * @param cwd The working directory to execute the command in.
      * @returns Promise to wait for command execution to complete.
      */
-    static async runShellCmd(app, args, cwd) {
+    static async runShellApp(app, args, cwd) {
         return new Promise((resolve, reject) => {
-            const osCommand = process.platform.startsWith("win") ? `${app}.cmd` : app;
-            const sp = spawn(osCommand, args, {
+            const sp = spawn(app, args, {
                 shell: true,
                 cwd
             });
@@ -325,7 +344,7 @@ class CLIUtils {
             CLIDisplay.task(I18n.formatMessage("cli.progress.writingJsonFile"), filename);
             CLIDisplay.break();
             await mkdir(path.dirname(filename), { recursive: true });
-            await writeFile(filename, JSON.stringify(ObjectHelper.merge(currentJson, data), undefined, "\t"));
+            await writeFile(filename, `${JSON.stringify(ObjectHelper.merge(currentJson, data), undefined, "\t")}\n`);
         }
     }
     /**
@@ -356,7 +375,7 @@ class CLIUtils {
                 for (const line of data) {
                     const parts = line.split("=");
                     const currentIndex = outputKeys.indexOf(parts[0]);
-                    if (currentIndex >= 0) {
+                    if (currentIndex !== -1) {
                         outputKeys.splice(currentIndex, 1);
                     }
                     outputKeys.push(parts[0]);
@@ -412,7 +431,7 @@ function handleGlobalOptions(command) {
         const resolvedEnv = loadEnv.map(e => path.resolve(e));
         CLIDisplay.task(I18n.formatMessage("cli.progress.loadingEnvFiles"), resolvedEnv.join(", "));
         CLIDisplay.break();
-        dotenv.config({ path: resolvedEnv });
+        dotenv.config({ path: resolvedEnv, quiet: true });
     }
 }
 /**
@@ -479,6 +498,9 @@ class CLIBase {
                 // eslint-disable-next-line no-restricted-syntax
                 throw new Error(err.code === "commander.help" ? "0" : err.exitCode.toString());
             });
+            if (options.showDevToolWarning ?? false) {
+                program.hook("preAction", () => CLIDisplay.warning(I18n.formatMessage("warn.common.devOnlyTool")));
+            }
             this.configureRoot(program);
             addGlobalOptions(program, options.supportsLang ?? true, options.supportsEnvFiles ?? false);
             // We parse the options before building the command
@@ -606,7 +628,7 @@ class CLIParam {
         return optionValue;
     }
     /**
-     * Check the option to see if it exists.
+     * Check the option to see if the String exists.
      * @param optionName The name of the option.
      * @param optionValue The option value.
      * @param allowEnvVar Allow the option to be read from an env var.
@@ -619,7 +641,21 @@ class CLIParam {
         return optionValue;
     }
     /**
-     * Check the option to see if it a url.
+     * Check the option to see if the value exists in the specific array.
+     * @param optionName The name of the option.
+     * @param optionValue The option value.
+     * @param validValues The valid values.
+     * @param allowEnvVar Allow the option to be read from an env var.
+     * @returns The final option value.
+     * @throws An error if the option is invalid.
+     */
+    static arrayOneOf(optionName, optionValue, validValues, allowEnvVar = true) {
+        optionValue = CLIParam.env(optionName, optionValue, allowEnvVar);
+        Guards.arrayOneOf("commands", optionName, optionValue, validValues);
+        return optionValue;
+    }
+    /**
+     * Check the option to see if it is a url.
      * @param optionName The name of the option.
      * @param optionValue The option value.
      * @param allowEnvVar Allow the option to be read from an env var.

package/dist/types/cliDisplay.d.ts

@@ -56,6 +56,11 @@ export declare class CLIDisplay {
      * @param obj The object to display.
      */
     static json(obj: unknown): void;
+    /**
+     * Display a warning.
+     * @param label The label for the warning.
+     */
+    static warning(label: string): void;
     /**
      * Display the processing is done.
      */

package/dist/types/cliParam.d.ts

@@ -12,7 +12,7 @@ export declare class CLIParam {
      */
     static env(optionName: string, optionValue: string | undefined, allowEnvVar: boolean): string | undefined;
     /**
-     * Check the option to see if it exists.
+     * Check the option to see if the String exists.
      * @param optionName The name of the option.
      * @param optionValue The option value.
      * @param allowEnvVar Allow the option to be read from an env var.
@@ -21,7 +21,17 @@ export declare class CLIParam {
      */
     static stringValue(optionName: string, optionValue: string | undefined, allowEnvVar?: boolean): string;
     /**
-     * Check the option to see if it a url.
+     * Check the option to see if the value exists in the specific array.
+     * @param optionName The name of the option.
+     * @param optionValue The option value.
+     * @param validValues The valid values.
+     * @param allowEnvVar Allow the option to be read from an env var.
+     * @returns The final option value.
+     * @throws An error if the option is invalid.
+     */
+    static arrayOneOf<T = string>(optionName: string, optionValue: string | undefined, validValues: T[], allowEnvVar?: boolean): T;
+    /**
+     * Check the option to see if it is a url.
      * @param optionName The name of the option.
      * @param optionValue The option value.
      * @param allowEnvVar Allow the option to be read from an env var.

package/dist/types/cliUtils.d.ts

@@ -56,6 +56,14 @@ export declare class CLIUtils {
      * @returns The root path.
      */
     static findNpmRoot(rootFolder: string): Promise<string>;
+    /**
+     * Run a shell command.
+     * @param command The app to run in the shell.
+     * @param args The args for the app.
+     * @param cwd The working directory to execute the command in.
+     * @returns Promise to wait for command execution to complete.
+     */
+    static runShellCmd(command: string, args: string[], cwd: string): Promise<void>;
     /**
      * Run a shell app.
      * @param app The app to run in the shell.
@@ -63,7 +71,7 @@ export declare class CLIUtils {
      * @param cwd The working directory to execute the command in.
      * @returns Promise to wait for command execution to complete.
      */
-    static runShellCmd(app: string, args: string[], cwd: string): Promise<void>;
+    static runShellApp(app: string, args: string[], cwd: string): Promise<void>;
     /**
      * Write a JSON file.
      * @param jsonFilename The filename to write.

package/dist/types/index.d.ts

@@ -4,8 +4,8 @@ export * from "./cliOptions";
 export * from "./cliParam";
 export * from "./cliUtils";
 export * from "./commands/global";
+export * from "./models/cliOutputOptions";
 export * from "./models/ICliOptions";
 export * from "./models/ICliOutputOptionsConsole";
 export * from "./models/ICliOutputOptionsEnv";
 export * from "./models/ICliOutputOptionsJson";
-export * from "./models/cliOutputOptions";

package/dist/types/models/ICliOptions.d.ts

@@ -30,4 +30,8 @@ export interface ICliOptions {
      * Override the default output width.
      */
     overrideOutputWidth?: number;
+    /**
+     * Show a warning that this is a dev tool and not for production use.
+     */
+    showDevToolWarning?: boolean;
 }