@oclif/test 4.0.9 → 4.1.0

package/README.md

@@ -14,6 +14,8 @@ See the [V4 Migration Guide](./MIGRATION.md) if you are migrating from v3 or old
 
 `@oclif/test` provides a handful of utilities that make it easy to test your [oclif](https://oclif.io) CLI.
 
+**NOTE for jest users** - in order for these utilities to capture all output to the terminal, you must set `verbose: true` in your jest config to prevent jest from supressing any output. See https://jestjs.io/docs/configuration#verbose-boolean for more
+
 ### `captureOutput`
 
 `captureOutput` allows you to get the stdout, stderr, return value, and error of the callback you provide it. This makes it possible to assert that certain strings were printed to stdout and stderr or that the callback failed with the expected error or succeeded with the expected result.
@@ -22,6 +24,7 @@ See the [V4 Migration Guide](./MIGRATION.md) if you are migrating from v3 or old
 
 - `print` - Print everything that goes to stdout and stderr.
 - `stripAnsi` - Strip ansi codes from everything that goes to stdout and stderr. Defaults to true.
+- `testNodeEnv` - Sets the `NODE_ENV` value when capturing output. Defaults to `'test'`.
 
 See the [tests](./test/capture-output.test.ts) for example usage.
 

package/lib/index.d.ts

@@ -2,6 +2,7 @@ import { Errors, Interfaces } from '@oclif/core';
 type CaptureOptions = {
     print?: boolean;
     stripAnsi?: boolean;
+    testNodeEnv?: string;
 };
 type CaptureResult<T> = {
     error?: Error & Partial<Errors.CLIError>;

package/lib/index.js

@@ -21,7 +21,7 @@ function traverseFilePathUntil(filename, predicate) {
 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 ??
+        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'))));
@@ -59,6 +59,7 @@ function splitString(str) {
 async function captureOutput(fn, opts) {
     const print = opts?.print ?? false;
     const stripAnsi = opts?.stripAnsi ?? true;
+    const testNodeEnv = opts?.testNodeEnv || 'test';
     const originals = {
         NODE_ENV: process.env.NODE_ENV,
         stderr: process.stderr.write,
@@ -86,7 +87,7 @@ async function captureOutput(fn, opts) {
     };
     process.stdout.write = mock('stdout');
     process.stderr.write = mock('stderr');
-    process.env.NODE_ENV = 'test';
+    process.env.NODE_ENV = testNodeEnv;
     try {
         const result = await fn();
         return {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/test",
   "description": "test helpers for oclif components",
-  "version": "4.0.9",
+  "version": "4.1.0",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/test/issues",
   "dependencies": {
@@ -13,25 +13,25 @@
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^18.6.3",
-    "@oclif/core": "^4.0.17",
+    "@oclif/core": "^4.0.28",
     "@oclif/prettier-config": "^0.2.1",
-    "@types/chai": "^4.3.17",
+    "@types/chai": "^4.3.20",
     "@types/debug": "^4.1.12",
     "@types/mocha": "^10",
     "@types/node": "^18",
     "chai": "^5.1.1",
     "commitlint": "^18.6.1",
-    "eslint": "^8.57.0",
+    "eslint": "^8.57.1",
     "eslint-config-oclif": "^5.2.1",
-    "eslint-config-oclif-typescript": "^3.1.9",
+    "eslint-config-oclif-typescript": "^3.1.12",
     "eslint-config-prettier": "^9.1.0",
-    "husky": "^9.1.4",
-    "lint-staged": "^15.2.9",
+    "husky": "^9.1.6",
+    "lint-staged": "^15.2.10",
     "mocha": "^10",
     "prettier": "^3.3.3",
     "shx": "^0.3.3",
-    "tsx": "^4.18.0",
-    "typescript": "^5.5.4"
+    "tsx": "^4.19.1",
+    "typescript": "^5.6.3"
   },
   "engines": {
     "node": ">=18.0.0"