@code-pushup/cli/src/lib/yargs-cli.d.ts

A CLI to run all kinds of code quality measurements to align your team with company goals

import { type Argv, type CommandModule, type Options } from 'yargs';
export declare const yargsDecorator: {
    'Commands:': string;
    'Options:': string;
    'Examples:': string;
    boolean: string;
    count: string;
    string: string;
    array: string;
    required: string;
    'default:': string;
    'choices:': string;
    'aliases:': string;
};
/**
 * returns configurable yargs CLI for code-pushup
 *
 * @example
 * yargsCli(hideBin(process.argv))
 *   // bootstrap CLI; format arguments
 *   .argv;
 */
export declare function yargsCli<T = unknown>(argv: string[], cfg: {
    usageMessage?: string;
    scriptName?: string;
    commands?: CommandModule[];
    options?: {
        [key: string]: Options;
    };
    groups?: {
        [key: string]: string[];
    };
    examples?: [string, string][];
    middlewares?: {
        middlewareFunction: unknown;
        applyBeforeValidation?: boolean;
    }[];
    noExitProcess?: boolean;
}): Argv<T>;