@contentstack/cli-config 1.15.1 → 1.15.3

package/README.md

@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli-config
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-config/1.15.1 linux-x64 node-v22.18.0
+@contentstack/cli-config/1.15.3 linux-x64 node-v22.20.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -329,9 +329,10 @@ USAGE
   $ csdx config:set:log [--level debug|info|warn|error] [--path <value>] [--show-console-logs]
 
 FLAGS
-  --level=<option>          Set the log level for the CLI.
+  --level=<option>          Set the log level for the CLI. Defaults to "info" if not specified.
                             <options: debug|info|warn|error>
-  --path=<value>            Specify the file path where logs should be saved.
+  --path=<value>            Specify the directory path where logs should be saved. Supports both relative and absolute
+                            paths. Defaults to ~/.contentstack/logs if not specified.
   --[no-]show-console-logs  Enable console logging.
 
 DESCRIPTION
@@ -340,9 +341,19 @@ DESCRIPTION
 EXAMPLES
   $ csdx config:set:log
 
-  $ csdx config:set:log --level debug --path ./logs/app.log --show-console-logs
+  $ csdx config:set:log --level debug
+
+  $ csdx config:set:log --path ./logs
+
+  $ csdx config:set:log --level debug --path ./logs --show-console-logs
 
   $ csdx config:set:log --no-show-console-logs
