fail-on-console 1.3.0 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.4.0](https://github.com/benquarmby/fail-on-console/compare/v1.3.1...v1.4.0) (2026-08-08)
+
+
+### Features
+
+* support custom format functions ([25908c3](https://github.com/benquarmby/fail-on-console/commit/25908c3e9219eb607a944d269188db0113376ddd))
+
+## [1.3.1](https://github.com/benquarmby/fail-on-console/compare/v1.3.0...v1.3.1) (2026-08-01)
+
+
+### Bug Fixes
+
+* use correct rule type for allowStream declaration ([23fe420](https://github.com/benquarmby/fail-on-console/commit/23fe42050a7a46959ea6f2b68204a41e424bcacc))
+
 ## [1.3.0](https://github.com/benquarmby/fail-on-console/compare/v1.2.0...v1.3.0) (2026-08-01)
 
 

package/README.md

@@ -58,7 +58,7 @@ setupConsole({beforeEach, afterEach});
 
 By default, `console.debug` is not monitored but `error`, `warn`, `info`, and `log` are. This can be customized by passing a `methods` array. Similarly, `process.stdout` and `process.stderr` are not monitored by default, but can be configured with a `streams` array:
 
-```ts
+```js
 setupConsole({
     beforeEach,
     afterEach,
@@ -70,13 +70,27 @@ setupConsole({
 });
 ```
 
+### Using a Custom Formatter
+
+By default, a lightweight and browser compatible equivalent of the Node.js [`util.format()`](https://nodejs.org/api/util.html#utilformatformat-args) function is used for `printf`-like formatting of console messages. It covers the most common use cases but has limitations. If a more accurate and complete implementation is required, pass it as the `format` option:
+
+```js
+import util from "node:util";
+
+setupConsole({
+    beforeEach,
+    afterEach,
+    format: util.format
+});
+```
+
 ## Suppressing Expected Logs
 
 If a specific test or third-party dependency intentionally logs to the console, `allowConsole` and `allowStream` can be used to allow the test to pass.
 
 These functions can be invoked globally, inside a `describe` block, or inside a specific `test`/`it` block.
 
-```javascript
+```js
 import {allowConsole, allowStream} from "fail-on-console";
 
 // Allow a substring.

package/index.d.ts

@@ -13,6 +13,10 @@ export interface LifecycleHookLike {
     (fn: () => void): void;
 }
 
+export interface FormatLike {
+    (format?: any, ...args: any[]): string;
+}
+
 export interface TestApi {
     beforeEach: LifecycleHookLike;
     afterEach: LifecycleHookLike;
@@ -25,6 +29,7 @@ export interface TestApi {
 export interface SetupOptions extends TestApi {
     methods?: ConsoleMethod[];
     streams?: ProcessStream[];
+    format?: FormatLike;
 }
 
 export interface AllowPredicate {
@@ -47,6 +52,7 @@ export function setup(options: SetupOptions): void;
  * @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 {Function} [options.format] Optional function to format console messages. Uses a basic shim by default.
  * @param {string[]} [options.methods=["error","warn","info","log"]] Console methods to monitor.
  * @param {string[]} [options.streams=[]] Process streams to monitor. None by default.
  * @example
@@ -105,4 +111,4 @@ export function allowConsole(method: ConsoleMethod, rules: AllowRule | AllowRule
  * // Mixed array - allow standard errors using multiple rules at once
  * allowStream("stderr", ["known warning", /deprecated/, (m) => m.includes("third-party")]);
  */
-export function allowStream(stream: ProcessStream, rules: Rule | Rule[]): void;
+export function allowStream(stream: ProcessStream, rules: AllowRule | AllowRule[]): void;

package/index.js

@@ -53,7 +53,7 @@ function assertSupportedStreams(streams) {
  * @param {...*} args The list of arguments passed to the console method.
  * @returns {string} The formatted message string.
  */
-function format(...args) {
+function defaultFormat(...args) {
     const [format, ...values] = args;
 
     if (typeof format !== "string") {
@@ -104,7 +104,13 @@ function chunkToString(chunk, encoding = "utf8") {
     return Buffer.from(chunk).toString(encoding);
 }
 
-function setupConsole({beforeEach, afterEach, methods = defaultMethods, streams = defaultStreams}) {
+function setupConsole({
+    beforeEach,
+    afterEach,
+    format = defaultFormat,
+    methods = defaultMethods,
+    streams = defaultStreams
+}) {
     if (testApi) {
         throw new Error("fail-on-console: Call setupConsole() only once.");
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fail-on-console",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Fail Vitest or Jest tests when unexpected console logs, warnings or errors occur.",
   "keywords": [
     "jest",
@@ -26,6 +26,7 @@
     "npm-run-all2": "^9.0.3",
     "prettier": "^3.9.6",
     "prettier-plugin-packagejson": "^3.0.2",
+    "typescript": "^7.0.2",
     "vitest": "^4.1.10"
   },
   "scripts": {
@@ -34,6 +35,7 @@
     "format:check": "prettier --check .",
     "test:jest": "jest",
     "test:vitest": "vitest run --coverage",
-    "verify": "run-s commit:check format:check test:vitest test:jest"
+    "type:check": "tsc",
+    "verify": "run-s commit:check format:check type:check test:vitest test:jest"
   }
 }