convoker 0.3.3 → 0.3.4

package/dist/color.d.ts

@@ -1,153 +0,0 @@
-/**
- * If the runtime supports color.
- */
-export declare const supportsColor: boolean;
-/**
- * Creates a function that wraps a string in ANSI codes.
- * @param open The opening ANSI code.
- * @param close The closing ANSI code.
- * @returns A function that wraps the string in ANSI codes.
- */
-export declare function createAnsiColor(open: number, close: number): (input: any) => string;
-export declare const reset: (input: any) => string;
-export declare const bold: (input: any) => string;
-export declare const dim: (input: any) => string;
-export declare const italic: (input: any) => string;
-export declare const underline: (input: any) => string;
-export declare const overline: (input: any) => string;
-export declare const inverse: (input: any) => string;
-export declare const hidden: (input: any) => string;
-export declare const strikethrough: (input: any) => string;
-export declare const black: (input: any) => string;
-export declare const red: (input: any) => string;
-export declare const green: (input: any) => string;
-export declare const yellow: (input: any) => string;
-export declare const blue: (input: any) => string;
-export declare const magenta: (input: any) => string;
-export declare const cyan: (input: any) => string;
-export declare const white: (input: any) => string;
-export declare const gray: (input: any) => string;
-export declare const bgBlack: (input: any) => string;
-export declare const bgRed: (input: any) => string;
-export declare const bgGreen: (input: any) => string;
-export declare const bgYellow: (input: any) => string;
-export declare const bgBlue: (input: any) => string;
-export declare const bgMagenta: (input: any) => string;
-export declare const bgCyan: (input: any) => string;
-export declare const bgWhite: (input: any) => string;
-export declare const bgGray: (input: any) => string;
-export declare const redBright: (input: any) => string;
-export declare const greenBright: (input: any) => string;
-export declare const yellowBright: (input: any) => string;
-export declare const blueBright: (input: any) => string;
-export declare const magentaBright: (input: any) => string;
-export declare const cyanBright: (input: any) => string;
-export declare const whiteBright: (input: any) => string;
-export declare const bgRedBright: (input: any) => string;
-export declare const bgGreenBright: (input: any) => string;
-export declare const bgYellowBright: (input: any) => string;
-export declare const bgBlueBright: (input: any) => string;
-export declare const bgMagentaBright: (input: any) => string;
-export declare const bgCyanBright: (input: any) => string;
-export declare const bgWhiteBright: (input: any) => string;
-/**
- * A theme.
- */
-export interface Theme {
-    /**
-     * Wraps a string in a background ANSI code.
-     * @param a The string to wrap.
-     */
-    background?(a: string): string;
-    /**
-     * Wraps a string in a foreground ANSI code.
-     * @param a The string to wrap.
-     */
-    foreground?(a: string): string;
-    /**
-     * Wraps a string in a primary ANSI code.
-     * @param a The string to wrap.
-     */
-    primary(a: string): string;
-    /**
-     * Wraps a string in a secondary ANSI code.
-     * @param a The string to wrap.
-     */
-    secondary(a: string): string;
-    /**
-     * Wraps a string in a accent ANSI code.
-     * @param a The string to wrap.
-     */
-    accent?(a: string): string;
-    /**
-     * Wraps a string in a success ANSI code.
-     * @param a The string to wrap.
-     */
-    success(a: string): string;
-    /**
-     * Wraps a string in a warning ANSI code.
-     * @param a The string to wrap.
-     */
-    warning(a: string): string;
-    /**
-     * Wraps a string in a error ANSI code.
-     * @param a The string to wrap.
-     */
-    error(a: string): string;
-    /**
-     * Wraps a string in a info ANSI code.
-     * @param a The string to wrap.
-     */
-    info?(a: string): string;
-    /**
-     * Set of symbols for logging.
-     */
-    symbols?: {
-        /**
-         * Success message symbol.
-         */
-        success: string;
-        /**
-         * Error message symbol.
-         */
-        error: string;
-        /**
-         * Warning message symbol.
-         */
-        warning: string;
-        /**
-         * Information message symbol.
-         */
-        info?: string;
-    };
-    /**
-     * Optional styles.
-     */
-    styles?: {
-        /**
-         * Wraps a string in a bold ANSI code.
-         * @param a The string to wrap.
-         */
-        bold?(a: string): string;
-        /**
-         * Wraps a string in an italic ANSI code.
-         * @param a The string to wrap.
-         */
-        italic?(a: string): string;
-        /**
-         * Wraps a string in an underline ANSI code.
-         * @param a The string to wrap.
-         */
-        underline?(a: string): string;
-    };
-}
-/**
- * The default theme.
- */
-export declare const DEFAULT_THEME: Theme;
-/**
- * Defines a theme.
- * @param theme The (partial) theme.
- * @returns The theme, merged with the default theme.
- */
-export declare function defineTheme(theme: Partial<Theme>): Theme;

