@alcyone-labs/arg-parser 1.0.0

package/dist/ArgParser.d.ts

@@ -0,0 +1,118 @@
+import { HandlerContext, IFlag, ISubCommand, ProcessedFlag, TParsedArgs } from "./types";
+export declare class ArgParserError extends Error {
+    cmdChain: string[];
+    commandChain: string[];
+    constructor(message: string, cmdChain?: string[]);
+}
+interface IArgParserParams {
+    /**
+     * Add an extra new line between each flag group,
+     * makes the text more readable but uses more space
+     *
+     * Default: true
+     */
+    extraNewLine?: boolean;
+    /**
+     * Wraps the line at width, if shorter, wrapping will be more
+     * aggressive. Wrapping is based on words.
+     *
+     * Default: 50
+     * Minimum: 30
+     */
+    wrapAtWidth?: number;
+    /**
+     * Controls the placing of right text on the screen.
+     * The higher the value, the more to the right the text will be.
+     *
+     * Default: 30
+     * Minimum: 20
+     */
+    blankSpaceWidth?: number;
+    /**
+     * Character to display next to the flag to express mandatory fields.
+     *
+     * Default: *
+     */
+    mandatoryCharacter?: string;
+    /**
+     * Throw an error if a flag is added more than once
+     * @default false
+     */
+    throwForDuplicateFlags?: boolean;
+    description?: string;
+    /**
+     * Automatically handle ArgParserErrors by printing a formatted message
+     * and exiting. Set to false to catch ArgParserError manually.
+     * @default true
+     */
+    handleErrors?: boolean;
+    /**
+     * The command name to display in help suggestions (e.g., 'dabl').
+     * If not provided, it falls back to appName or guessing from the script path.
+     * @since 1.5.1
+     */
+    appCommandName?: string;
+    /**
+     * If true, when this parser is added as a sub-command, it will inherit
+     * flags from its direct parent *unless* a flag with the same name
+     * already exists in this parser. Child flags take precedence.
+     * @default false
+     */
+    inheritParentFlags?: boolean;
+}
+interface IParseOptions {
+    /**
+     * When true, skips help flag processing (doesn't exit or show help)
+     * @default false
+     */
+    skipHelpHandling?: boolean;
+    /**
+     * When true, skips the execution of any command handlers.
+     * @default false
+     */
+    skipHandlers?: boolean;
+}
+type TParsedArgsWithRouting<T = any> = T & {
+    $commandChain?: string[];
+    handlerToExecute?: {
+        handler: Function;
+        context: HandlerContext;
+    };
+};
+export declare class ArgParser {
+    #private;
+    constructor(options?: IArgParserParams & {
+        appName?: string;
+        subCommands?: ISubCommand[];
+        handler?: (ctx: HandlerContext) => void;
+    }, initialFlags?: readonly IFlag[]);
+    get flags(): ProcessedFlag[];
+    get flagNames(): string[];
+    private _addToOutput;
+    addFlags(flags: readonly IFlag[]): this;
+    addFlag(flag: IFlag): this;
+    addSubCommand(subCommandConfig: ISubCommand): this;
+    /**
+     * Sets the handler function for this specific parser instance.
+     * This handler will be executed if this parser is the final one
+     * in the command chain and `executeHandlers` is enabled on the root parser.
+     *
+     * @param handler - The function to execute.
+     * @returns The ArgParser instance for chaining.
+     */
+    setHandler(handler: (ctx: HandlerContext) => void): this;
+    printAll(filePath?: string): void;
+    parse(processArgs: string[], options?: IParseOptions): TParsedArgsWithRouting<any>;
+    /**
+     * Recursive helper for parsing arguments and handling sub-commands.
+     * This method assumes the global help check has already been performed in `parse`.
+     */
+    private _parseRecursive;
+    helpText(): string;
+    getSubCommand(name: string): ISubCommand | undefined;
+    hasFlag(name: string): boolean;
+    getCommandChain(): string[];
+    getLastParseResult(): TParsedArgs<ProcessedFlag[]>;
+}
+export {};
+//# sourceMappingURL=ArgParser.d.ts.map

