@code-pushup/cli 0.56.0 → 0.57.0

package/src/lib/yargs-cli.js

@@ -0,0 +1,105 @@
+/* eslint-disable max-lines-per-function */
+import { blue, dim, green } from 'ansis';
+import { createRequire } from 'node:module';
+import yargs, {} from 'yargs';
+import { formatSchema } from '@code-pushup/models';
+import { TERMINAL_WIDTH } from '@code-pushup/utils';
+import { descriptionStyle, formatNestedValues, formatObjectValue, headerStyle, titleStyle, } from './implementation/formatting.js';
+import { logErrorBeforeThrow } from './implementation/global.utils.js';
+export const yargsDecorator = {
+    'Commands:': `${green('Commands')}:`,
+    'Options:': `${green('Options')}:`,
+    'Examples:': `${green('Examples')}:`,
+    boolean: blue('boolean'),
+    count: blue('count'),
+    string: blue('string'),
+    array: blue('array'),
+    required: blue('required'),
+    'default:': `${blue('default')}:`,
+    'choices:': `${blue('choices')}:`,
+    'aliases:': `${blue('aliases')}:`,
+};
+/**
+ * returns configurable yargs CLI for code-pushup
+ *
+ * @example
+ * yargsCli(hideBin(process.argv))
+ *   // bootstrap CLI; format arguments
+ *   .argv;
+ */
+export function yargsCli(argv, cfg) {
+    const { usageMessage, scriptName, noExitProcess } = cfg;
+    const commands = cfg.commands ?? [];
+    const middlewares = cfg.middlewares ?? [];
+    const options = cfg.options ?? {};
+    const groups = cfg.groups ?? {};
+    const examples = cfg.examples ?? [];
+    const cli = yargs(argv);
+    const packageJson = createRequire(import.meta.url)('../../package.json');
+    // setup yargs
+    cli
+        .updateLocale(yargsDecorator)
+        // take minimum of TERMINAL_WIDTH or full width of the terminal
+        .wrap(Math.max(TERMINAL_WIDTH, cli.terminalWidth()))
+        .help('help', descriptionStyle('Show help'))
+        .alias('h', 'help')
+        .showHelpOnFail(false)
+        .version('version', dim `Show version`, packageJson.version)
+        .check(args => {
+        const persist = args['persist'];
+        return persist == null || validatePersistFormat(persist);
+    })
+        .parserConfiguration({
+        'strip-dashed': true,
+    })
+        .coerce('config', (config) => Array.isArray(config) ? config.at(-1) : config)
+        .options(formatNestedValues(options, 'describe'));
+    // usage message
+    if (usageMessage) {
+        cli.usage(titleStyle(usageMessage));
+    }
+    // script name
+    if (scriptName) {
+        cli.scriptName(scriptName);
+    }
+    // add examples
+    examples.forEach(([exampleName, description]) => cli.example(exampleName, descriptionStyle(description)));
+    // add groups
+    Object.entries(groups).forEach(([groupName, optionNames]) => cli.group(optionNames, headerStyle(groupName)));
+    // add middlewares
+    middlewares.forEach(({ middlewareFunction, applyBeforeValidation }) => {
+        cli.middleware(logErrorBeforeThrow(middlewareFunction), applyBeforeValidation);
+    });
+    // add commands
+    commands.forEach(commandObj => {
+        cli.command(formatObjectValue({
+            ...commandObj,
+            handler: logErrorBeforeThrow(commandObj.handler),
+            ...(typeof commandObj.builder === 'function' && {
+                builder: logErrorBeforeThrow(commandObj.builder),
+            }),
+        }, 'describe'));
+    });
+    // this flag should be set for tests and debugging purposes
+    // when there is an error and exitProcess is called, it suppresses the error message
+    // more info here: https://yargs.js.org/docs/#api-reference-exitprocessenable
+    if (noExitProcess) {
+        cli.exitProcess(false);
+    }
+    // return CLI object
+    return cli;
+}
+function validatePersistFormat(persist) {
+    try {
+        if (persist.format != null) {
+            persist.format
+                .flatMap(format => format.split(','))
+                .forEach(format => formatSchema.parse(format));
+        }
+        return true;
+    }
+    catch {
+        throw new Error(`Invalid persist.format option. Valid options are: ${Object.values(formatSchema.Values).join(', ')}`);
+    }
+}
+//# sourceMappingURL=yargs-cli.js.map

