@celonis/content-cli 1.0.7 → 1.0.8

package/commands/configuration-management/studio.service.js

@@ -116,7 +116,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
             });
         }
         fixConnectionVariable(variable) {
-            if (!variable.value.appName) {
+            var _a;
+            if (!((_a = variable.value) === null || _a === void 0 ? void 0 : _a.appName)) {
                 return variable;
             }
             return Object.assign(Object.assign({}, variable), { metadata: Object.assign(Object.assign({}, variable.metadata), { appName: variable.value.appName }) });

package/content-cli.js

@@ -14,7 +14,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "semver/functions/satisfies", "commander", "./core/command/module-handler", "./core/command/cli-context", "./core/utils/version", "./core/utils/logger"], factory);
+        define(["require", "exports", "semver/functions/satisfies", "commander", "./core/command/module-handler", "./core/command/cli-context", "./core/utils/version", "./core/utils/logger", "./core/command/CustomHelp"], factory);
     }
 })(function (require, exports) {
     "use strict";
@@ -25,6 +25,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     const cli_context_1 = require("./core/command/cli-context");
     const version_1 = require("./core/utils/version");
     const logger_1 = require("./core/utils/logger");
+    const CustomHelp_1 = require("./core/command/CustomHelp");
     /**
      * Celonis Content CLI.
      *
@@ -38,6 +39,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     }
     // Global configuration options
     const program = new commander_1.Command();
+    program.configureHelp({
+        formatHelp: (cmd, helper) => new CustomHelp_1.ContentCLIHelp().formatHelp(cmd, helper),
+        subcommandTerm: cmd => new CustomHelp_1.ContentCLIHelp().subcommandTerm(cmd),
+        optionTerm: opt => new CustomHelp_1.ContentCLIHelp().optionTerm(opt),
+    });
     program.version(version_1.VersionUtils.getCurrentCliVersion());
     program.option("-q, --quietmode", "Reduce output to a minimum", false);
     program.option("-p, --profile [profile]");

package/core/command/CustomHelp.js

@@ -0,0 +1,30 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports", "commander", "chalk"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.ContentCLIHelp = void 0;
+    const commander_1 = require("commander");
+    const chalk = require("chalk");
+    class ContentCLIHelp extends commander_1.Help {
+        subcommandTerm(cmd) {
+            const base = super.subcommandTerm(cmd);
+            return cmd.isBeta === true
+                ? `${base} ${chalk.yellow("(beta)")}`
+                : base;
+        }
+        optionTerm(option) {
+            const term = super.optionTerm(option);
+            return option.isBeta === true
+                ? `${term} ${chalk.yellow("(beta)")}`
+                : term;
+        }
+    }
+    exports.ContentCLIHelp = ContentCLIHelp;
+});

package/core/command/module-handler.js

@@ -13,7 +13,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         if (v !== undefined) module.exports = v;
     }
     else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "path", "fs", "../utils/logger"], factory);
+        define(["require", "exports", "path", "fs", "commander", "../utils/logger", "chalk"], factory);
     }
 })(function (require, exports) {
     "use strict";
@@ -21,7 +21,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     exports.CommandConfig = exports.Configurator = exports.ModuleHandler = exports.IModule = void 0;
     const path = require("path");
     const fs = require("fs");
+    const commander_1 = require("commander");
     const logger_1 = require("../utils/logger");
+    const chalk = require("chalk");
     class IModule {
     }
     exports.IModule = IModule;
@@ -171,6 +173,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
             this.cmd.option(flags, description, defaultValue);
             return this;
         }
+        betaOption(flags, description, defaultValue) {
+            const option = new commander_1.Option(flags, description).default(defaultValue);
+            option.isBeta = true;
+            this.cmd.addOption(option);
+            return this;
+        }
         requiredOption(flags, description, defaultValue) {
             this.cmd.requiredOption(flags, description, defaultValue);
             return this;
@@ -179,9 +187,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
             this.deprecationMessage = deprecationMessage;
             return this;
         }
+        beta() {
+            this.cmd.isBeta = true;
+            return this;
+        }
         action(handler) {
             this.cmd.action(() => __awaiter(this, void 0, void 0, function* () {
                 try {
+                    this.printBetaNoticeIfBetaCommand();
+                    this.printBetaNoticeIfBetaOptions();
                     this.printDeprecationNoticeIfDeprecated();
                     yield handler(this.ctx, this.cmd, this.cmd.opts());
                 }
@@ -195,6 +209,21 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
                 logger_1.logger.warn("⚠️  [DEPRECATION NOTICE] \n" + this.deprecationMessage);
             }
         }
+        printBetaNoticeIfBetaCommand() {
+            if (this.cmd.isBeta) {
+                logger_1.logger.info(chalk.yellow("This command is in beta and may change in future releases."));
+            }
+        }
+        printBetaNoticeIfBetaOptions() {
+            if (this.cmd.isBeta) {
+                return;
+            }
+            for (const option of this.cmd.options) {
+                if (option.isBeta) {
+                    logger_1.logger.info(chalk.yellow(`The option '${option.long}' is in beta and may change in future releases.`));
+                }
+            }
+        }
     }
     exports.CommandConfig = CommandConfig;
 });

package/lib/core/command/CustomHelp.d.ts

@@ -0,0 +1,5 @@
+import { Command, Help } from "commander";
+export declare class ContentCLIHelp extends Help {
+    subcommandTerm(cmd: Command): string;
+    optionTerm(option: any): string;
+}

package/lib/core/command/module-handler.d.ts

@@ -49,9 +49,13 @@ export declare class CommandConfig {
     description(description: string): CommandConfig;
     argument(name: string, description?: string, defaultValue?: unknown): CommandConfig;
     option(flags: string, description?: string, defaultValue?: string | boolean | string[]): CommandConfig;
+    betaOption(flags: string, description?: string, defaultValue?: string | boolean | string[]): CommandConfig;
     requiredOption(flags: string, description?: string, defaultValue?: string | boolean | string[]): CommandConfig;
     deprecationNotice(deprecationMessage: string): CommandConfig;
+    beta(): CommandConfig;
     action(handler: CommandHandler): void;
     private printDeprecationNoticeIfDeprecated;
+    private printBetaNoticeIfBetaCommand;
+    private printBetaNoticeIfBetaOptions;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@celonis/content-cli",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "CLI Tool to help manage content in Celonis Platform",
   "main": "content-cli.js",
   "bin": {