fail-on-console 1.0.1 → 1.1.1

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [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)
+
+
+### Features
+
+* add setupConsole export ([073ba69](https://github.com/benquarmby/fail-on-console/commit/073ba69ce1b7e07d09880ef110aea55f34b7f995))
+
+
+### Bug Fixes
+
+* deprecate setup export ([21f732a](https://github.com/benquarmby/fail-on-console/commit/21f732a1b48420818d055f0dace57eab3e4eb69e))
+
 ## [1.0.1](https://github.com/benquarmby/fail-on-console/compare/v1.0.0...v1.0.1) (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,24 +29,28 @@ yarn add --dev fail-on-console
 
 ## Setup
 
-`setup` 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 {setup} from "fail-on-console";
+import {setupConsole} from "fail-on-console";
 
-setup({beforeEach, afterEach, expect});
+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 {setup} from "fail-on-console";
+import {setupConsole} from "fail-on-console";
 
-setup({beforeEach, afterEach, expect});
+setupConsole({beforeEach, afterEach, expect});
 ```
 
 ### Customizing Monitored Methods
@@ -52,11 +58,11 @@ setup({beforeEach, afterEach, expect});
 By default, `debug` is not monitored but `error`, `warn`, `info`, and `log` are. This can be customized by passing a `methods` array:
 
 ```ts
-setup({
+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"]
 });
 ```
@@ -85,7 +91,7 @@ allowConsole("error", ["known warning", /deprecated/, (msg) => msg.includes("thi
 
 ## API Reference
 
-### `setup(options)`
+### `setupConsole(options)`
 
 Initializes console spies that monitor active tests.
 

package/index.d.ts

@@ -28,6 +28,12 @@ export interface AllowPredicate {
 
 export type AllowRule = string | RegExp | AllowPredicate;
 
+/**
+ * @deprecated Use setupConsole() instead. This function will be removed in a
+ * future major version.
+ */
+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
@@ -37,7 +43,7 @@ export type AllowRule = string | RegExp | AllowPredicate;
  * @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.
+ * @param {string[]} [options.methods=["error","warn","info","log"]] Console methods to monitor.
  * @example
  * // Jest
  * import {beforeEach, afterEach, expect} from "@jest/globals";
@@ -51,7 +57,7 @@ export type AllowRule = string | RegExp | AllowPredicate;
  *
  * setup({beforeEach, afterEach, expect});
  */
-export function setup(options: SetupOptions): void;
+export function setupConsole(options: SetupOptions): void;
 
 /**
  * Allows specific console calls to pass. Console exceptions can be configured

package/index.js

@@ -46,9 +46,9 @@ function isAllowed(message, rule) {
     return rule.test(message);
 }
 
-function setup({beforeEach, afterEach, expect, methods = defaultMethods}) {
+function setupConsole({beforeEach, afterEach, expect, methods = defaultMethods}) {
     if (testApi) {
-        throw new Error("fail-on-console: Call setup() only once.");
+        throw new Error("fail-on-console: Call setupConsole() only once.");
     }
 
     testApi = {beforeEach, afterEach, expect};
@@ -95,7 +95,7 @@ function setup({beforeEach, afterEach, expect, methods = defaultMethods}) {
 
 function allowConsole(method, rules) {
     if (!testApi) {
-        throw new Error("fail-on-console: Call setup() before using allowConsole().");
+        throw new Error("fail-on-console: Call setupConsole() before using allowConsole().");
     }
 
     const normalized = Array.isArray(rules) ? rules : [rules];
@@ -113,5 +113,6 @@ function allowConsole(method, rules) {
     }
 }
 
-exports.setup = setup;
+exports.setup = setupConsole;
+exports.setupConsole = setupConsole;
 exports.allowConsole = allowConsole;

package/package.json

@@ -1,7 +1,13 @@
 {
   "name": "fail-on-console",
-  "version": "1.0.1",
-  "description": "Prevent console noise from obscuring test results.",
+  "version": "1.1.1",
+  "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"