@contentstack/cli-config 1.4.11 → 1.4.12

package/README.md

@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli-config
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-config/1.4.11 linux-x64 node-v18.17.1
+@contentstack/cli-config/1.4.12 linux-x64 node-v18.18.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/lib/base-command.d.ts

@@ -0,0 +1,37 @@
+import { Command } from '@contentstack/cli-command';
+import { ArgInput, FlagInput, Interfaces, LoggerService } from '@contentstack/cli-utilities';
+export type Args<T extends typeof Command> = Interfaces.InferredArgs<T['args']>;
+export type Flags<T extends typeof Command> = Interfaces.InferredFlags<(typeof BaseCommand)['baseFlags'] & T['flags']>;
+export declare abstract class BaseCommand<T extends typeof Command> extends Command {
+    logger: LoggerService;
+    protected args: Args<T>;
+    protected flags: Flags<T>;
+    static baseFlags: FlagInput;
+    static args: ArgInput<{
+        [arg: string]: any;
+    }>;
+    /**
+     * The `init` function initializes the command by parsing arguments and flags, registering search
+     * plugins, registering the configuration, and initializing the logger.
+     */
+    init(): Promise<void>;
+    /**
+     * The catch function is used to handle errors from a command, either by adding custom logic or
+     * returning the parent class error handling.
+     * @param err - The `err` parameter is of type `Error & { exitCode?: number }`. This means that it is
+     * an object that extends the `Error` class and may also have an optional property `exitCode` of type
+     * `number`.
+     * @returns The parent class error handling is being returned.
+     */
+    protected catch(err: Error & {
+        exitCode?: number;
+    }): Promise<any>;
+    /**
+     * The `finally` function is called after the `run` and `catch` functions, regardless of whether or not
+     * an error occurred.
+     * @param {Error | undefined} _ - The parameter "_" represents an error object or undefined.
+     * @returns The `finally` method is returning the result of calling the `finally` method of the
+     * superclass, which is a promise.
+     */
+    protected finally(_: Error | undefined): Promise<any>;
+}

package/lib/base-command.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseCommand = void 0;
+const cli_command_1 = require("@contentstack/cli-command");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+class BaseCommand extends cli_command_1.Command {
+    /**
+     * The `init` function initializes the command by parsing arguments and flags, registering search
+     * plugins, registering the configuration, and initializing the logger.
+     */
+    async init() {
+        await super.init();
+        const { args, flags } = await this.parse({
+            flags: this.ctor.flags,
+            baseFlags: super.ctor.baseFlags,
+            args: this.ctor.args,
+            strict: this.ctor.strict,
+        });
+        this.flags = flags;
+        this.args = args;
+        // Init logger
+        this.logger = new cli_utilities_1.LoggerService(process.cwd(), 'cli-log');
+    }
+    /**
+     * The catch function is used to handle errors from a command, either by adding custom logic or
+     * returning the parent class error handling.
+     * @param err - The `err` parameter is of type `Error & { exitCode?: number }`. This means that it is
+     * an object that extends the `Error` class and may also have an optional property `exitCode` of type
+     * `number`.
+     * @returns The parent class error handling is being returned.
+     */
+    async catch(err) {
+        // add any custom logic to handle errors from the command
+        // or simply return the parent class error handling
+        return super.catch(err);
+    }
+    /**
+     * The `finally` function is called after the `run` and `catch` functions, regardless of whether or not
+     * an error occurred.
+     * @param {Error | undefined} _ - The parameter "_" represents an error object or undefined.
+     * @returns The `finally` method is returning the result of calling the `finally` method of the
+     * superclass, which is a promise.
+     */
+    async finally(_) {
+        // called after run and catch regardless of whether or not the command errored
+        return super.finally(_);
+    }
+}
+exports.BaseCommand = BaseCommand;
+// NOTE define flags that canin be inherited by any command that extends BaseCommand
+BaseCommand.baseFlags = {};

package/lib/commands/config/get/region.d.ts

@@ -1,5 +1,5 @@
-import { Command } from '@contentstack/cli-command';
-export default class RegionGetCommand extends Command {
+import { BaseCommand } from '../../../base-command';
+export default class RegionGetCommand extends BaseCommand<typeof RegionGetCommand> {
     static description: string;
     static examples: string[];
     config: any;

package/lib/commands/config/get/region.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const cli_command_1 = require("@contentstack/cli-command");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
-class RegionGetCommand extends cli_command_1.Command {
+const base_command_1 = require("../../../base-command");
+class RegionGetCommand extends base_command_1.BaseCommand {
     async run() {
         let currentRegion = this.region;
         if (!currentRegion) {
-            cli_utilities_1.logger.error('No region set');
+            this.logger.error('No region set');
             cli_utilities_1.cliux.error('CLI_CONFIG_GET_REGION_NOT_FOUND');
             this.exit();
         }
@@ -14,6 +14,7 @@ class RegionGetCommand extends cli_command_1.Command {
         cli_utilities_1.cliux.print(`CDA HOST: ${currentRegion.cda}`);
         cli_utilities_1.cliux.print(`CMA HOST: ${currentRegion.cma}`);
         cli_utilities_1.cliux.print(`UI HOST: ${currentRegion.uiHost}`);
+        this.logger.error(`Currently using ${currentRegion.name} region`);
     }
 }
 exports.default = RegionGetCommand;

package/lib/commands/config/set/region.d.ts

@@ -1,6 +1,6 @@
-import { Command } from '@contentstack/cli-command';
 import { FlagInput, ArgInput } from '@contentstack/cli-utilities';
-export default class RegionSetCommand extends Command {
+import { BaseCommand } from '../../../base-command';
+export default class RegionSetCommand extends BaseCommand<typeof RegionSetCommand> {
     config: any;
     static description: string;
     static flags: FlagInput;

package/lib/commands/config/set/region.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const cli_command_1 = require("@contentstack/cli-command");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const utils_1 = require("../../../utils");
-class RegionSetCommand extends cli_command_1.Command {
+const base_command_1 = require("../../../base-command");
+class RegionSetCommand extends base_command_1.BaseCommand {
     async run() {
         const { args, flags: regionSetFlags } = await this.parse(RegionSetCommand);
         let cda = regionSetFlags.cda;
@@ -36,7 +36,7 @@ class RegionSetCommand extends cli_command_1.Command {
                 cli_utilities_1.cliux.success(`UI HOST: ${customRegion.uiHost}`);
             }
             catch (error) {
-                cli_utilities_1.logger.error('failed to set the region', error);
+                this.logger.error('failed to set the region', error);
                 cli_utilities_1.cliux.error(`Failed to set region due to: ${error.message}`);
             }
         }

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.4.11",
+  "version": "1.4.12",
   "commands": {
     "config:get:base-branch": {
       "id": "config:get:base-branch",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli-config",
   "description": "Contentstack CLI plugin for configuration",
-  "version": "1.4.11",
+  "version": "1.4.12",
   "author": "Contentstack",
   "scripts": {
     "build": "npm run clean && npm run compile",
@@ -21,8 +21,8 @@
     "test:unit:report": "nyc --extension .ts mocha --forbid-only \"test/unit/**/*.test.ts\""
   },
   "dependencies": {
-    "@contentstack/cli-command": "~1.2.12",
-    "@contentstack/cli-utilities": "~1.5.2",
+    "@contentstack/cli-command": "~1.2.13",
+    "@contentstack/cli-utilities": "~1.5.3",
     "chalk": "^4.0.0",
     "debug": "^4.1.1",
     "mkdirp": "^1.0.4",