cli-forge 0.4.0 → 0.6.0

package/src/lib/test-harness.d.ts

@@ -0,0 +1,36 @@
+import { ParsedArgs } from '@cli-forge/parser';
+import { CLI } from './cli-forge';
+export type TestHarnessParseResult<T extends ParsedArgs> = {
+    /**
+     * Parsed arguments. Note the the typing of this is based on the CLI typings,
+     * but no runtime validation outside of the configured validation checks on
+     * individual options will be performed. If you want to validate the arguments,
+     * you should do so in your test or configure a `validate` callback for the option.
+     */
+    args: T;
+    /**
+     * The command chain that was resolved during parsing. This is used for testing
+     * that the correct command is ran when resolving a subcommand. A test that checks
+     * this may look like:
+     *
+     * ```ts
+     * const harness = new TestHarness(cli);
+     * const { args, commandChain } = await harness.parse(['hello', '--name=sir']);
+     * expect(commandChain).toEqual(['hello']);
+     * ```
+     *
+     * The above test would check that the `hello` command was resolved when parsing
+     * the argstring, and since only one command's handler will ever be called, this
+     * can be used to ensure that the correct command is ran.
+     */
+    commandChain: string[];
+};
+/**
+ * Utility for testing CLI instances. Can check argument parsing and validation, including
+ * command chain resolution.
+ */
+export declare class TestHarness<T extends ParsedArgs> {
+    private cli;
+    constructor(cli: CLI<T>);
+    parse(args: string[]): Promise<TestHarnessParseResult<T>>;
+}

package/src/lib/test-harness.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestHarness = void 0;
+const cli_forge_1 = require("./cli-forge");
+/**
+ * Utility for testing CLI instances. Can check argument parsing and validation, including
+ * command chain resolution.
+ */
+class TestHarness {
+    cli;
+    constructor(cli) {
+        if (cli instanceof cli_forge_1.InternalCLI) {
+            this.cli = cli;
+            mockHandler(cli);
+        }
+        else {
+            throw new Error('TestHarness can only be used with CLI instances created by `cli`.');
+        }
+    }
+    async parse(args) {
+        const argv = await this.cli.forge(args);
+        return {
+            args: argv,
+            commandChain: this.cli.commandChain,
+        };
+    }
+}
+exports.TestHarness = TestHarness;
+function mockHandler(cli) {
+    if (cli.configuration?.handler) {
+        cli.configuration.handler = () => { };
+    }
+    for (const command in cli.registeredCommands) {
+        mockHandler(cli.registeredCommands[command]);
+    }
+}
+//# sourceMappingURL=test-harness.js.map

package/src/lib/test-harness.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-harness.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/src/lib/test-harness.ts"],"names":[],"mappings":";;;AACA,2CAA+C;AA6B/C;;;GAGG;AACH,MAAa,WAAW;IACd,GAAG,CAAiB;IAE5B,YAAY,GAAW;QACrB,IAAI,GAAG,YAAY,uBAAW,EAAE,CAAC;YAC/B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;YACf,WAAW,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CACb,mEAAmE,CACpE,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,IAAc;QACxB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAExC,OAAO;YACL,IAAI,EAAE,IAAI;YACV,YAAY,EAAE,IAAI,CAAC,GAAG,CAAC,YAAY;SACpC,CAAC;IACJ,CAAC;CACF;AAtBD,kCAsBC;AAED,SAAS,WAAW,CAAC,GAAgB;IACnC,IAAI,GAAG,CAAC,aAAa,EAAE,OAAO,EAAE,CAAC;QAC/B,GAAG,CAAC,aAAa,CAAC,OAAO,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;IACvC,CAAC;IACD,KAAK,MAAM,OAAO,IAAI,GAAG,CAAC,kBAAkB,EAAE,CAAC;QAC7C,WAAW,CAAC,GAAG,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC;IAC/C,CAAC;AACH,CAAC"}

package/src/lib/utils.d.ts

@@ -0,0 +1,10 @@
+export declare function getCallingFile(): string | undefined;
+export declare function getParentPackageJson(searchPath: string): {
+    name: string;
+    version: string;
+    bin?: {
+        [cmd: string]: string;
+    };
+    dependencies?: Record<string, string>;
+};
+export declare function stringToArgs(str: string): string[];