package/dist/color.js

@@ -1,143 +0,0 @@
-import { merge } from "./utils";
-/**
- * Detects if the runtime supports colored output.
- * @returns If the runtime supports colored output.
- */
-function detectColorSupport() {
-    // If running in a browser-like environment, return false
-    if (typeof window !== "undefined" && typeof window.document !== "undefined") {
-        return false;
-    }
-    const env = typeof process !== "undefined" ? (process.env ?? {}) : {};
-    // Force-disable colors if NO_COLOR is set
-    if ("NO_COLOR" in env)
-        return false;
-    // Force-enable if FORCE_COLOR is set
-    if ("FORCE_COLOR" in env)
-        return true;
-    // Check for CI systems that support color
-    if ("CI" in env) {
-        if ([
-            "TRAVIS",
-            "CIRCLECI",
-            "APPVEYOR",
-            "GITLAB_CI",
-            "GITHUB_ACTIONS",
-            "BUILDKITE",
-            "DRONE",
-        ].some((k) => k in env) ||
-            env.CI_NAME === "codeship") {
-            return true;
-        }
-        return false;
-    }
-    // Deno detection
-    if (typeof Deno !== "undefined" && Deno.noColor !== undefined) {
-        return !Deno.noColor;
-    }
-    // Node.js or Bun detection
-    if (typeof process !== "undefined" && process.stdout) {
-        const term = env.TERM || "";
-        const colorterm = env.COLORTERM || "";
-        if (colorterm.length > 0)
-            return true;
-        if (term === "dumb")
-            return false;
-        return /(color|ansi|cygwin|xterm|vt100)/i.test(term);
-    }
-    // Other runtimes/Node without TTY
-    return false;
-}
-/**
- * If the runtime supports color.
- */
-export const supportsColor = detectColorSupport();
-/**
- * Creates a function that wraps a string in ANSI codes.
- * @param open The opening ANSI code.
- * @param close The closing ANSI code.
- * @returns A function that wraps the string in ANSI codes.
- */
-export function createAnsiColor(open, close) {
-    const openCode = `\u001b[${open}m`;
-    const closeCode = `\u001b[${close}m`;
-    if (!supportsColor)
-        return (input) => input + "";
-    return (input) => {
-        if (!input)
-            return openCode + closeCode;
-        const str = input + "";
-        // replace any existing close codes with reopen
-        const replaced = str.replace(new RegExp(`\u001b\\[${close}m`, "g"), closeCode + openCode);
-        return openCode + replaced + closeCode;
-    };
-}
-export const reset = createAnsiColor(0, 0);
-export const bold = createAnsiColor(1, 22);
-export const dim = createAnsiColor(2, 22);
-export const italic = createAnsiColor(3, 23);
-export const underline = createAnsiColor(4, 24);
-export const overline = createAnsiColor(53, 55);
-export const inverse = createAnsiColor(7, 27);
-export const hidden = createAnsiColor(8, 28);
-export const strikethrough = createAnsiColor(9, 29);
-export const black = createAnsiColor(30, 39);
-export const red = createAnsiColor(31, 39);
-export const green = createAnsiColor(32, 39);
-export const yellow = createAnsiColor(33, 39);
-export const blue = createAnsiColor(34, 39);
-export const magenta = createAnsiColor(35, 39);
-export const cyan = createAnsiColor(36, 39);
-export const white = createAnsiColor(37, 39);
-export const gray = createAnsiColor(90, 39);
-export const bgBlack = createAnsiColor(40, 49);
-export const bgRed = createAnsiColor(41, 49);
-export const bgGreen = createAnsiColor(42, 49);
-export const bgYellow = createAnsiColor(43, 49);
-export const bgBlue = createAnsiColor(44, 49);
-export const bgMagenta = createAnsiColor(45, 49);
-export const bgCyan = createAnsiColor(46, 49);
-export const bgWhite = createAnsiColor(47, 49);
-export const bgGray = createAnsiColor(100, 49);
-export const redBright = createAnsiColor(91, 39);
-export const greenBright = createAnsiColor(92, 39);
-export const yellowBright = createAnsiColor(93, 39);
-export const blueBright = createAnsiColor(94, 39);
-export const magentaBright = createAnsiColor(95, 39);
-export const cyanBright = createAnsiColor(96, 39);
-export const whiteBright = createAnsiColor(97, 39);
-export const bgRedBright = createAnsiColor(101, 49);
-export const bgGreenBright = createAnsiColor(102, 49);
-export const bgYellowBright = createAnsiColor(103, 49);
-export const bgBlueBright = createAnsiColor(104, 49);
-export const bgMagentaBright = createAnsiColor(105, 49);
-export const bgCyanBright = createAnsiColor(106, 49);
-export const bgWhiteBright = createAnsiColor(107, 49);
-/**
- * The default theme.
- */
-export const DEFAULT_THEME = {
-    primary: cyan,
-    secondary: gray,
-    success: green,
-    warning: yellow,
-    error: red,
-    symbols: {
-        success: "✔",
-        error: "✖",
-        warning: "⚠",
-    },
-    styles: {
-        bold: bold,
-        italic: italic,
-        underline: underline,
-    },
-};
-/**
- * Defines a theme.
- * @param theme The (partial) theme.
- * @returns The theme, merged with the default theme.
- */
-export function defineTheme(theme) {
-    return merge(DEFAULT_THEME, theme);
-}