package/src/lib/yargs-cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"yargs-cli.js","sourceRoot":"","sources":["../../../../../packages/cli/src/lib/yargs-cli.ts"],"names":[],"mappings":"AAAA,2CAA2C;AAC3C,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,EAAE,EAMb,MAAM,OAAO,CAAC;AACf,OAAO,EAAsB,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,iBAAiB,EACjB,WAAW,EACX,UAAU,GACX,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAEvE,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,WAAW,EAAE,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG;IACpC,UAAU,EAAE,GAAG,KAAK,CAAC,SAAS,CAAC,GAAG;IAClC,WAAW,EAAE,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG;IACpC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC;IACxB,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC;IACpB,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC;IACtB,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC;IACpB,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC;IAC1B,UAAU,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG;IACjC,UAAU,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG;IACjC,UAAU,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG;CAClC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,UAAU,QAAQ,CACtB,IAAc,EACd,GAYC;IAED,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,aAAa,EAAE,GAAG,GAAG,CAAC;IACxD,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC;IACpC,MAAM,WAAW,GAAG,GAAG,CAAC,WAAW,IAAI,EAAE,CAAC;IAC1C,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC;IAClC,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC;IAChC,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC;IACpC,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;IAExB,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAChD,oBAAoB,CACkB,CAAC;IAEzC,cAAc;IACd,GAAG;SACA,YAAY,CAAC,cAAc,CAAC;QAC7B,+DAA+D;SAC9D,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC;SACnD,IAAI,CAAC,MAAM,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;SAC3C,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC;SAClB,cAAc,CAAC,KAAK,CAAC;SACrB,OAAO,CAAC,SAAS,EAAE,GAAG,CAAA,cAAc,EAAE,WAAW,CAAC,OAAO,CAAC;SAC1D,KAAK,CAAC,IAAI,CAAC,EAAE;QACZ,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAA8B,CAAC;QAC7D,OAAO,OAAO,IAAI,IAAI,IAAI,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAC3D,CAAC,CAAC;SACD,mBAAmB,CAAC;QACnB,cAAc,EAAE,IAAI;KACyB,CAAC;SAC/C,MAAM,CAAC,QAAQ,EAAE,CAAC,MAAyB,EAAE,EAAE,CAC9C,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAC/C;SACA,OAAO,CAAC,kBAAkB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;IAEpD,gBAAgB;IAChB,IAAI,YAAY,EAAE,CAAC;QACjB,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC;IACtC,CAAC;IAED,cAAc;IACd,IAAI,UAAU,EAAE,CAAC;QACf,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IAC7B,CAAC;IAED,eAAe;IACf,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,EAAE,WAAW,CAAC,EAAE,EAAE,CAC9C,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC,CACxD,CAAC;IAEF,aAAa;IACb,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EAAE,WAAW,CAAC,EAAE,EAAE,CAC1D,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC,CAC/C,CAAC;IAEF,kBAAkB;IAClB,WAAW,CAAC,OAAO,CAAC,CAAC,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,EAAE,EAAE;QACpE,GAAG,CAAC,UAAU,CACZ,mBAAmB,CAAC,kBAAwC,CAAC,EAC7D,qBAAqB,CACtB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,eAAe;IACf,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;QAC5B,GAAG,CAAC,OAAO,CACT,iBAAiB,CACf;YACE,GAAG,UAAU;YACb,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,OAAO,CAAC;YAChD,GAAG,CAAC,OAAO,UAAU,CAAC,OAAO,KAAK,UAAU,IAAI;gBAC9C,OAAO,EAAE,mBAAmB,CAAC,UAAU,CAAC,OAAO,CAAC;aACjD,CAAC;SACH,EACD,UAAU,CACX,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,2DAA2D;IAC3D,oFAAoF;IACpF,6EAA6E;IAC7E,IAAI,aAAa,EAAE,CAAC;QAClB,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAED,oBAAoB;IACpB,OAAO,GAAyB,CAAC;AACnC,CAAC;AAED,SAAS,qBAAqB,CAAC,OAAsB;IACnD,IAAI,CAAC;QACH,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;YAC3B,OAAO,CAAC,MAAM;iBACX,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;iBACpC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;QACnD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CACb,qDAAqD,MAAM,CAAC,MAAM,CAChE,YAAY,CAAC,MAAM,CACpB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACf,CAAC;IACJ,CAAC;AACH,CAAC"}