@oclif/test 4.0.1-beta.2 → 4.0.1-dev.0

package/lib/index.d.ts

@@ -9,7 +9,7 @@ export declare function captureOutput<T>(fn: () => Promise<unknown>, opts?: Capt
     stderr: string;
     stdout: string;
 }>;
-export declare function runCommand<T>(args: string | string[], loadOpts?: Interfaces.LoadOptions, captureOpts?: CaptureOptions): Promise<{
+export declare function runCommand<T>(args: string[], loadOpts?: Interfaces.LoadOptions, captureOpts?: CaptureOptions): Promise<{
     error?: Error & Partial<Errors.CLIError>;
     result?: T;
     stderr: string;

package/lib/index.js

@@ -8,7 +8,48 @@ const core_1 = require("@oclif/core");
 const ansis_1 = __importDefault(require("ansis"));
 const debug_1 = __importDefault(require("debug"));
 const node_path_1 = require("node:path");
-const debug = (0, debug_1.default)('oclif-test');
+const debug = (0, debug_1.default)('test');
+const RECORD_OPTIONS = {
+    print: false,
+    stripAnsi: true,
+};
+const originals = {
+    stderr: process.stderr.write,
+    stdout: process.stdout.write,
+};
+const output = {
+    stderr: [],
+    stdout: [],
+};
+function mockedStdout(str, encoding, cb) {
+    output.stdout.push(str);
+    if (!RECORD_OPTIONS.print)
+        return true;
+    if (typeof encoding === 'string') {
+        return originals.stdout.bind(process.stdout)(str, encoding, cb);
+    }
+    return originals.stdout.bind(process.stdout)(str, cb);
+}
+function mockedStderr(str, encoding, cb) {
+    output.stderr.push(str);
+    if (!RECORD_OPTIONS.print)
+        return true;
+    if (typeof encoding === 'string') {
+        return originals.stdout.bind(process.stderr)(str, encoding, cb);
+    }
+    return originals.stdout.bind(process.stderr)(str, cb);
+}
+const restore = () => {
+    process.stderr.write = originals.stderr;
+    process.stdout.write = originals.stdout;
+};
+const reset = () => {
+    output.stderr = [];
+    output.stdout = [];
+};
+const toString = (str) => RECORD_OPTIONS.stripAnsi ? ansis_1.default.strip(str.toString()) : str.toString();
+const getStderr = () => output.stderr.map((b) => toString(b)).join('');
+const getStdout = () => output.stdout.map((b) => toString(b)).join('');
 function traverseFilePathUntil(filename, predicate) {
     let current = filename;
     while (!predicate(current)) {
@@ -16,48 +57,18 @@ function traverseFilePathUntil(filename, predicate) {
     }
     return current;
 }
-function findRoot() {
-    return (process.env.OCLIF_TEST_ROOT ??
-        // eslint-disable-next-line unicorn/prefer-module
-        Object.values(require.cache).find((m) => m?.children.includes(module))?.filename ??
-        traverseFilePathUntil(
-        // eslint-disable-next-line unicorn/prefer-module
-        require.main?.path ?? module.path, (p) => !(p.includes('node_modules') || p.includes('.pnpm') || p.includes('.yarn'))));
-}
 function makeLoadOptions(loadOpts) {
-    return loadOpts ?? { root: findRoot() };
+    return (loadOpts ?? {
+        root: traverseFilePathUntil(
+        // eslint-disable-next-line unicorn/prefer-module
+        require.main?.path ?? module.path, (p) => !(p.includes('node_modules') || p.includes('.pnpm') || p.includes('.yarn'))),
+    });
 }
 async function captureOutput(fn, opts) {
-    const print = opts?.print ?? false;
-    const stripAnsi = opts?.stripAnsi ?? true;
-    const originals = {
-        NODE_ENV: process.env.NODE_ENV,
-        stderr: process.stderr.write,
-        stdout: process.stdout.write,
-    };
-    const output = {
-        stderr: [],
-        stdout: [],
-    };
-    const toString = (str) => (stripAnsi ? ansis_1.default.strip(str.toString()) : str.toString());
-    const getStderr = () => output.stderr.map((b) => toString(b)).join('');
-    const getStdout = () => output.stdout.map((b) => toString(b)).join('');
-    const mock = (std) => (str, encoding, cb) => {
-        output[std].push(str);
-        if (print) {
-            if (encoding !== null && typeof encoding === 'function') {
-                cb = encoding;
-                encoding = undefined;
-            }
-            originals[std].apply(process[std], [str, encoding, cb]);
-        }
-        else if (typeof cb === 'function')
-            cb();
-        return true;
-    };
-    process.stdout.write = mock('stdout');
-    process.stderr.write = mock('stderr');
-    process.env.NODE_ENV = 'test';
+    RECORD_OPTIONS.print = opts?.print ?? false;
+    RECORD_OPTIONS.stripAnsi = opts?.stripAnsi ?? true;
+    process.stderr.write = mockedStderr;
+    process.stdout.write = mockedStdout;
     try {
         const result = await fn();
         return {
@@ -68,32 +79,27 @@ async function captureOutput(fn, opts) {
     }
     catch (error) {
         return {
-            ...(error instanceof core_1.Errors.CLIError && { error: { ...error, message: toString(error.message) } }),
-            ...(error instanceof Error && { error: { ...error, message: toString(error.message) } }),
+            ...(error instanceof core_1.Errors.CLIError && { error }),
+            ...(error instanceof Error && { error }),
             stderr: getStderr(),
             stdout: getStdout(),
         };
     }
     finally {
-        process.stderr.write = originals.stderr;
-        process.stdout.write = originals.stdout;
-        process.env.NODE_ENV = originals.NODE_ENV;
+        restore();
+        reset();
     }
 }
 exports.captureOutput = captureOutput;
 async function runCommand(args, loadOpts, captureOpts) {
     const loadOptions = makeLoadOptions(loadOpts);
-    const argsArray = (Array.isArray(args) ? args : [args]).join(' ').split(' ');
-    const [id, ...rest] = argsArray;
-    const finalArgs = id === '.' ? rest : argsArray;
-    debug('loadOpts: %O', loadOptions);
-    debug('args: %O', finalArgs);
-    return captureOutput(async () => (0, core_1.run)(finalArgs, loadOptions), captureOpts);
+    debug('loadOpts: %O', loadOpts);
+    return captureOutput(async () => (0, core_1.run)(args, loadOptions), captureOpts);
 }
 exports.runCommand = runCommand;
 async function runHook(hook, options, loadOpts, recordOpts) {
     const loadOptions = makeLoadOptions(loadOpts);
-    debug('loadOpts: %O', loadOptions);
+    debug('loadOpts: %O', loadOpts);
     return captureOutput(async () => {
         const config = await core_1.Config.load(loadOptions);
         return config.runHook(hook, options);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/test",
   "description": "test helpers for oclif components",
-  "version": "4.0.1-beta.2",
+  "version": "4.0.1-dev.0",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/test/issues",
   "dependencies": {
@@ -9,17 +9,15 @@
     "debug": "^4.3.4"
   },
   "peerDependencies": {
-    "@oclif/core": "^4.0.0-beta.7"
+    "@oclif/core": "^4.0.0-beta.6"
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^18.6.3",
     "@oclif/core": "^4.0.0-beta.6",
     "@oclif/prettier-config": "^0.2.1",
-    "@types/chai": "^4.3.16",
     "@types/debug": "^4.1.12",
     "@types/mocha": "^10",
     "@types/node": "^18",
-    "chai": "^5.1.1",
     "commitlint": "^18.6.1",
     "eslint": "^8.57.0",
     "eslint-config-oclif": "^5.2.0",
@@ -30,7 +28,7 @@
     "mocha": "^10",
     "prettier": "^3.2.5",
     "shx": "^0.3.3",
-    "tsx": "^4.10.2",
+    "ts-node": "^10.9.2",
     "typescript": "^5.4.5"
   },
   "engines": {