fail-on-console 1.1.0 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +18 -12
  3. package/package.json +8 -2
package/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # Changelog
2
2
 
3
+ ## [1.1.1](https://github.com/benquarmby/fail-on-console/compare/v1.1.0...v1.1.1) (2026-07-08)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * add missing keywords and refine description ([3d8688a](https://github.com/benquarmby/fail-on-console/commit/3d8688aa33ce9a717adb7e01b0f8431cbd86ea0e))
9
+
3
10
  ## [1.1.0](https://github.com/benquarmby/fail-on-console/compare/v1.0.1...v1.1.0) (2026-07-06)
4
11
 
5
12
 
package/README.md CHANGED
@@ -1,16 +1,18 @@
1
1
  # Fail on Console
2
2
 
3
- Prevent console noise from obscuring test results.
3
+ Fail Vitest or Jest tests when unexpected console logs, warnings or errors occur.
4
4
 
5
- This utility fails tests whenever unexpected `console` logs, warnings, or errors are triggered. It is compatible with Vitest and Jest.
5
+ [![npm version](https://img.shields.io/npm/v/fail-on-console.svg)](https://www.npmjs.com/package/fail-on-console)
6
+ [![license](https://img.shields.io/npm/l/fail-on-console.svg)](https://github.com/benquarmby/fail-on-console/blob/main/LICENSE)
7
+
8
+ 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.
6
9
 
7
10
  ## Features
8
11
 
9
- - **Framework Agnostic**: Integrates with Vitest, Jest, or any framework exposing standard lifecycle hooks and `expect.getState()`.
10
- - **Zero Dependencies**: Pure, lightweight JavaScript with a minimal footprint.
11
- - **Browser Ready**: Contains no Node.js API dependencies, allowing it to run inside Vitest Browser Mode.
12
- - **Configurable Targets**: Allows explicit selection of which console methods to monitor.
13
- - **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.
12
+ - **⚡ Vitest and Jest Native**: Seamless integration with Vitest (including Browser Mode) and Jest using standard lifecycle hooks.
13
+ - **đŸĒļ Zero Dependencies**: Pure, lightweight JavaScript with a tiny footprint.
14
+ - **đŸŽ¯ Configurable Targets**: Choose exactly which console methods to monitor (`log`, `warn`, `error`, `info`, `debug`).
15
+ - **📋 Flexible Allowlist**: Easily suppress expected console noise globally, per suite, or per test using strings, regular expressions, or custom predicates.
14
16
 
15
17
  ## Installation
16
18
 
@@ -27,11 +29,12 @@ yarn add --dev fail-on-console
27
29
 
28
30
  ## Setup
29
31
 
30
- `setupConsole` should be called once in a global setup file, accepting the lifecycle hooks and `expect` utility from the testing framework.
31
-
32
32
  ### With Vitest
33
33
 
34
- ```ts
34
+ Initialize `setupConsole` inside a configured [`setupFiles`](https://vitest.dev/config/setupfiles) module (e.g., `vitest.setup.js`).
35
+
36
+ ```js
37
+ // vitest.setup.js
35
38
  import {beforeEach, afterEach, expect} from "vitest";
36
39
  import {setupConsole} from "fail-on-console";
37
40
 
@@ -40,7 +43,10 @@ setupConsole({beforeEach, afterEach, expect});
40
43
 
41
44
  ### With Jest
42
45
 
43
- ```ts
46
+ Initialize `setupConsole` inside a configured [`setupFilesAfterEnv`](https://jestjs.io/docs/configuration#setupfilesafterenv-array) module (e.g., `jest.setup.js`).
47
+
48
+ ```js
49
+ // jest.setup.js
44
50
  import {beforeEach, afterEach, expect} from "@jest/globals";
45
51
  import {setupConsole} from "fail-on-console";
46
52
 
@@ -56,7 +62,7 @@ setupConsole({
56
62
  beforeEach,
57
63
  afterEach,
58
64
  expect,
59
- // Fail on console.error, console.warn and console.debug.
65
+ // Fail on console.error, console.warn, and console.debug.
60
66
  methods: ["error", "warn", "debug"]
61
67
  });
62
68
  ```
package/package.json CHANGED
@@ -1,7 +1,13 @@
1
1
  {
2
2
  "name": "fail-on-console",
3
- "version": "1.1.0",
4
- "description": "Prevent console noise from obscuring test results.",
3
+ "version": "1.1.1",
4
+ "description": "Fail Vitest or Jest tests when unexpected console logs, warnings or errors occur.",
5
+ "keywords": [
6
+ "jest",
7
+ "vitest",
8
+ "console",
9
+ "testing"
10
+ ],
5
11
  "repository": {
6
12
  "type": "git",
7
13
  "url": "https://github.com/benquarmby/fail-on-console"