@contentstack/cli-config 1.13.0 → 1.14.0

package/README.md

@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli-config
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-config/1.13.0 linux-x64 node-v22.16.0
+@contentstack/cli-config/1.14.0 linux-x64 node-v22.17.1
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -32,6 +32,7 @@ USAGE
 * [`csdx config:get:base-branch`](#csdx-configgetbase-branch)
 * [`csdx config:get:ea-header`](#csdx-configgetea-header)
 * [`csdx config:get:early-access-header`](#csdx-configgetearly-access-header)
+* [`csdx config:get:log`](#csdx-configgetlog)
 * [`csdx config:get:rate-limit`](#csdx-configgetrate-limit)
 * [`csdx config:get:region`](#csdx-configgetregion)
 * [`csdx config:remove:base-branch`](#csdx-configremovebase-branch)
@@ -41,6 +42,7 @@ USAGE
 * [`csdx config:set:base-branch`](#csdx-configsetbase-branch)
 * [`csdx config:set:ea-header`](#csdx-configsetea-header)
 * [`csdx config:set:early-access-header`](#csdx-configsetearly-access-header)
+* [`csdx config:set:log`](#csdx-configsetlog)
 * [`csdx config:set:rate-limit`](#csdx-configsetrate-limit)
 * [`csdx config:set:region [REGION]`](#csdx-configsetregion-region)
 
@@ -99,6 +101,23 @@ EXAMPLES
 
 _See code: [src/commands/config/get/early-access-header.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/get/early-access-header.ts)_
 
+## `csdx config:get:log`
+
+Get logging configuration for CLI
+
+```
+USAGE
+  $ csdx config:get:log
+
+DESCRIPTION
+  Get logging configuration for CLI
+
+EXAMPLES
+  $ csdx config:get:log
+```
+
+_See code: [src/commands/config/get/log.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/get/log.ts)_
+
 ## `csdx config:get:rate-limit`
 
 Get rate-limit of organizations
@@ -301,6 +320,30 @@ EXAMPLES
 
 _See code: [src/commands/config/set/early-access-header.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/early-access-header.ts)_
 
+## `csdx config:set:log`
+
+Set logging configuration for CLI
+
+```
+USAGE
+  $ csdx config:set:log [--level debug|info|warn|error] [--path <value>]
+
+FLAGS
+  --level=<option>  Set the log level for the CLI.
+                    <options: debug|info|warn|error>
+  --path=<value>    Specify the file path where logs should be saved.
+
+DESCRIPTION
+  Set logging configuration for CLI
+
+EXAMPLES
+  $ csdx config:set:log
+
+  $ csdx config:set:log --level debug --path ./logs/app.log
+```
+
+_See code: [src/commands/config/set/log.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/log.ts)_
+
 ## `csdx config:set:rate-limit`
 
 Set rate-limit for CLI

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

@@ -0,0 +1,6 @@
+import { Command } from '@contentstack/cli-command';
+export default class LogGetCommand extends Command {
+    static description: string;
+    static examples: string[];
+    run(): Promise<void>;
+}

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

@@ -0,0 +1,35 @@
+"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 LogGetCommand extends cli_command_1.Command {
+    async run() {
+        try {
+            const currentLoggingConfig = cli_utilities_1.configHandler.get('log') || {};
+            const logLevel = currentLoggingConfig === null || currentLoggingConfig === void 0 ? void 0 : currentLoggingConfig.level;
+            const logPath = currentLoggingConfig === null || currentLoggingConfig === void 0 ? void 0 : currentLoggingConfig.path;
+            if (logLevel || logPath) {
+                const logConfigList = [
+                    {
+                        'Log Level': logLevel || 'Not set',
+                        'Log Path': logPath || 'Not set',
+                    },
+                ];
+                const headers = [
+                    { value: 'Log Level' },
+                    { value: 'Log Path' },
+                ];
+                cli_utilities_1.cliux.table(headers, logConfigList);
+            }
+            else {
+                cli_utilities_1.cliux.print(`error: ${cli_utilities_1.messageHandler.parse('CLI_CONFIG_LOG_NO_CONFIG')}`, { color: 'red' });
+            }
+        }
+        catch (error) {
+            cli_utilities_1.cliux.error('error', error);
+        }
+    }
+}
+exports.default = LogGetCommand;
+LogGetCommand.description = 'Get logging configuration for CLI';
+LogGetCommand.examples = ['csdx config:get:log'];

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

@@ -0,0 +1,8 @@
+import { Command } from '@contentstack/cli-command';
+import { FlagInput } from '@contentstack/cli-utilities';
+export default class LogSetCommand extends Command {
+    static description: string;
+    static flags: FlagInput;
+    static examples: string[];
+    run(): Promise<void>;
+}

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

@@ -0,0 +1,56 @@
+"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");
+const fs_1 = require("fs");
+const path_1 = require("path");
+class LogSetCommand extends cli_command_1.Command {
+    async run() {
+        try {
+            const { flags } = await this.parse(LogSetCommand);
+            let logLevel = flags['level'];
+            let logPath = flags['path'];
+            // Interactive prompts if not passed via flags
+            if (!logLevel) {
+                logLevel = await utils_1.interactive.askLogLevel();
+            }
+            if (!logPath) {
+                logPath = await utils_1.interactive.askLogPath();
+            }
+            if (logPath) {
+                const logDir = (0, path_1.dirname)(logPath);
+                // Check if the directory part of the path exists and is actually a file
+                if ((0, fs_1.existsSync)(logDir) && (0, fs_1.statSync)(logDir).isFile()) {
+                    throw new cli_utilities_1.CLIError({
+                        message: `The directory path '${logDir}' is a file, not a directory. Please provide a valid directory path for the log file.`,
+                    });
+                }
+            }
+            const currentLoggingConfig = cli_utilities_1.configHandler.get('log') || {};
+            if (logLevel)
+                currentLoggingConfig.level = logLevel;
+            if (logPath)
+                currentLoggingConfig.path = logPath;
+            cli_utilities_1.configHandler.set('log', currentLoggingConfig);
+            cli_utilities_1.cliux.success(cli_utilities_1.messageHandler.parse('CLI_CONFIG_LOG_LEVEL_SET', logLevel));
+            cli_utilities_1.cliux.success(cli_utilities_1.messageHandler.parse('CLI_CONFIG_LOG_PATH_SET', logPath));
+            cli_utilities_1.cliux.print(cli_utilities_1.messageHandler.parse('CLI_CONFIG_LOG_SET_SUCCESS'), { color: 'green' });
+        }
+        catch (error) {
+            cli_utilities_1.cliux.error('error', error);
+        }
+    }
+}
+exports.default = LogSetCommand;
+LogSetCommand.description = 'Set logging configuration for CLI';
+LogSetCommand.flags = {
+    level: cli_utilities_1.flags.string({
+        description: 'Set the log level for the CLI.',
+        options: ['debug', 'info', 'warn', 'error'],
+    }),
+    path: cli_utilities_1.flags.string({
+        description: ' Specify the file path where logs should be saved.',
+    }),
+};
+LogSetCommand.examples = ['csdx config:set:log', 'csdx config:set:log --level debug --path ./logs/app.log'];

package/lib/commands/config/set/rate-limit.js

@@ -52,8 +52,12 @@ class SetRateLimitCommand extends base_command_1.BaseCommand {
             await limitHandler.setRateLimit(config);
         }
         catch (error) {
-            cli_utilities_1.cliux.error(`Error: Something went wrong while setting rate limit for org: ${org}`);
-            cli_utilities_1.cliux.error(error);
+            if (error === null || error === void 0 ? void 0 : error.message) {
+                cli_utilities_1.cliux.error(error.message);
+            }
+            else {
+                cli_utilities_1.cliux.error(`Error: Something went wrong while setting rate limit for org: ${org}`);
+            }
         }
     }
 }

package/lib/interfaces/index.d.ts

@@ -6,7 +6,7 @@ export interface InquirePayload {
     name: string;
     message: string;
     choices?: Array<any>;
-    transformer?: Function;
+    transformer?: (value: any) => any;
 }
 export interface Region {
     name: string;

package/lib/utils/interactive.d.ts

@@ -7,3 +7,5 @@ export declare function inquireRequireFieldValidation(input: string): string | b
 export declare function askEarlyAccessHeaderValue(): Promise<string>;
 export declare function askEarlyAccessHeaderAlias(): Promise<string>;
 export declare const askOrgID: () => Promise<string>;
+export declare function askLogLevel(): Promise<string>;
+export declare function askLogPath(): Promise<string>;

package/lib/utils/interactive.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.askOrgID = exports.askEarlyAccessHeaderAlias = exports.askEarlyAccessHeaderValue = exports.inquireRequireFieldValidation = exports.askConfirmation = exports.askBaseBranch = exports.askStackAPIKey = exports.askCustomRegion = exports.askRegions = void 0;
+exports.askLogPath = exports.askLogLevel = exports.askOrgID = exports.askEarlyAccessHeaderAlias = exports.askEarlyAccessHeaderValue = exports.inquireRequireFieldValidation = exports.askConfirmation = exports.askBaseBranch = exports.askStackAPIKey = exports.askCustomRegion = exports.askRegions = void 0;
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const askRegions = async () => {
     return cli_utilities_1.cliux.inquire({
@@ -104,3 +104,26 @@ const askOrgID = async () => {
     });
 };
 exports.askOrgID = askOrgID;
+async function askLogLevel() {
+    const { logLevel } = await cli_utilities_1.cliux.inquire([
+        {
+            type: 'list',
+            name: 'logLevel',
+            message: 'Select log level:',
+            choices: ['debug', 'info', 'warn', 'error'],
+        },
+    ]);
+    return logLevel;
+}
+exports.askLogLevel = askLogLevel;
+async function askLogPath() {
+    const { logPath } = await cli_utilities_1.cliux.inquire([
+        {
+            type: 'input',
+            name: 'logPath',
+            message: 'Enter log file path:',
+        },
+    ]);
+    return logPath;
+}
+exports.askLogPath = askLogPath;

package/lib/utils/rate-limit-handler.js

@@ -62,7 +62,6 @@ class RateLimitHandler {
             });
         }
         catch (error) {
-            console.log('Something went wrong while setting rate limit for org:', (0, cli_utilities_1.formatError)(error));
             throw new Error(error);
         }
     }

package/messages/index.json

@@ -15,5 +15,9 @@
   "CLI_CONFIG_BRANCH_LIST_NO_BRANCHES": "No branches are added. Use config:set:base-branch command to add base branch.",
   "CLI_CONFIG_INQUIRE_EARLY_ACCESS_HEADER_VALUE": "Please enter Early Access header value",
   "CLI_CONFIG_INQUIRE_EARLY_ACCESS_HEADER_ALIAS": "Please enter Early Access header alias",
-  "CLI_BRANCH_REQUIRED_FIELD": "Please enter the required field details"
+  "CLI_BRANCH_REQUIRED_FIELD": "Please enter the required field details",
+  "CLI_CONFIG_LOG_NO_CONFIG": "No config found, please set by running command $ csdx config:set:log",
+  "CLI_CONFIG_LOG_SET_SUCCESS": "Log config set successfully",
+  "CLI_CONFIG_LOG_LEVEL_SET": "Log level: '%s'",
+  "CLI_CONFIG_LOG_PATH_SET": "Log path: '%s'"
 }

package/oclif.manifest.json

@@ -50,6 +50,30 @@
         "early-access-header.js"
       ]
     },
+    "config:get:log": {
+      "aliases": [],
+      "args": {},
+      "description": "Get logging configuration for CLI",
+      "examples": [
+        "csdx config:get:log"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "config:get:log",
+      "pluginAlias": "@contentstack/cli-config",
+      "pluginName": "@contentstack/cli-config",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "config",
+        "get",
+        "log.js"
+      ]
+    },
     "config:get:rate-limit": {
       "aliases": [],
       "args": {},
@@ -296,6 +320,52 @@
         "early-access-header.js"
       ]
     },
+    "config:set:log": {
+      "aliases": [],
+      "args": {},
+      "description": "Set logging configuration for CLI",
+      "examples": [
+        "csdx config:set:log",
+        "csdx config:set:log --level debug --path ./logs/app.log"
+      ],
+      "flags": {
+        "level": {
+          "description": "Set the log level for the CLI.",
+          "name": "level",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "debug",
+            "info",
+            "warn",
+            "error"
+          ],
+          "type": "option"
+        },
+        "path": {
+          "description": " Specify the file path where logs should be saved.",
+          "name": "path",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "config:set:log",
+      "pluginAlias": "@contentstack/cli-config",
+      "pluginName": "@contentstack/cli-config",
+      "pluginType": "core",
+      "strict": true,
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "config",
+        "set",
+        "log.js"
+      ]
+    },
     "config:set:rate-limit": {
       "aliases": [],
       "args": {},
@@ -466,5 +536,5 @@
       ]
     }
   },
-  "version": "1.13.0"
+  "version": "1.14.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli-config",
   "description": "Contentstack CLI plugin for configuration",
-  "version": "1.13.0",
+  "version": "1.14.0",
   "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.5.0",
-    "@contentstack/cli-utilities": "~1.12.0",
+    "@contentstack/cli-command": "~1.6.0",
+    "@contentstack/cli-utilities": "~1.13.0",
     "@oclif/core": "^4.3.0",
     "@oclif/plugin-help": "^6.2.28",
     "lodash": "^4.17.21"