package/dist/ArgParser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArgParser.d.ts","sourceRoot":"","sources":["../src/ArgParser.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,cAAc,EACd,KAAK,EACL,WAAW,EACX,aAAa,EACb,WAAW,EACZ,MAAM,SAAS,CAAC;AAEjB,qBAAa,cAAe,SAAQ,KAAK;IAI9B,QAAQ,EAAE,MAAM,EAAE;IAHpB,YAAY,EAAE,MAAM,EAAE,CAAC;gBAE5B,OAAO,EAAE,MAAM,EACR,QAAQ,GAAE,MAAM,EAAO;CAMjC;AAKD,UAAU,gBAAgB;IACxB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED,UAAU,aAAa;IACrB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,KAAK,sBAAsB,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG;IACzC,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,gBAAgB,CAAC,EAAE;QAAE,OAAO,EAAE,QAAQ,CAAC;QAAC,OAAO,EAAE,cAAc,CAAA;KAAE,CAAC;CACnE,CAAC;AAOF,qBAAa,SAAS;;gBAqBlB,OAAO,GAAE,gBAAgB,GAAG;QAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,WAAW,CAAC,EAAE,WAAW,EAAE,CAAC;QAC5B,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,IAAI,CAAC;KACpC,EACN,YAAY,CAAC,EAAE,SAAS,KAAK,EAAE;IA6DjC,IAAI,KAAK,IAAI,aAAa,EAAE,CAE3B;IAED,IAAI,SAAS,IAAI,MAAM,EAAE,CAExB;IAED,OAAO,CAAC,YAAY;IAyDpB,QAAQ,CAAC,KAAK,EAAE,SAAS,KAAK,EAAE,GAAG,IAAI;IAKvC,OAAO,CAAC,IAAI,EAAE,KAAK,GAAG,IAAI;IAK1B,aAAa,CAAC,gBAAgB,EAAE,WAAW,GAAG,IAAI;IAsClD;;;;;;;OAOG;IACH,UAAU,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,IAAI,GAAG,IAAI;IAKxD,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI;IA8ajC,KAAK,CACH,WAAW,EAAE,MAAM,EAAE,EACrB,OAAO,CAAC,EAAE,aAAa,GACtB,sBAAsB,CAAC,GAAG,CAAC;IAsD9B;;;OAGG;IACH,OAAO,CAAC,eAAe;IAuLvB,QAAQ,IAAI,MAAM;IAgLX,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS;IAIpD,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAK9B,eAAe,IAAI,MAAM,EAAE;IAU3B,kBAAkB,IAAI,WAAW,CAAC,aAAa,EAAE,CAAC;CAqR1D"}

package/dist/FlagManager.d.ts

@@ -0,0 +1,16 @@
+import { IFlag, ProcessedFlag } from "./types";
+export declare class FlagManager {
+    #private;
+    constructor(options?: {
+        throwForDuplicateFlags?: boolean;
+    }, initialFlags?: readonly IFlag[]);
+    static _safeFlag(flag: IFlag): ProcessedFlag;
+    addFlag(flag: IFlag): this;
+    _setProcessedFlagForInheritance(processedFlag: ProcessedFlag): this;
+    addFlags(flags: readonly IFlag[]): this;
+    hasFlag(name: string): boolean;
+    getFlag(name: string): ProcessedFlag | undefined;
+    get flags(): ProcessedFlag[];
+    get flagNames(): string[];
+}
+//# sourceMappingURL=FlagManager.d.ts.map

package/dist/FlagManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FlagManager.d.ts","sourceRoot":"","sources":["../src/FlagManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,aAAa,EAAiB,MAAM,SAAS,CAAC;AAE9D,qBAAa,WAAW;;gBAKpB,OAAO,GAAE;QAAE,sBAAsB,CAAC,EAAE,OAAO,CAAA;KAAO,EAClD,YAAY,GAAE,SAAS,KAAK,EAAO;IAMrC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,GAAG,aAAa;IAwC5C,OAAO,CAAC,IAAI,EAAE,KAAK,GAAG,IAAI;IAoB1B,+BAA+B,CAAC,aAAa,EAAE,aAAa,GAAG,IAAI;IAQnE,QAAQ,CAAC,KAAK,EAAE,SAAS,KAAK,EAAE,GAAG,IAAI;IAOvC,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI9B,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS;IAIhD,IAAI,KAAK,IAAI,aAAa,EAAE,CAE3B;IAED,IAAI,SAAS,IAAI,MAAM,EAAE,CAExB;CACF"}