@guanghechen/commander 4.0.0 → 4.1.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Change Log
 
+## 4.1.0
+
+### Minor Changes
+
+- ### @guanghechen/reporter
+  - feat: add `setLevel` method for dynamic log level change
+  - refactor: split source into modular files (`level.ts`, `chalk.ts`, `types.ts`, `reporter.ts`)
+  - refactor: move `IReporter` types from `@guanghechen/types` to `@guanghechen/reporter`
+  - export: add level utilities (`LogLevelEnum`, `ILogLevel`, `LOG_LEVELS`, `LOG_LEVEL_VALUES`,
+    `isLogLevel`, `getLogLevelValue`, `resolveLogLevel`)
+  - export: add chalk utilities (`ANSI`, `formatTag`)
+
+  ### @guanghechen/types
+  - refactor: remove `IReporter` and `IReporterLevel` exports (moved to `@guanghechen/reporter`)
+
+  ### @guanghechen/commander
+  - feat: add predefined options `logLevelOption` and `silentOption` with `apply` callback support
+  - refactor: use `ILogLevel` from `@guanghechen/reporter` instead of `IReporterLevel`
+
+  ### Dependent packages
+  - chore: bump version for packages depending on `@guanghechen/types`, `@guanghechen/reporter`, or
+    `@guanghechen/commander`
+
+### Patch Changes
+
+- Updated dependencies:
+  - @guanghechen/reporter@3.2.0
+
 ## 4.0.0
 
 ### Major Changes

package/lib/cjs/index.cjs

@@ -1,5 +1,6 @@
 'use strict';
 
+var reporter = require('@guanghechen/reporter');
 var fs = require('node:fs');
 var path = require('node:path');
 
@@ -37,20 +38,6 @@ class CommanderError extends Error {
     }
 }
 