package/src/lib/utils.js

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCallingFile = getCallingFile;
+exports.getParentPackageJson = getParentPackageJson;
+exports.stringToArgs = stringToArgs;
+const fs_1 = require("fs");
+const path_1 = require("path");
+function getCallingFile() {
+    // Since this function lives in a utility file, the parent file
+    // would just be the file that invokes getCallingFile... We actually
+    // want the parent of the file that calls this, which is this file's
+    // grandparent.
+    let grandparentFile;
+    // Overrides prepare stack trace to be an identity fn, to get the callsites
+    // associated with the current error.
+    const _pst = Error.prepareStackTrace;
+    Error.prepareStackTrace = function (err, stack) {
+        return stack;
+    };
+    try {
+        const err = new Error();
+        const callsites = err.stack;
+        let currentfile = callsites.shift().getFileName();
+        let parentfile;
+        while (callsites.length) {
+            const callerfile = callsites.shift().getFileName();
+            // We've reached the parent file
+            if (currentfile !== callerfile) {
+                // We've reached the grandparent file
+                if (parentfile && parentfile !== callerfile) {
+                    grandparentFile = parentfile;
+                    break;
+                }
+                parentfile = callerfile;
+            }
+        }
+    }
+    finally {
+        Error.prepareStackTrace = _pst;
+    }
+    return grandparentFile;
+}
+function getParentPackageJson(searchPath) {
+    let currentPath = searchPath;
+    let packageJsonPath;
+    while (true) {
+        const packagePath = (0, path_1.join)(currentPath, 'package.json');
+        if ((0, fs_1.existsSync)(packagePath)) {
+            packageJsonPath = packagePath;
+            break;
+        }
+        const nextPath = (0, path_1.resolve)(currentPath, '..');
+        if (nextPath === currentPath) {
+            break;
+        }
+        currentPath = nextPath;
+    }
+    if (!packageJsonPath) {
+        throw new Error('Could not find package.json');
+    }
+    return require(packageJsonPath);
+}
+function stringToArgs(str) {
+    const quotePairs = new Map([
+        ['"', '"'],
+        ["'", "'"],
+        ['`', '`'],
+    ]);
+    const escapeChars = new Set(['\\']);
+    let activeQuote;
+    const args = [];
+    let currentArg = '';
+    let prev;
+    for (let i = 0; i < str.length; i++) {
+        const char = str[i];
+        if (activeQuote) {
+            while (true) {
+                if (i >= str.length) {
+                    break;
+                }
+                else if (str[i] === quotePairs.get(activeQuote) &&
+                    !(prev && escapeChars.has(prev))) {
+                    break;
+                }
+                if (!escapeChars.has(str[i])) {
+                    currentArg += str[i];
+                }
+                prev = str[i];
+                i++;
+            }
+            activeQuote = undefined;
+        }
+        else if (quotePairs.has(char) && !(prev && escapeChars.has(prev))) {
+            activeQuote = char;
+        }
+        else if (char === ' ' &&
+            prev !== ' ' &&
+            !(prev && escapeChars.has(prev))) {
+            args.push(currentArg);
+            currentArg = '';
+        }
+        else if (!escapeChars.has(char) || (prev && escapeChars.has(prev))) {
+            currentArg += char;
+        }
+        prev = char;
+    }
+    args.push(currentArg);
+    return args;
+}
+//# sourceMappingURL=utils.js.map