+
+  $ csdx config:set:log --level warn --show-console-logs
+
+  $ csdx config:set:log --path ~/custom/logs
+
+  $ csdx config:set:log --path /var/log/contentstack
 ```
 
 _See code: [src/commands/config/set/log.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/log.ts)_

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

@@ -2,28 +2,31 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const cli_command_1 = require("@contentstack/cli-command");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
+const log_config_defaults_1 = require("../../../utils/log-config-defaults");
 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' });
-            }
+            const effectiveConfig = (0, log_config_defaults_1.getEffectiveLogConfig)(currentLoggingConfig);
+            const logConfigList = [
+                {
+                    Setting: 'Log Level',
+                    Value: effectiveConfig.level,
+                },
+                {
+                    Setting: 'Log Path',
+                    Value: effectiveConfig.path,
+                },
+                {
+                    Setting: 'Show Console Logs',
+                    Value: effectiveConfig.showConsoleLogs.toString(),
+                },
+            ];
+            const headers = [{ value: 'Setting' }, { value: 'Value' }];
+            cli_utilities_1.cliux.table(headers, logConfigList);
+            cli_utilities_1.cliux.print('\nNote: Absolute paths are displayed. Relative paths are resolved from current working directory.', {
+                color: 'dim',
+            });
         }
         catch (error) {
             cli_utilities_1.cliux.error('error', error);

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

@@ -2,32 +2,39 @@
 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 log_config_defaults_1 = require("../../../utils/log-config-defaults");
+const path = 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'];
-            const showConsoleLogs = flags['show-console-logs'];
-            // Interactive prompts if not passed via flags
-            if (!logLevel) {
-                logLevel = await utils_1.interactive.askLogLevel();
+            const currentLoggingConfig = cli_utilities_1.configHandler.get('log') || {};
+            if (flags['level'] !== undefined) {
+                currentLoggingConfig.level = flags['level'];
             }
-            if (!logPath) {
-                logPath = await utils_1.interactive.askLogPath();
+            if (flags['path'] !== undefined) {
+                // Convert to absolute path and ensure it's a directory
+                let resolvedPath = (0, log_config_defaults_1.resolveLogPath)(flags['path']);
+                const pathExt = path.extname(resolvedPath);
+                if (pathExt && pathExt.length > 0) {
+                    resolvedPath = path.dirname(resolvedPath);
+                }
+                currentLoggingConfig.path = resolvedPath;
+            }
+            if (flags['show-console-logs'] !== undefined) {
+                currentLoggingConfig['showConsoleLogs'] = flags['show-console-logs'];
             }
-            const currentLoggingConfig = cli_utilities_1.configHandler.get('log') || {};
-            if (logLevel)
-                currentLoggingConfig.level = logLevel;
-            if (logPath)
-                currentLoggingConfig.path = logPath;
-            currentLoggingConfig['show-console-logs'] = showConsoleLogs;
             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.success(cli_utilities_1.messageHandler.parse('CLI_CONFIG_LOG_CONSOLE_SET', String(showConsoleLogs)));
-            cli_utilities_1.cliux.print(cli_utilities_1.messageHandler.parse('CLI_CONFIG_LOG_SET_SUCCESS'), { color: 'green' });
+            if (flags['level'] !== undefined) {
+                cli_utilities_1.cliux.success(cli_utilities_1.messageHandler.parse('CLI_CONFIG_LOG_LEVEL_SET', currentLoggingConfig.level));
+            }
+            if (flags['path'] !== undefined) {
+                cli_utilities_1.cliux.success(cli_utilities_1.messageHandler.parse('CLI_CONFIG_LOG_PATH_SET', currentLoggingConfig.path));
+            }
+            if (flags['show-console-logs'] !== undefined) {
+                cli_utilities_1.cliux.success(cli_utilities_1.messageHandler.parse('CLI_CONFIG_LOG_CONSOLE_SET', String(currentLoggingConfig['showConsoleLogs'])));
+            }
+            cli_utilities_1.cliux.success(cli_utilities_1.messageHandler.parse('CLI_CONFIG_LOG_SET_SUCCESS'));
         }
         catch (error) {
             cli_utilities_1.cliux.error('error', error);
@@ -37,21 +44,26 @@ class LogSetCommand extends cli_command_1.Command {
 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.',
+    level: cli_utilities_1.flags.string({
+        description: 'Set the log level for the CLI. Defaults to "info" if not specified.',
         options: ['debug', 'info', 'warn', 'error'],
     }),
-    'path': cli_utilities_1.flags.string({
-        description: 'Specify the file path where logs should be saved.',
+    path: cli_utilities_1.flags.string({
+        description: 'Specify the directory path where logs should be saved. Supports both relative and absolute paths. Defaults to ~/.contentstack/logs if not specified.',
     }),
     'show-console-logs': cli_utilities_1.flags.boolean({
         description: 'Enable console logging.',
         allowNo: true,
         default: false,
-    })
+    }),
 };
 LogSetCommand.examples = [
     'csdx config:set:log',
-    'csdx config:set:log --level debug --path ./logs/app.log --show-console-logs',
+    'csdx config:set:log --level debug',
+    'csdx config:set:log --path ./logs',
+    'csdx config:set:log --level debug --path ./logs --show-console-logs',
     'csdx config:set:log --no-show-console-logs',
+    'csdx config:set:log --level warn --show-console-logs',
+    'csdx config:set:log --path ~/custom/logs',
+    'csdx config:set:log --path /var/log/contentstack',
 ];

package/lib/utils/log-config-defaults.d.ts

@@ -0,0 +1,21 @@
+export declare const LOG_CONFIG_DEFAULTS: {
+    readonly LEVEL: "info";
+    readonly PATH: string;
+    readonly SHOW_CONSOLE_LOGS: false;
+};
+/**
+ * Resolves a log path to an absolute path
+ * @param logPath - The path to resolve
+ * @returns Absolute path
+ */
+export declare function resolveLogPath(logPath: string): string;
+/**
+ * Gets the effective log configuration with defaults applied
+ * @param currentConfig - Current configuration from config handler
+ * @returns Configuration with defaults applied
+ */
+export declare function getEffectiveLogConfig(currentConfig?: any): {
+    level: any;
+    path: string;
+    showConsoleLogs: any;
+};

package/lib/utils/log-config-defaults.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEffectiveLogConfig = exports.resolveLogPath = exports.LOG_CONFIG_DEFAULTS = void 0;
+const path = require("path");
+const os = require("os");
+exports.LOG_CONFIG_DEFAULTS = {
+    LEVEL: 'info',
+    PATH: path.join(os.homedir(), '.contentstack', 'logs'),
+    SHOW_CONSOLE_LOGS: false,
+};
+/**
+ * Resolves a log path to an absolute path
+ * @param logPath - The path to resolve
+ * @returns Absolute path
+ */
+function resolveLogPath(logPath) {
+    if (!logPath)
+        return exports.LOG_CONFIG_DEFAULTS.PATH;
+    return path.isAbsolute(logPath) ? logPath : path.resolve(process.cwd(), logPath);
+}
+exports.resolveLogPath = resolveLogPath;
+/**
+ * Gets the effective log configuration with defaults applied
+ * @param currentConfig - Current configuration from config handler
+ * @returns Configuration with defaults applied
+ */
+function getEffectiveLogConfig(currentConfig = {}) {
+    var _a;
+    const logLevel = (currentConfig === null || currentConfig === void 0 ? void 0 : currentConfig.level) || exports.LOG_CONFIG_DEFAULTS.LEVEL;
+    const logPath = resolveLogPath((currentConfig === null || currentConfig === void 0 ? void 0 : currentConfig.path) || exports.LOG_CONFIG_DEFAULTS.PATH);
+    const showConsoleLogs = (_a = currentConfig === null || currentConfig === void 0 ? void 0 : currentConfig['showConsoleLogs']) !== null && _a !== void 0 ? _a : exports.LOG_CONFIG_DEFAULTS.SHOW_CONSOLE_LOGS;
+    return {
+        level: logLevel,
+        path: logPath,
+        showConsoleLogs,
+    };
+}
+exports.getEffectiveLogConfig = getEffectiveLogConfig;

package/oclif.manifest.json

@@ -326,12 +326,17 @@
       "description": "Set logging configuration for CLI",
       "examples": [
         "csdx config:set:log",
-        "csdx config:set:log --level debug --path ./logs/app.log --show-console-logs",
-        "csdx config:set:log --no-show-console-logs"
+        "csdx config:set:log --level debug",
+        "csdx config:set:log --path ./logs",
+        "csdx config:set:log --level debug --path ./logs --show-console-logs",
+        "csdx config:set:log --no-show-console-logs",
+        "csdx config:set:log --level warn --show-console-logs",
+        "csdx config:set:log --path ~/custom/logs",
+        "csdx config:set:log --path /var/log/contentstack"
       ],
       "flags": {
         "level": {
-          "description": "Set the log level for the CLI.",
+          "description": "Set the log level for the CLI. Defaults to \"info\" if not specified.",
           "name": "level",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -344,7 +349,7 @@
           "type": "option"
         },
         "path": {
-          "description": "Specify the file path where logs should be saved.",
+          "description": "Specify the directory path where logs should be saved. Supports both relative and absolute paths. Defaults to ~/.contentstack/logs if not specified.",
           "name": "path",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -543,5 +548,5 @@
       ]
     }
   },
-  "version": "1.15.1"
+  "version": "1.15.3"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli-config",
   "description": "Contentstack CLI plugin for configuration",
-  "version": "1.15.1",
+  "version": "1.15.3",
   "author": "Contentstack",
   "scripts": {
     "build": "npm run clean && npm run compile",
@@ -22,7 +22,7 @@
   },
   "dependencies": {
     "@contentstack/cli-command": "~1.6.1",
-    "@contentstack/cli-utilities": "~1.14.0",
+    "@contentstack/cli-utilities": "~1.15.0",
     "@oclif/core": "^4.3.0",
     "@oclif/plugin-help": "^6.2.28",
     "lodash": "^4.17.21"