@visulima/jsdoc-open-api 3.0.9 → 3.0.10

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## @visulima/jsdoc-open-api [3.0.10](https://github.com/visulima/visulima/compare/%40visulima%2Fjsdoc-open-api%403.0.9...%40visulima%2Fjsdoc-open-api%403.0.10) (2026-07-27)
+
+
+### Dependencies
+
+* **@visulima/fs:** upgraded to 5.0.11
+
 ## @visulima/jsdoc-open-api [3.0.9](https://github.com/visulima/visulima/compare/%40visulima%2Fjsdoc-open-api%403.0.8...%40visulima%2Fjsdoc-open-api%403.0.9) (2026-07-27)
 
 

package/dist/cli/commander/index.d.ts

@@ -21,7 +21,6 @@ declare class CommanderError extends Error {
    */
   constructor(exitCode: number, code: string, message: string);
 }
-// deprecated old name
 interface ErrorOptions {
   // optional parameter for error()
   /** an id string representing the error */
@@ -43,32 +42,26 @@ declare class Argument {
    * indicate this with <> around the name. Put [] around the name for an optional argument.
    */
   constructor(arg: string, description?: string);
-
   /**
    * Return argument name.
    */
   name(): string;
-
   /**
    * Set the default value, and optionally supply the description to be displayed in the help.
    */
   default(value: unknown, description?: string): this;
-
   /**
    * Set the custom handler for processing CLI command arguments into argument values.
    */
   argParser<T>(fn: (value: string, previous: T) => T): this;
-
   /**
    * Only allow argument value to be one of choices.
    */
   choices(values: readonly string[]): this;
-
   /**
    * Make argument required.
    */
   argRequired(): this;
-
   /**
    * Make argument optional.
    */
@@ -97,7 +90,6 @@ declare class Option {
    * Set the default value, and optionally supply the description to be displayed in the help.
    */
   default(value: unknown, description?: string): this;
-
   /**
    * Preset to use when option used without option-argument, especially optional but also boolean and negated.
    * The custom processing (parseArg) is called.
@@ -109,7 +101,6 @@ declare class Option {
    * ```
    */
   preset(arg: unknown): this;
-
   /**
    * Add option name(s) that conflict with this option.
    * An error will be displayed if conflicting options are found during parsing.
@@ -121,7 +112,6 @@ declare class Option {
    * ```
    */
   conflicts(names: string | string[]): this;
-
   /**
    * Specify implied option values for when this option is set and the implied options are not.
    *
@@ -133,7 +123,6 @@ declare class Option {
    *   .addOption(new Option('--trace', 'log extra details').implies({ log: 'trace.txt' }));
    */
   implies(optionValues: OptionValues): this;
-
   /**
    * Set environment variable to check for option value.
    *
@@ -141,43 +130,35 @@ declare class Option {
    * undefined, or the source of the current value is 'default' or 'config' or 'env'.
    */
   env(name: string): this;
-
   /**
    * Set the custom handler for processing CLI option arguments into option values.
    */
   argParser<T>(fn: (value: string, previous: T) => T): this;
-
   /**
    * Whether the option is mandatory and must have a value after parsing.
    */
   makeOptionMandatory(mandatory?: boolean): this;
-
   /**
    * Hide option in help.
    */
   hideHelp(hide?: boolean): this;
-
   /**
    * Only allow option value to be one of choices.
    */
   choices(values: readonly string[]): this;
-
   /**
    * Return option name.
    */
   name(): string;
-
   /**
    * Return option name, in a camelcase format that can be used
    * as an object attribute key.
    */
   attributeName(): string;
-
   /**
    * Set the help group heading.
    */
   helpGroup(heading: string): this;
-
   /**
    * Return whether a boolean option.
    *
@@ -204,7 +185,6 @@ declare class Help {
     helpWidth?: number;
     outputHasColors?: boolean;
   }): void;
-
   /** Get the command term to show in the list of subcommands. */
   subcommandTerm(cmd: Command): string;
   /** Get the command summary to show in the list of subcommands. */
@@ -217,12 +197,10 @@ declare class Help {
   argumentTerm(argument: Argument): string;
   /** Get the argument description to show in the list of arguments. */
   argumentDescription(argument: Argument): string;
-
   /** Get the command usage to be displayed at the top of the built-in help. */
   commandUsage(cmd: Command): string;
   /** Get the description for the command. */
   commandDescription(cmd: Command): string;
-
   /** Get an array of the visible subcommands. Includes a placeholder for the implicit help command, if there is one. */
   visibleCommands(cmd: Command): Command[];
   /** Get an array of the visible options. Includes a placeholder for the implicit help option, if there is one. */
@@ -231,7 +209,6 @@ declare class Help {
   visibleGlobalOptions(cmd: Command): Option[];
   /** Get an array of the arguments which have descriptions. */
   visibleArguments(cmd: Command): Argument[];
-
   /** Get the longest command term length. */
   longestSubcommandTermLength(cmd: Command, helper: Help): number;
   /** Get the longest option term length. */
@@ -240,13 +217,10 @@ declare class Help {
   longestGlobalOptionTermLength(cmd: Command, helper: Help): number;
   /** Get the longest argument term length. */
   longestArgumentTermLength(cmd: Command, helper: Help): number;
-
   /** Return display width of string, ignoring ANSI escape sequences. Used in padding and wrapping calculations. */
   displayWidth(str: string): number;
-
   /** Style the titles. Called with 'Usage:', 'Options:', etc. */
   styleTitle(title: string): string;
-
   /** Usage: <str> */
   styleUsage(str: string): string;
   /** Style for command name in usage string.  */
@@ -266,19 +240,15 @@ declare class Help {
   styleSubcommandText(str: string): string;
   /** Base style used in terms and usage for arguments. */
   styleArgumentText(str: string): string;
-
   /** Calculate the pad width from the maximum term length. */
   padWidth(cmd: Command, helper: Help): number;
-
   /**
    * Wrap a string at whitespace, preserving existing line breaks.
    * Wrapping is skipped if the width is less than `minWidthToWrap`.
    */
   boxWrap(str: string, width: number): string;
-
   /** Detect manually wrapped and indented strings by checking for line break followed by whitespace. */
   preformatted(str: string): boolean;
-
   /**
    * Format the "item", which consists of a term and description. Pad the term and wrap the description, indenting the following lines.
    *
@@ -287,17 +257,14 @@ declare class Help {
    *          DD DDD
    */
   formatItem(term: string, termWidth: number, description: string, helper: Help): string;
-
   /**
    * Format a list of items, given a heading and an array of formatted items.
    */
   formatItemList(heading: string, items: string[], helper: Help): string[];
-
   /**
    * Group items by their help group heading.
    */
   groupItems<T extends Command | Option>(unsortedItems: T[], visibleItems: T[], getGroup: (item: T) => string): Map<string, T[]>;
-
   /** Generate the built-in help text. */
   formatHelp(cmd: Command, helper: Help): string;
 }
@@ -350,7 +317,6 @@ declare class Command {
    * Get the program version.
    */
   version(): string | undefined;
-
   /**
    * Define a command, implemented using an action handler.
    *
@@ -391,7 +357,6 @@ declare class Command {
    * @returns `this` command for chaining
    */
   command(nameAndArgs: string, description: string, opts?: ExecutableCommandOptions): this;
-
   /**
    * Factory routine to create a new unattached command.
    *
@@ -399,7 +364,6 @@ declare class Command {
    * create the command. You can override createCommand to customise subcommands.
    */
   createCommand(name?: string): Command;
-
   /**
    * Add a prepared subcommand.
    *
@@ -408,7 +372,6 @@ declare class Command {
    * @returns `this` command for chaining
    */
   addCommand(cmd: Command, opts?: CommandOptions): this;
-
   /**
    * Factory routine to create a new unattached argument.
    *
@@ -416,7 +379,6 @@ declare class Command {
    * create the argument. You can override createArgument to return a custom argument.
    */
   createArgument(name: string, description?: string): Argument;
-
   /**
    * Define argument syntax for command.
    *
@@ -439,7 +401,6 @@ declare class Command {
    * @returns `this` command for chaining
    */
   addArgument(arg: Argument): this;
-
   /**
    * Define argument syntax for command, adding multiple at once (without descriptions).
    *
@@ -453,7 +414,6 @@ declare class Command {
    * @returns `this` command for chaining
    */
   arguments(names: string): this;
-
   /**
    * Customise or override default help command. By default a help command is automatically added if your command has subcommands.
    *
@@ -475,28 +435,23 @@ declare class Command {
   addHelpCommand(nameAndArgs: string, description?: string): this;
   /** @deprecated since v12, instead use helpCommand */
   addHelpCommand(enable?: boolean): this;
-
   /**
    * Add hook for life cycle event.
    */
   hook(event: HookEvent, listener: (thisCommand: Command, actionCommand: Command) => void | Promise<void>): this;
-
   /**
    * Register callback to use as replacement for calling process.exit.
    */
   exitOverride(callback?: (err: CommanderError) => never | void): this;
-
   /**
    * Display error message and exit (or call exitOverride).
    */
   error(message: string, errorOptions?: ErrorOptions): never;
-
   /**
    * You can customise the help with a subclass of Help by overriding createHelp,
    * or by overriding Help properties using configureHelp().
    */
   createHelp(): Help;
-
   /**
    * You can customise the help by overriding Help properties using configureHelp(),
    * or with a subclass of Help by overriding createHelp().
@@ -504,7 +459,6 @@ declare class Command {
   configureHelp(configuration: HelpConfiguration): this;
   /** Get configuration */
   configureHelp(): HelpConfiguration;
-
   /**
    * The default output goes to stdout and stderr. You can customise this for special
    * applications. You can also customise the display of errors by overriding outputError.
@@ -524,24 +478,20 @@ declare class Command {
   configureOutput(configuration: OutputConfiguration): this;
   /** Get configuration */
   configureOutput(): OutputConfiguration;
-
   /**
    * Copy settings that are useful to have in common across root command and subcommands.
    *
    * (Used internally when adding a command using `.command()` so subcommands inherit parent settings.)
    */
   copyInheritedSettings(sourceCommand: Command): this;
-
   /**
    * Display the help or a custom message after an error occurs.
    */
   showHelpAfterError(displayHelp?: boolean | string): this;
-
   /**
    * Display suggestion of similar commands for unknown commands, or options for unknown options.
    */
   showSuggestionAfterError(displaySuggestion?: boolean): this;
-
   /**
    * Register callback `fn` for the command.
    *
@@ -558,7 +508,6 @@ declare class Command {
    * @returns `this` command for chaining
    */
   action(fn: (this: this, ...args: any[]) => void | Promise<void>): this;
-
   /**
    * Define option with `flags`, `description`, and optional argument parsing function or `defaultValue` or both.
    *
@@ -583,7 +532,6 @@ declare class Command {
   option<T>(flags: string, description: string, parseArg: (value: string, previous: T) => T, defaultValue?: T): this;
   /** @deprecated since v7, instead use choices or a custom function */
   option(flags: string, description: string, regexp: RegExp, defaultValue?: string | boolean | string[]): this;
-
   /**
    * Define a required option, which must have a value after parsing. This usually means
    * the option must be specified on the command line. (Otherwise the same as .option().)
@@ -594,23 +542,19 @@ declare class Command {
   requiredOption<T>(flags: string, description: string, parseArg: (value: string, previous: T) => T, defaultValue?: T): this;
   /** @deprecated since v7, instead use choices or a custom function */
   requiredOption(flags: string, description: string, regexp: RegExp, defaultValue?: string | boolean | string[]): this;
-
   /**
    * Factory routine to create a new unattached option.
    *
    * See .option() for creating an attached option, which uses this routine to
    * create the option. You can override createOption to return a custom option.
    */
-
   createOption(flags: string, description?: string): Option;
-
   /**
    * Add a prepared Option.
    *
    * See .option() and .requiredOption() for creating and attaching an option in a single call.
    */
   addOption(option: Option): this;
-
   /**
    * Whether to store option values as properties on command object,
    * or store separately (specify false). In both cases the option values can be accessed using .opts().
@@ -624,27 +568,22 @@ declare class Command {
    * Retrieve option value.
    */
   getOptionValue(key: string): any;
-
   /**
    * Store option value.
    */
   setOptionValue(key: string, value: unknown): this;
-
   /**
    * Store option value and where the value came from.
    */
   setOptionValueWithSource(key: string, value: unknown, source: OptionValueSource): this;
-
   /**
    * Get source of option value.
    */
   getOptionValueSource(key: string): OptionValueSource | undefined;
-
   /**
    * Get source of option value. See also .optsWithGlobals().
    */
   getOptionValueSourceWithGlobals(key: string): OptionValueSource | undefined;
-
   /**
    * Alter parsing of short flags with optional values.
    *
@@ -658,21 +597,18 @@ declare class Command {
    * @returns `this` command for chaining
    */
   combineFlagAndOptionalValue(combine?: boolean): this;
-
   /**
    * Allow unknown options on the command line.
    *
    * @returns `this` command for chaining
    */
   allowUnknownOption(allowUnknown?: boolean): this;
-
   /**
    * Allow excess command-arguments on the command line. Pass false to make excess arguments an error.
    *
    * @returns `this` command for chaining
    */
   allowExcessArguments(allowExcess?: boolean): this;
-
   /**
    * Enable positional options. Positional means global options are specified before subcommands which lets
    * subcommands reuse the same option names, and also enables subcommands to turn on passThroughOptions.
@@ -682,7 +618,6 @@ declare class Command {
    * @returns `this` command for chaining
    */
   enablePositionalOptions(positional?: boolean): this;
-
   /**
    * Pass through options that come after command-arguments rather than treat them as command-options,
    * so actual command-options come before command-arguments. Turning this on for a subcommand requires
@@ -693,7 +628,6 @@ declare class Command {
    * @returns `this` command for chaining
    */
   passThroughOptions(passThrough?: boolean): this;
-
   /**
    * Parse `argv`, setting options and invoking commands when defined.
    *
@@ -716,7 +650,6 @@ declare class Command {
    * @returns `this` command for chaining
    */
   parse(argv?: readonly string[], parseOptions?: ParseOptions): this;
-
   /**
    * Parse `argv`, setting options and invoking commands when defined.
    *
@@ -737,7 +670,6 @@ declare class Command {
    * @returns Promise
    */
   parseAsync(argv?: readonly string[], parseOptions?: ParseOptions): Promise<this>;
-
   /**
    * Called the first time parse is called to save state and allow a restore before subsequent calls to parse.
    * Not usually called directly, but available for subclasses to save their custom state.
@@ -745,7 +677,6 @@ declare class Command {
    * This is called in a lazy way. Only commands used in parsing chain will have state saved.
    */
   saveStateBeforeParse(): void;
-
   /**
    * Restore state before parse for calls after the first.
    * Not usually called directly, but available for subclasses to save their custom state.
@@ -753,7 +684,6 @@ declare class Command {
    * This is called in a lazy way. Only commands used in parsing chain will have state restored.
    */
   restoreStateBeforeParse(): void;
-
   /**
    * Parse options from `argv` removing known options,
    * and return argv split into operands and unknown arguments.
@@ -767,23 +697,19 @@ declare class Command {
    *     sub -- --unknown uuu op => [sub --unknown uuu op], []
    */
   parseOptions(argv: string[]): ParseOptionsResult;
-
   /**
    * Return an object containing local option values as key-value pairs
    */
   opts<T extends OptionValues>(): T;
-
   /**
    * Return an object containing merged local and global option values as key-value pairs.
    */
   optsWithGlobals<T extends OptionValues>(): T;
-
   /**
    * Set the description.
    *
    * @returns `this` command for chaining
    */
-
   description(str: string): this;
   /** @deprecated since v8, instead use .argument to add command argument with description */
   description(str: string, argsDescription: Record<string, string>): this;
@@ -791,19 +717,16 @@ declare class Command {
    * Get the description.
    */
   description(): string;
-
   /**
    * Set the summary. Used when listed as subcommand of parent.
    *
    * @returns `this` command for chaining
    */
-
   summary(str: string): this;
   /**
    * Get the summary.
    */
   summary(): string;
-
   /**
    * Set an alias for the command.
    *
@@ -816,7 +739,6 @@ declare class Command {
    * Get alias for the command.
    */
   alias(): string;
-
   /**
    * Set aliases for the command.
    *
@@ -829,7 +751,6 @@ declare class Command {
    * Get aliases for the command.
    */
   aliases(): string[];
-
   /**
    * Set the command usage.
    *
@@ -840,7 +761,6 @@ declare class Command {
    * Get the command usage.
    */
   usage(): string;
-
   /**
    * Set the name of the command.
    *
@@ -851,7 +771,6 @@ declare class Command {
    * Get the name of the command.
    */
   name(): string;
-
   /**
    * Set the name of the command from script filename, such as process.argv[1],
    * or import.meta.filename.
@@ -866,7 +785,6 @@ declare class Command {
    * @returns `this` command for chaining
    */
   nameFromFilename(filename: string): this;
-
   /**
    * Set the directory for searching for executable subcommands of this command.
    *
@@ -884,7 +802,6 @@ declare class Command {
    * Get the executable search directory.
    */
   executableDir(): string | null;
-
   /**
    * Set the help group heading for this subcommand in parent command's help.
    *
@@ -895,7 +812,6 @@ declare class Command {
    * Get the help group heading for this subcommand in parent command's help.
    */
   helpGroup(): string;
-
   /**
    * Set the default help group heading for subcommands added to this command.
    * (This does not override a group set directly on the subcommand using .helpGroup().)
@@ -913,7 +829,6 @@ declare class Command {
    * Get the default help group heading for subcommands added to this command.
    */
   commandsGroup(): string;
-
   /**
    * Set the default help group heading for options added to this command.
    * (This does not override a group set directly on the option using .helpGroup().)
@@ -931,7 +846,6 @@ declare class Command {
    * Get the default help group heading for options added to this command.
    */
   optionsGroup(): string;
-
   /**
    * Output help information for this command.
    *
@@ -941,25 +855,21 @@ declare class Command {
   outputHelp(context?: HelpContext): void;
   /** @deprecated since v7 */
   outputHelp(cb: (str: string) => string): void;
-
   /**
    * Return command help documentation.
    */
   helpInformation(context?: HelpContext): string;
-
   /**
    * You can pass in flags and a description to override the help
    * flags and help description for your command. Pass in false
    * to disable the built-in help option.
    */
   helpOption(flags?: string | boolean, description?: string): this;
-
   /**
    * Supply your own option to use for the built-in help option.
    * This is an alternative to using helpOption() to customise the flags and description etc.
    */
   addHelpOption(option: Option): this;
-
   /**
    * Output help information and exit.
    *
@@ -968,7 +878,6 @@ declare class Command {
   help(context?: HelpContext): never;
   /** @deprecated since v7 */
   help(cb: (str: string) => string): never;
-
   /**
    * Add additional text to be displayed with the built-in help.
    *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@visulima/jsdoc-open-api",
-  "version": "3.0.9",
+  "version": "3.0.10",
   "description": "Generates swagger doc based on JSDoc.",
   "keywords": [
     "api",
@@ -90,7 +90,7 @@
   },
   "dependencies": {
     "@apidevtools/swagger-parser": "^12.1.0",
-    "@visulima/fs": "5.0.10",
+    "@visulima/fs": "5.0.11",
     "comment-parser": "1.4.7",
     "es-toolkit": "^1.49.0",
     "yaml": "2.9.0"