package/src/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../../packages/cli-forge/src/lib/utils.ts"],"names":[],"mappings":";;AAGA,wCAuCC;AAED,oDAiCC;AAED,oCAiDC;AAhID,2BAAgC;AAChC,+BAAqC;AAErC,SAAgB,cAAc;IAC5B,+DAA+D;IAC/D,oEAAoE;IACpE,oEAAoE;IACpE,eAAe;IACf,IAAI,eAAmC,CAAC;IAExC,2EAA2E;IAC3E,qCAAqC;IACrC,MAAM,IAAI,GAAG,KAAK,CAAC,iBAAiB,CAAC;IACrC,KAAK,CAAC,iBAAiB,GAAG,UAAU,GAAG,EAAE,KAAK;QAC5C,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEF,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC;QACxB,MAAM,SAAS,GAAG,GAAG,CAAC,KAAiC,CAAC;QAExD,IAAI,WAAW,GAAG,SAAS,CAAC,KAAK,EAAG,CAAC,WAAW,EAAE,CAAC;QACnD,IAAI,UAA8B,CAAC;QAEnC,OAAO,SAAS,CAAC,MAAM,EAAE,CAAC;YACxB,MAAM,UAAU,GAAG,SAAS,CAAC,KAAK,EAAG,CAAC,WAAW,EAAE,CAAC;YAEpD,gCAAgC;YAChC,IAAI,WAAW,KAAK,UAAU,EAAE,CAAC;gBAC/B,qCAAqC;gBACrC,IAAI,UAAU,IAAI,UAAU,KAAK,UAAU,EAAE,CAAC;oBAC5C,eAAe,GAAG,UAAU,CAAC;oBAC7B,MAAM;gBACR,CAAC;gBACD,UAAU,GAAG,UAAU,CAAC;YAC1B,CAAC;QACH,CAAC;IACH,CAAC;YAAS,CAAC;QACT,KAAK,CAAC,iBAAiB,GAAG,IAAI,CAAC;IACjC,CAAC;IAED,OAAO,eAAe,CAAC;AACzB,CAAC;AAED,SAAgB,oBAAoB,CAAC,UAAkB;IACrD,IAAI,WAAW,GAAG,UAAU,CAAC;IAC7B,IAAI,eAAmC,CAAC;IAExC,OAAO,IAAI,EAAE,CAAC;QACZ,MAAM,WAAW,GAAG,IAAA,WAAI,EAAC,WAAW,EAAE,cAAc,CAAC,CAAC;QAEtD,IAAI,IAAA,eAAU,EAAC,WAAW,CAAC,EAAE,CAAC;YAC5B,eAAe,GAAG,WAAW,CAAC;YAC9B,MAAM;QACR,CAAC;QAED,MAAM,QAAQ,GAAG,IAAA,cAAO,EAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAE5C,IAAI,QAAQ,KAAK,WAAW,EAAE,CAAC;YAC7B,MAAM;QACR,CAAC;QAED,WAAW,GAAG,QAAQ,CAAC;IACzB,CAAC;IAED,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACjD,CAAC;IAED,OAAO,OAAO,CAAC,eAAe,CAO7B,CAAC;AACJ,CAAC;AAED,SAAgB,YAAY,CAAC,GAAW;IACtC,MAAM,UAAU,GAAG,IAAI,GAAG,CAAiB;QACzC,CAAC,GAAG,EAAE,GAAG,CAAC;QACV,CAAC,GAAG,EAAE,GAAG,CAAC;QACV,CAAC,GAAG,EAAE,GAAG,CAAC;KACX,CAAC,CAAC;IACH,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAEpC,IAAI,WAA+B,CAAC;IAEpC,MAAM,IAAI,GAAG,EAAE,CAAC;IAChB,IAAI,UAAU,GAAG,EAAE,CAAC;IAEpB,IAAI,IAAwB,CAAC;IAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACpC,MAAM,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QACpB,IAAI,WAAW,EAAE,CAAC;YAChB,OAAO,IAAI,EAAE,CAAC;gBACZ,IAAI,CAAC,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;oBACpB,MAAM;gBACR,CAAC;qBAAM,IACL,GAAG,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,GAAG,CAAC,WAAW,CAAC;oBACtC,CAAC,CAAC,IAAI,IAAI,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAChC,CAAC;oBACD,MAAM;gBACR,CAAC;gBACD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC7B,UAAU,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;gBACvB,CAAC;gBACD,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;gBACd,CAAC,EAAE,CAAC;YACN,CAAC;YACD,WAAW,GAAG,SAAS,CAAC;QAC1B,CAAC;aAAM,IAAI,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YACpE,WAAW,GAAG,IAAI,CAAC;QACrB,CAAC;aAAM,IACL,IAAI,KAAK,GAAG;YACZ,IAAI,KAAK,GAAG;YACZ,CAAC,CAAC,IAAI,IAAI,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAChC,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACtB,UAAU,GAAG,EAAE,CAAC;QAClB,CAAC;aAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YACrE,UAAU,IAAI,IAAI,CAAC;QACrB,CAAC;QACD,IAAI,GAAG,IAAI,CAAC;IACd,CAAC;IACD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACtB,OAAO,IAAI,CAAC;AACd,CAAC"}