-class DefaultReporter {
-    debug(message, ...args) {
-        console.debug(message, ...args);
-    }
-    info(message, ...args) {
-        console.info(message, ...args);
-    }
-    warn(message, ...args) {
-        console.warn(message, ...args);
-    }
-    error(message, ...args) {
-        console.error(message, ...args);
-    }
-}
 const LONG_OPTION_REGEX = /^--[a-z][a-z0-9]*(?:-[a-z0-9]+)*$/;
 const NEGATIVE_OPTION_REGEX = /^--no-[a-z][a-z0-9]*(?:-[a-z0-9]+)*$/;
 function kebabToCamelCase(str) {
@@ -228,7 +215,7 @@ class Command {
         return this;
     }
     async run(params) {
-        const { argv, envs, reporter } = params;
+        const { argv, envs, reporter: reporter$1 } = params;
         try {
             const processedArgv = this.#processHelpSubcommand(argv);
             const routeResult = this.#route(processedArgv);
@@ -253,7 +240,7 @@ class Command {
             const ctx = {
                 cmd: leafCommand,
                 envs,
-                reporter: reporter ?? this.#reporter ?? new DefaultReporter(),
+                reporter: reporter$1 ?? this.#reporter ?? new reporter.Reporter(),
                 argv,
             };
             const parseResult = this.#parse(chain, resolveResult, ctx, restArgs);
@@ -283,7 +270,7 @@ class Command {
         }
     }
     parse(params) {
-        const { argv, envs, reporter } = params;
+        const { argv, envs, reporter: reporter$1 } = params;
         const processedArgv = this.#processHelpSubcommand(argv);
         const routeResult = this.#route(processedArgv);
         const { chain, remaining } = routeResult;
@@ -294,7 +281,7 @@ class Command {
         const ctx = {
             cmd: leafCommand,
             envs,
-            reporter: reporter ?? this.#reporter ?? new DefaultReporter(),
+            reporter: reporter$1 ?? this.#reporter ?? new reporter.Reporter(),
             argv,
         };
         return this.#parse(chain, resolveResult, ctx, restArgs);
@@ -1214,9 +1201,37 @@ class PwshCompletion {
     }
 }
 
+const logLevelOption = {
+    long: 'logLevel',
+    type: 'string',
+    args: 'required',
+    desc: 'Set log level',
+    default: 'info',
+    choices: reporter.LOG_LEVELS,
+    coerce: (raw) => {
+        const level = reporter.resolveLogLevel(raw);
+        if (level === undefined) {
+            throw new Error(`Invalid log level: ${raw}`);
+        }
+        return level;
+    },
+    apply: (value, ctx) => {
+        ctx.reporter.setLevel(value);
+    },
+};
+const silentOption = {
+    long: 'silent',
+    type: 'boolean',
+    args: 'none',
+    desc: 'Suppress non-error output',
+    default: false,
+};
+
 exports.BashCompletion = BashCompletion;
 exports.Command = Command;
 exports.CommanderError = CommanderError;
 exports.CompletionCommand = CompletionCommand;
 exports.FishCompletion = FishCompletion;
 exports.PwshCompletion = PwshCompletion;
+exports.logLevelOption = logLevelOption;
+exports.silentOption = silentOption;

package/lib/esm/index.mjs

@@ -1,3 +1,4 @@
+import { Reporter, LOG_LEVELS, resolveLogLevel } from '@guanghechen/reporter';
 import * as fs from 'node:fs';
 import * as path from 'node:path';
 
@@ -15,20 +16,6 @@ class CommanderError extends Error {
     }
 }
 
-class DefaultReporter {
-    debug(message, ...args) {
-        console.debug(message, ...args);
-    }
-    info(message, ...args) {
-        console.info(message, ...args);
-    }
-    warn(message, ...args) {
-        console.warn(message, ...args);
-    }
-    error(message, ...args) {
-        console.error(message, ...args);
-    }
-}
 const LONG_OPTION_REGEX = /^--[a-z][a-z0-9]*(?:-[a-z0-9]+)*$/;
 const NEGATIVE_OPTION_REGEX = /^--no-[a-z][a-z0-9]*(?:-[a-z0-9]+)*$/;
 function kebabToCamelCase(str) {
@@ -231,7 +218,7 @@ class Command {
             const ctx = {
                 cmd: leafCommand,
                 envs,
-                reporter: reporter ?? this.#reporter ?? new DefaultReporter(),
+                reporter: reporter ?? this.#reporter ?? new Reporter(),
                 argv,
             };
             const parseResult = this.#parse(chain, resolveResult, ctx, restArgs);
@@ -272,7 +259,7 @@ class Command {
         const ctx = {
             cmd: leafCommand,
             envs,
-            reporter: reporter ?? this.#reporter ?? new DefaultReporter(),
+            reporter: reporter ?? this.#reporter ?? new Reporter(),
             argv,
         };
         return this.#parse(chain, resolveResult, ctx, restArgs);
@@ -1192,4 +1179,30 @@ class PwshCompletion {
     }
 }
 
-export { BashCompletion, Command, CommanderError, CompletionCommand, FishCompletion, PwshCompletion };
+const logLevelOption = {
+    long: 'logLevel',
+    type: 'string',
+    args: 'required',
+    desc: 'Set log level',
+    default: 'info',
+    choices: LOG_LEVELS,
+    coerce: (raw) => {
+        const level = resolveLogLevel(raw);
+        if (level === undefined) {
+            throw new Error(`Invalid log level: ${raw}`);
+        }
+        return level;
+    },
+    apply: (value, ctx) => {
+        ctx.reporter.setLevel(value);
+    },
+};
+const silentOption = {
+    long: 'silent',
+    type: 'boolean',
+    args: 'none',
+    desc: 'Suppress non-error output',
+    default: false,
+};
+
+export { BashCompletion, Command, CommanderError, CompletionCommand, FishCompletion, PwshCompletion, logLevelOption, silentOption };

package/lib/types/index.d.ts

@@ -1,18 +1,11 @@
+import { IReporter } from '@guanghechen/reporter';
+
 /**
  * Type definitions for @guanghechen/commander
  *
  * @module @guanghechen/commander
  */
-/**
- * Reporter interface for logging.
- * Provided by @guanghechen/reporter or user implementation.
- */
-interface IReporter {
-    debug(message: string, ...args: unknown[]): void;
-    info(message: string, ...args: unknown[]): void;
-    warn(message: string, ...args: unknown[]): void;
-    error(message: string, ...args: unknown[]): void;
-}
+
 /** Token type: long option, short option, or positional */
 type ICommandTokenType = 'long' | 'short' | 'none';
 /**
@@ -326,5 +319,66 @@ declare class PwshCompletion {
     generate(): string;
 }
 
-export { BashCompletion, Command, CommanderError, CompletionCommand, FishCompletion, PwshCompletion };
-export type { ICommand, ICommandAction, ICommandActionParams, ICommandArgumentConfig, ICommandArgumentKind, ICommandArgumentType, ICommandConfig, ICommandContext, ICommandOptionArgs, ICommandOptionConfig, ICommandOptionType, ICommandParseResult, ICommandParsedArgs, ICommandParsedOpts, ICommandResolveResult, ICommandRouteResult, ICommandRunParams, ICommandShiftResult, ICommandToken, ICommandTokenType, ICommandTokenizeResult, ICommanderErrorKind, ICompletionCommandConfig, ICompletionMeta, ICompletionOptionMeta, ICompletionPaths, ICompletionShellType, IReporter };
+/**
+ * Pre-defined common options for @guanghechen/commander
+ *
+ * @module @guanghechen/commander/options
+ */
+
+/**
+ * Pre-defined --log-level option for setting log verbosity.
+ *
+ * Supports: debug | info | hint | warn | error (case-insensitive)
+ *
+ * | Property  | Value                              |
+ * | --------- | ---------------------------------- |
+ * | long      | 'logLevel'                         |
+ * | type      | 'string'                           |
+ * | args      | 'required'                         |
+ * | default   | 'info'                             |
+ * | choices   | LOG_LEVELS                         |
+ * | coerce    | resolveLogLevel (case-insensitive) |
+ * | apply     | ctx.reporter.setLevel(value)       |
+ *
+ * @example
+ * ```typescript
+ * import { logLevelOption } from '@guanghechen/commander'
+ *
+ * const cmd = new Command('app')
+ *   .option(logLevelOption)
+ *   .action(({ opts }) => {
+ *     console.log(opts.logLevel) // 'debug' | 'info' | 'hint' | 'warn' | 'error'
+ *   })
+ *
+ * // Override with spread syntax
+ * .option({ ...logLevelOption, default: 'warn' })
+ * ```
+ */
+declare const logLevelOption: ICommandOptionConfig<string>;
+/**
+ * Pre-defined --silent option for suppressing non-error output.
+ *
+ * | Property  | Value     |
+ * | --------- | --------- |
+ * | long      | 'silent'  |
+ * | type      | 'boolean' |
+ * | args      | 'none'    |
+ * | default   | false     |
+ *
+ * @example
+ * ```typescript
+ * import { silentOption } from '@guanghechen/commander'
+ *
+ * const cmd = new Command('app')
+ *   .option(silentOption)
+ *   .action(({ opts }) => {
+ *     if (!opts.silent) {
+ *       console.log('Processing...')
+ *     }
+ *   })
+ * ```
+ */
+declare const silentOption: ICommandOptionConfig<boolean>;
+
+export { BashCompletion, Command, CommanderError, CompletionCommand, FishCompletion, PwshCompletion, logLevelOption, silentOption };
+export type { ICommand, ICommandAction, ICommandActionParams, ICommandArgumentConfig, ICommandArgumentKind, ICommandArgumentType, ICommandConfig, ICommandContext, ICommandOptionArgs, ICommandOptionConfig, ICommandOptionType, ICommandParseResult, ICommandParsedArgs, ICommandParsedOpts, ICommandResolveResult, ICommandRouteResult, ICommandRunParams, ICommandShiftResult, ICommandToken, ICommandTokenType, ICommandTokenizeResult, ICommanderErrorKind, ICompletionCommandConfig, ICompletionMeta, ICompletionOptionMeta, ICompletionPaths, ICompletionShellType };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guanghechen/commander",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "A minimal, type-safe command-line interface builder with fluent API",
   "author": {
     "name": "guanghechen",
@@ -40,6 +40,9 @@
     "LICENSE",
     "README.md"
   ],
+  "dependencies": {
+    "@guanghechen/reporter": "^3.2.0"
+  },
   "scripts": {
     "build": "rollup -c ../../rollup.config.mjs",
     "clean": "rimraf lib",