package/dist/command.d.ts

@@ -1,218 +0,0 @@
-import { type Theme } from "./color";
-import { ConvokerError } from "./error";
-import { type InferInput, type Input } from "./input";
-/**
- * What the command is an alias for.
- */
-export interface CommandAlias<T extends Input = Input> {
-    /**
-     * A pointer to the command.
-     */
-    command: Command<T>;
-    /**
-     * The name of the command this is an alias for.
-     */
-    alias?: string;
-}
-/**
- * The result of the `Command.parse` function.
- */
-export interface ParseResult<T extends Input> {
-    /**
-     * A pointer to the command to run.
-     */
-    command: Command<T>;
-    /**
-     * The input to pass into the command.
-     */
-    input: InferInput<T>;
-    /**
-     * Errors collected during parsing.
-     */
-    errors: ConvokerError[];
-    /**
-     * If this should result in displaying the version of the command.
-     */
-    isVersion: boolean;
-    /**
-     * If this should result in displaying a help screen.
-     */
-    isHelp: boolean;
-}
-/**
- * Command action function.
- */
-export type ActionFn<T extends Input> = (input: InferInput<T>) => any | Promise<any>;
-/**
- * Command middleware function.
- */
-export type MiddlewareFn<T extends Input = Input> = (input: InferInput<T>, next: () => Promise<any>) => any | Promise<any>;
-/**
- * Command error handler.
- */
-export type ErrorFn<T extends Input> = (command: Command<T>, errors: Error[], input: Partial<InferInput<T>>) => void | Promise<void>;
-/**
- * Builder for commands.
- */
-export type Builder = (c: Command<any>) => Command<any> | void;
-/**
- * A command.
- */
-export declare class Command<T extends Input = Input> {
-    /**
-     * The names (aliases) of this command.
-     */
-    $names: string[];
-    /**
-     * The description of this command.
-     */
-    $description: string | undefined;
-    /**
-     * The theme of this command
-     */
-    $theme: Theme | undefined;
-    /**
-     * The version of this command.
-     */
-    $version: string | undefined;
-    /**
-     * The children of this command.
-     */
-    $children: Map<string, CommandAlias>;
-    /**
-     * The parent of this command.
-     */
-    $parent: Command<any> | undefined;
-    /**
-     * If this command allows unknown options.
-     */
-    $allowUnknownOptions: boolean;
-    /**
-     * If you should be able to surpass the amount of positional arguments defined in the input.
-     */
-    $allowSurpassArgLimit: boolean;
-    /**
-     * The input this command takes.
-     */
-    $input: T;
-    /**
-     * The action function of this command.
-     */
-    $fn: ActionFn<T> | undefined;
-    /**
-     * The middlewares associated with this command.
-     */
-    $middlewares: MiddlewareFn<T>[];
-    /**
-     * The error handler of this command.
-     */
-    $errorFn: ErrorFn<T> | undefined;
-    /**
-     * Creates a new command.
-     * @param names The names (aliases).
-     * @param desc The description.
-     * @param version The version.
-     */
-    constructor(names: string | string[], desc?: string, version?: string);
-    /**
-     * Adds a set of aliases to this command.
-     * @param aliases The aliases to add.
-     * @returns this
-     */
-    alias(...aliases: string[]): this;
-    /**
-     * Adds a description to this command.
-     * @param desc The description.
-     * @returns this
-     */
-    description(desc: string): this;
-    /**
-     * Adds a version to this command.
-     * @param version The version.
-     * @returns this
-     */
-    version(version: string): this;
-    /**
-     * Sets the input for this command.
-     * @param version The input.
-     * @returns this
-     */
-    input<TInput extends Input>(input: TInput): Command<TInput>;
-    /**
-     * Adds a chain of middlewares.
-     * @param fns The middlewares to use.
-     * @returns this
-     */
-    use(...fns: MiddlewareFn<T>[]): this;
-    /**
-     * Sets the action function for this command.
-     * @param fn The action.
-     * @returns this
-     */
-    action(fn: ActionFn<T>): this;
-    /**
-     * Sets the error function for this command.
-     * @param fn The error handler.
-     * @returns this
-     */
-    error(fn: ErrorFn<T>): this;
-    /**
-     * Adds an existing command to this.
-     * @param command The command.
-     * @returns this
-     */
-    add(command: Command<any>): this;
-    /**
-     * Creates a new subcommand and adds it.
-     * @param names The aliases of the subcommand.
-     * @param builder A builder to create the command.
-     */
-    subCommand(names: string | string[], builder: Builder): this;
-    /**
-     * Creates a new subcommand and adds it.
-     * @param names The aliases of the subcommand.
-     * @param desc The description of the subcommand.
-     * @param version The version of the subcommand.
-     */
-    subCommand(names: string | string[], desc?: string, version?: string): Command<any>;
-    /**
-     * Allows unknown options.
-     * @returns this
-     */
-    allowUnknownOptions(): this;
-    /**
-     * Parses a set of command-line arguments.
-     * @param argv The arguments to parse.
-     * @returns A parse result.
-     */
-    parse(argv: string[]): Promise<ParseResult<T>>;
-    private buildInputMap;
-    /**
-     * Allows surpassing the amount of arguments specified.
-     * @returns this
-     */
-    allowSurpassArgLimit(): this;
-    /**
-     * Gets the full command path (name including parents).
-     * @returns The full command path.
-     */
-    fullCommandPath(): string;
-    /**
-     * The default error screen.
-     * @param errors The errors.
-     */
-    defaultErrorScreen(errors: Error[]): void;
-    /**
-     * Handles a set of errors.
-     * @param errors The errors to handle.
-     * @param input The parsed input, if possible.
-     * @returns this
-     */
-    handleErrors(errors: Error[], input?: Partial<InferInput<T>>): Promise<this>;
-    /**
-     * Runs a command.
-     * @param argv The arguments to run the command with. Defaults to your runtime's `argv` equivalent.
-     * @returns this
-     */
-    run(argv?: string[]): Promise<this>;
-}