fail-on-console 1.1.0 → 1.1.2

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [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)
+
+
+### Bug Fixes
+
+* add missing keywords and refine description ([3d8688a](https://github.com/benquarmby/fail-on-console/commit/3d8688aa33ce9a717adb7e01b0f8431cbd86ea0e))
+
 ## [1.1.0](https://github.com/benquarmby/fail-on-console/compare/v1.0.1...v1.1.0) (2026-07-06)
 
 

package/README.md

@@ -1,16 +1,18 @@
 # Fail on Console
 
-Prevent console noise from obscuring test results.
+Fail Vitest or Jest tests when unexpected console logs, warnings or errors occur.
 
-This utility fails tests whenever unexpected `console` logs, warnings, or errors are triggered. It is compatible with Vitest and Jest.
+[![npm version](https://img.shields.io/npm/v/fail-on-console.svg)](https://www.npmjs.com/package/fail-on-console)
+[![license](https://img.shields.io/npm/l/fail-on-console.svg)](https://github.com/benquarmby/fail-on-console/blob/main/LICENSE)
+
+The `fail-on-console` utility fails test suites whenever unexpected `console` logs, warnings, or errors are triggered, keeping test results clear and easy to read.
 
 ## Features
 
-- **Framework Agnostic**: Integrates with Vitest, Jest, or any framework exposing standard lifecycle hooks and `expect.getState()`.
-- **Zero Dependencies**: Pure, lightweight JavaScript with a minimal footprint.
-- **Browser Ready**: Contains no Node.js API dependencies, allowing it to run inside Vitest Browser Mode.
-- **Configurable Targets**: Allows explicit selection of which console methods to monitor.
-- **Flexible Allowlist**: Suppresses known or expected console outputs globally, per suite, or per individual test. Exceptions can be matched against strings, regular expressions, or custom predicate functions.
+- **⚡ Vitest and Jest Native**: Seamless integration with Vitest (including Browser Mode) and Jest using standard lifecycle hooks.
+- **🪶 Zero Dependencies**: Pure, lightweight JavaScript with a tiny footprint.
+- **🎯 Configurable Targets**: Choose exactly which console methods to monitor (`log`, `warn`, `error`, `info`, `debug`).
+- **📋 Flexible Allowlist**: Easily suppress expected console noise globally, per suite, or per test using strings, regular expressions, or custom predicates.
 
 ## Installation
 
@@ -27,11 +29,12 @@ yarn add --dev fail-on-console
 
 ## Setup
 
-`setupConsole` should be called once in a global setup file, accepting the lifecycle hooks and `expect` utility from the testing framework.
-
 ### With Vitest
 
-```ts
+Initialize `setupConsole` inside a configured [`setupFiles`](https://vitest.dev/config/setupfiles) module (e.g., `vitest.setup.js`).
+
+```js
+// vitest.setup.js
 import {beforeEach, afterEach, expect} from "vitest";
 import {setupConsole} from "fail-on-console";
 
@@ -40,7 +43,10 @@ setupConsole({beforeEach, afterEach, expect});
 
 ### With Jest
 
-```ts
+Initialize `setupConsole` inside a configured [`setupFilesAfterEnv`](https://jestjs.io/docs/configuration#setupfilesafterenv-array) module (e.g., `jest.setup.js`).
+
+```js
+// jest.setup.js
 import {beforeEach, afterEach, expect} from "@jest/globals";
 import {setupConsole} from "fail-on-console";
 
@@ -56,7 +62,7 @@ setupConsole({
     beforeEach,
     afterEach,
     expect,
-    // Fail on console.error, console.warn and console.debug.
+    // Fail on console.error, console.warn, and console.debug.
     methods: ["error", "warn", "debug"]
 });
 ```
@@ -106,8 +112,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.js

@@ -1,9 +1,36 @@
 let testApi;
-const defaultMethods = ["error", "warn", "info", "log"];
+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);
 const allowed = new Map();
 // %s string, %d/%i integer, %o object, %f float
 const printfPattern = /%[sdiof]/g;
 
+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
@@ -51,6 +78,8 @@ function setupConsole({beforeEach, afterEach, expect, methods = defaultMethods})
         throw new Error("fail-on-console: Call setupConsole() only once.");
     }
 
+    assertSupportedMethods(methods);
+
     testApi = {beforeEach, afterEach, expect};
 
     beforeEach(() => allowed.clear());
@@ -98,6 +127,8 @@ 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;
 

package/package.json

@@ -1,7 +1,13 @@
 {
   "name": "fail-on-console",
-  "version": "1.1.0",
-  "description": "Prevent console noise from obscuring test results.",
+  "version": "1.1.2",
+  "description": "Fail Vitest or Jest tests when unexpected console logs, warnings or errors occur.",
+  "keywords": [
+    "jest",
+    "vitest",
+    "console",
+    "testing"
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/benquarmby/fail-on-console"