fail-on-console 1.1.1 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.2.0](https://github.com/benquarmby/fail-on-console/compare/v1.1.2...v1.2.0) (2026-07-25)
+
+
+### Features
+
+* do not require expect API in setupConsole ([04c0bad](https://github.com/benquarmby/fail-on-console/commit/04c0bad55f39773e6fb326f6364a5c64d46b3e0f))
+
+## [1.1.2](https://github.com/benquarmby/fail-on-console/compare/v1.1.1...v1.1.2) (2026-07-22)
+
+
+### Bug Fixes
+
+* guard against invalid and unsupported console methods ([504fa30](https://github.com/benquarmby/fail-on-console/commit/504fa301e245d0965afdfaf3c31d2d3b9a0cb10c))
+
 ## [1.1.1](https://github.com/benquarmby/fail-on-console/compare/v1.1.0...v1.1.1) (2026-07-08)
 
 

package/README.md

@@ -35,10 +35,10 @@ Initialize `setupConsole` inside a configured [`setupFiles`](https://vitest.dev/
 
 ```js
 // vitest.setup.js
-import {beforeEach, afterEach, expect} from "vitest";
+import {beforeEach, afterEach} from "vitest";
 import {setupConsole} from "fail-on-console";
 
-setupConsole({beforeEach, afterEach, expect});
+setupConsole({beforeEach, afterEach});
 ```
 
 ### With Jest
@@ -47,10 +47,10 @@ Initialize `setupConsole` inside a configured [`setupFilesAfterEnv`](https://jes
 
 ```js
 // jest.setup.js
-import {beforeEach, afterEach, expect} from "@jest/globals";
+import {beforeEach, afterEach} from "@jest/globals";
 import {setupConsole} from "fail-on-console";
 
-setupConsole({beforeEach, afterEach, expect});
+setupConsole({beforeEach, afterEach});
 ```
 
 ### Customizing Monitored Methods
@@ -61,7 +61,6 @@ By default, `debug` is not monitored but `error`, `warn`, `info`, and `log` are.
 setupConsole({
     beforeEach,
     afterEach,
-    expect,
     // Fail on console.error, console.warn, and console.debug.
     methods: ["error", "warn", "debug"]
 });
@@ -97,7 +96,6 @@ Initializes console spies that monitor active tests.
 
 - `options.beforeEach`: The framework's `beforeEach` hook.
 - `options.afterEach`: The framework's `afterEach` hook.
-- `options.expect`: The framework's `expect` object (must expose `getState()`).
 - `options.methods`: _(Optional)_ Array of `console` methods to track. Defaults to `["error", "warn", "info", "log"]`.
 
 ### `allowConsole(method, rules)`
@@ -112,8 +110,18 @@ Registers a temporary or global allowlist rule for a monitored console method.
 
 ## Limitations
 
+### Concurrency
+
 `fail-on-console` is not compatible with concurrent asynchronous tests (e.g., `test.concurrent`). Because concurrent tests execute simultaneously within the same environment context, console logs cannot be isolated reliably per individual test. For suites requiring specific log suppression, tests must be run sequentially.
 
+### Assert
+
+Monitoring `console.assert` is currently unsupported. It has a distinct signature and unique assertion mechanics compared to standard logging methods.
+
+### Mocha
+
+Mocha is unsupported due to API incompatibilities related to test context. There are no clean or reliable workarounds for integration.
+
 ## Credits & Prior Art
 
 This package is inspired by and builds on the excellent foundation laid by:

package/index.d.ts

@@ -15,7 +15,10 @@ export interface LifecycleHookLike {
 export interface TestApi {
     beforeEach: LifecycleHookLike;
     afterEach: LifecycleHookLike;
-    expect: ExpectLike;
+    /**
+     * @deprecated No longer needed. This option can be omitted.
+     */
+    expect?: ExpectLike;
 }
 
 export interface SetupOptions extends TestApi {
@@ -37,25 +40,24 @@ export function setup(options: SetupOptions): void;
 /**
  * Installs console spies that fail the current test if any monitored console
  * method is called. Call once at the top of the test setup file, passing the
- * lifecycle hooks and expect function from the test framework. Compatible with
- * any Jest-compatible API (Jest, Vitest, etc.).
+ * lifecycle hooks from the test framework. Compatible with any Jest-like API
+ * (Vitest, Jest, etc.).
  * @param {Object} options
  * @param {Function} options.beforeEach The beforeEach hook from the test framework.
  * @param {Function} options.afterEach The afterEach hook from the test framework.
- * @param {Object} options.expect The expect object from the test framework. Must expose getState().
  * @param {string[]} [options.methods=["error","warn","info","log"]] Console methods to monitor.
  * @example
- * // Jest
- * import {beforeEach, afterEach, expect} from "@jest/globals";
+ * // Vitest
+ * import {beforeEach, afterEach} from "vitest";
  * import {setup} from "fail-on-console";
  *
- * setup({beforeEach, afterEach, expect});
+ * setup({beforeEach, afterEach});
  * @example
- * // Vitest
- * import {beforeEach, afterEach, expect} from "vitest";
+ * // Jest
+ * import {beforeEach, afterEach} from "@jest/globals";
  * import {setup} from "fail-on-console";
  *
- * setup({beforeEach, afterEach, expect});
+ * setup({beforeEach, afterEach});
  */
 export function setupConsole(options: SetupOptions): void;
 

package/index.js

@@ -1,9 +1,40 @@
-let testApi;
-const defaultMethods = ["error", "warn", "info", "log"];
-const allowed = new Map();
+const supportedMethods = ["error", "warn", "info", "log", "debug"];
+// Everything but console.debug is monitored by default. Debug logging in tests
+// is usually intentional.
+const defaultMethods = supportedMethods.slice(0, -1);
 // %s string, %d/%i integer, %o object, %f float
 const printfPattern = /%[sdiof]/g;
 
+// Module scoped variables to manage test state. Not safe for concurrent tests.
+// Test frameworks run tests serially by default.
+let testApi;
+let isInsideTest = false;
+const allowed = new Map();
+
+function quoteString(value) {
+    return `"${value}"`;
+}
+
+function assertSupportedMethods(methods) {
+    if (!Array.isArray(methods)) {
+        throw new Error("fail-on-console: Expected an array of console methods.");
+    }
+
+    const unsupported = methods.filter((method) => !supportedMethods.includes(method));
+
+    if (!unsupported.length) {
+        return;
+    }
+
+    const method = unsupported.length === 1 ? "method" : "methods";
+    const invalidList = unsupported.map(quoteString).join(", ");
+    const validList = supportedMethods.map(quoteString).join(", ");
+
+    throw new Error(
+        `fail-on-console: Unsupported console ${method} provided: ${invalidList}. Supported methods are: ${validList}.`
+    );
+}
+
 /**
  * Basic implementation of node:util/format for console message formatting.
  * Covers only the most common uses. Does not handle all specifiers (such as
@@ -46,14 +77,23 @@ function isAllowed(message, rule) {
     return rule.test(message);
 }
 
-function setupConsole({beforeEach, afterEach, expect, methods = defaultMethods}) {
+function setupConsole({beforeEach, afterEach, methods = defaultMethods}) {
     if (testApi) {
         throw new Error("fail-on-console: Call setupConsole() only once.");
     }
 
-    testApi = {beforeEach, afterEach, expect};
+    assertSupportedMethods(methods);
 
-    beforeEach(() => allowed.clear());
+    testApi = {beforeEach, afterEach};
+
+    beforeEach(function () {
+        isInsideTest = true;
+        allowed.clear();
+    });
+
+    afterEach(function () {
+        isInsideTest = false;
+    });
 
     methods.forEach(function (method) {
         const original = console[method];
@@ -98,8 +138,9 @@ function allowConsole(method, rules) {
         throw new Error("fail-on-console: Call setupConsole() before using allowConsole().");
     }
 
+    assertSupportedMethods([method]);
+
     const normalized = Array.isArray(rules) ? rules : [rules];
-    const isInsideTest = !!testApi.expect.getState().currentTestName;
 
     function addRules() {
         const existing = allowed.get(method) ?? [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fail-on-console",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Fail Vitest or Jest tests when unexpected console logs, warnings or errors occur.",
   "keywords": [
     "jest",
@@ -20,19 +20,20 @@
   ],
   "devDependencies": {
     "@commitlint/config-conventional": "^21.2.0",
-    "@vitest/coverage-v8": "4.1.9",
-    "commitlint": "^21.2.0",
+    "@vitest/coverage-v8": "4.1.10",
+    "commitlint": "^21.2.1",
     "jest": "^30.4.2",
-    "prettier": "^3.8.4",
+    "npm-run-all2": "^9.0.2",
+    "prettier": "^3.9.6",
     "prettier-plugin-packagejson": "^3.0.2",
-    "vitest": "^4.1.9"
+    "vitest": "^4.1.10"
   },
   "scripts": {
     "commit:check": "commitlint --from-last-tag",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
-    "test": "vitest run",
-    "test:compat": "jest",
-    "test:cover": "vitest run --coverage"
+    "test:jest": "jest",
+    "test:vitest": "vitest run --coverage",
+    "verify": "run-s format:check test:vitest test:jest"
   }
 }