Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ValentinH/jest-fail-on-console
Utility to make jest tests fail when console.error() or any other methods are used
https://github.com/ValentinH/jest-fail-on-console
jest
Last synced: 3 months ago
JSON representation
Utility to make jest tests fail when console.error() or any other methods are used
- Host: GitHub
- URL: https://github.com/ValentinH/jest-fail-on-console
- Owner: ValentinH
- License: mit
- Created: 2021-01-08T16:58:44.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-13T12:34:35.000Z (6 months ago)
- Last Synced: 2024-07-18T15:27:02.945Z (4 months ago)
- Topics: jest
- Language: JavaScript
- Homepage:
- Size: 230 KB
- Stars: 141
- Watchers: 7
- Forks: 20
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-jest - jest-fail-on-console
README
# jest-fail-on-console
Utility to make jest tests fail when `console.error()`, `console.warn()`, etc. are used
[![version][version-badge]][package] [![MIT License][license-badge]][license] [![PRs Welcome][prs-badge]][prs]
## What problem is this solving?
Jest doesn't fail the tests when there is a `console.error`. In large codebase, we can end up with the test output overloaded by a lot of errors, warnings, etc..
To prevent this, we want to fail each test that is logging to the console. We also want to conserve a clear output of the original error.
This is what this utility is doing.
## Downloads
[](https://npminsights.vercel.app/package/jest-fail-on-console)
## Install
```shell
yarn add -D jest-fail-on-console
```
or
```shell
npm install -D jest-fail-on-console
```
## How to use
In a file used in the `setupFilesAfterEnv` option of Jest, add this code:
```ts
import failOnConsole from 'jest-fail-on-console'
failOnConsole()
// or with options:
failOnConsole({
shouldFailOnWarn: false,
})
```
## But I have some expected console errors/warning
If a `console.error()` is expected, then you should assert for it:
```ts
test('should log an error', () => {
jest.spyOn(console, 'error').mockImplementation()
// do your logic
expect(console.error).toHaveBeenCalledWith('your error message')
})
```
## Options
You can pass an object with options to the function:
### errorMessage
Use this if you want to override the default error message of this library.
```ts
// signature
type errorMessage = (
methodName: 'assert' | 'debug' | 'error' | 'info' | 'log' | 'warn',
bold: (string: string) => string
) => string
```
### shouldFailOnAssert
Use this to make a test fail when a `console.assert()` is logged.
- Type: `boolean`
- Default: `false`
### shouldFailOnDebug
Use this to make a test fail when a `console.debug()` is logged.
- Type: `boolean`
- Default: `false`
### shouldFailOnError
Use this to make a test fail when a `console.error()` is logged.
- Type: `boolean`
- Default: `true`
### shouldFailOnInfo
Use this to make a test fail when a `console.info()` is logged.
- Type: `boolean`
- Default: `false`
### shouldFailOnLog
Use this to make a test fail when a `console.log()` is logged.
- Type: `boolean`
- Default: `false`
### shouldFailOnWarn
Use this to make a test fail when a `console.warn()` is logged.
- Type: `boolean`
- Default: `true`
### allowMessage
```ts
// signature
type allowMessage = (
message: string,
methodName: 'assert' | 'debug' | 'error' | 'info' | 'log' | 'warn',
context: { group: string; groups: string[] }
) => boolean
```
This function is called for every console method supported by this utility.
If `true` is returned, the message will show in the console and the test won't fail.
Example:
```ts
failOnConsole({
allowMessage: (errorMessage) => {
if (/An expected error/.test(errorMessage)) {
return true
}
return false
},
})
```
### silenceMessage
```ts
// signature
type silenceMessage = (
message: string,
methodName: 'assert' | 'debug' | 'error' | 'info' | 'log' | 'warn',
context: { group: string; groups: string[] }
) => boolean
```
This function is called for every console method supported by this utility.
If `true` is returned, the message will not show in the console and the test won't fail.
Example:
```ts
failOnConsole({
silenceMessage: (errorMessage) => {
if (/Not implemented: navigation/.test(errorMessage)) {
return true
}
return false
},
})
```
### skipTest
Use this if you want to ignore checks introduced by this library for specific tests determined by
the return of the callback function. Return `false` if you do not want to skip console checks for
the specific test and return `true` if you would like to skip it.
```ts
const ignoreList = [/.*components\/SomeComponent.test.tsx/]
const ignoreNameList = ['some component some test name']
failOnConsole({
skipTest: ({ testPath, testName }) => {
for (const pathExp of ignoreList) {
const result = pathExp.test(testPath)
if (result) return true
}
if (ignoreNameList.includes(testName)) {
return true
}
return false
},
})
```
### shouldPrintMessage
Use this to print the message immediately when called not awaiting the test to finish. This is useful to show the message if there are
other or earlier test failures which will result in the fail on console error to be hidden by jest.
- Type: `boolean`
- Default: `false`
## License
[MIT](https://github.com/ValentinH/jest-fail-on-console/blob/master/LICENSE)
## Maintainers
This project is maintained by Valentin Hervieu.
This project was originally part of [@ricardo-ch](https://github.com/ricardo-ch/) organisation because I (Valentin) was working at Ricardo.
After leaving this company, they gracefully accepted to transfer the project to me. ❤️
## Credits
Most of the logic is taken from [React's setupTests file](https://github.com/facebook/react/blob/master/scripts/jest/setupTests.js).
[version-badge]: https://img.shields.io/npm/v/jest-fail-on-console.svg?style=flat-square
[package]: https://www.npmjs.com/package/jest-fail-on-console
[downloads-badge]: https://img.shields.io/npm/dm/jest-fail-on-console.svg?style=flat-square
[npmstats]: http://npm-stat.com/charts.html?package=jest-fail-on-console
[npmstats-badge]: https://img.shields.io/npm/dm/jest-fail-on-console.svg?style=flat-square
[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
[license]: https://github.com/ValentinH/jest-fail-on-console/blob/master/LICENSE
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs]: http://makeapullrequest.com