https://github.com/bpedersen/jest-mock-console
Jest utility to mock the console
https://github.com/bpedersen/jest-mock-console
hacktoberfest jest mock
Last synced: about 1 month ago
JSON representation
Jest utility to mock the console
- Host: GitHub
- URL: https://github.com/bpedersen/jest-mock-console
- Owner: bpedersen
- License: mit
- Created: 2018-03-03T03:51:57.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-04-03T19:44:40.000Z (about 2 years ago)
- Last Synced: 2025-04-09T19:18:43.110Z (about 1 month ago)
- Topics: hacktoberfest, jest, mock
- Language: TypeScript
- Homepage:
- Size: 1.61 MB
- Stars: 40
- Watchers: 1
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# jest-mock-console
Jest utility to mock the console
[![codecov][codecov-badge]][codecov]
[![build][build-badge]][build]
[![Dependencies][dependencyci-badge]][dependencyci]
[![MIT License][license-badge]][license]
## Table of Contents
- [Problem](#the-problem)
- [Solution](#the-solution)
- [Installation](#installation)
- [Basic Example](#basic-example)
- [Advanced Example](#advanced-example)
- [Analyze all logs](#analyze-all-logs)
- [mockConsole(mocks)](#mockconsolemocks)
- [default](#mock-default)
- [string](#mock-string)
- [array](#mock-array)
- [object](#mock-object)
## The problem
If you use console or prop-types in your app, and you use jest then you end up with tests that look like:
This is not helpful as all of the tests have passed, but you are seeing red. It is especially unhelpful when there is an actual failure as you have to search through all the red to find the actual failed test.
## The solution
This allows you to mock and unmock the console at will, so your tests look like:
This is much more helpful as you don't see red on success anymore. Then you know when you see red text you know something went wrong.
## Installation
This module is distributed view [npm][npm] which is bundled with [node][node] and should be installed as one of your project's `devDependencies`:
```
npm install --save-dev jest-mock-console
```
## Basic Example
At the top of your test file:
```javascript
import mockConsole from "jest-mock-console";
```
Then your tests
```javascript
describe(...
it(...
const restoreConsole = mockConsole(); // mockConsole returns a function to restore it back to normal
console.error('This will not show in the test report');
expect(console.error).toHaveBeenCalled();
restoreConsole();
)
)
```
However you always need to restore the console after each test or you will break jest. This is where the [setupTestFramework](#setuptestframework) file comes in.
## Advanced Example
If you don't want to worry about accidentally forgetting to `restoreConsole()` after your tests you can modify jest to unmock after every `it(...)`.
In your jest config:
```javascript
setupFilesAfterEnv: ["jest-mock-console/dist/setupTestFramework.js"];
```
Then in your test files:
```javascript
import mockConsole from 'jest-mock-console';
describe(...
it(...
mockConsole();
console.error('This will not show in the test report');
expect(console.error).toHaveBeenCalled();
// No need for restoreConsole as it is called after every `it(...)`
)
)
```
## Analyze all logs
In some circumstances Jest is infamous for logging because it overwrites the bash output. If you're experiencing this kind of logging frustration and you need to analyze all the `console.log` call arguments (typically to understand why a test is failing) you can temporarily add an expect statement on the console itself.
In your test files:
```javascript
describe(...
it(...
const restoreConsole = mockConsole();
console.error('This will not show in the test report');
expect(console.error.mock.calls).toEqual([]);
restoreConsole();
)
)
```
the test looks like:
## mockConsole(mocks)
- **`mocks[string,array,object]`**: The properties of the console you want to mock. Defaults to ['log','warn','error']
- default - Will mock console.log, console.warn, and console.error
```
mockConsole() // same as `mockConsole(['log','warn','error'])
```
- string - You can mock a single function
```
mockConsole('error')
```
- array - You can mock multiple functions
```
mockConsole(['log', 'info'])
```
- object - You can set custom functions for console
```
const originalConsole = window.console;
mockConsole({
error: (...args) => originalConsole.log(`console.error of: ${...args}`)
})
```
## LICENSE
MIT
[npm]: https://www.npmjs.com/
[node]: https://nodejs.org/
[codecov-badge]: https://codecov.io/gh/bpedersen/jest-mock-console/branch/master/graph/badge.svg
[codecov]: https://codecov.io/gh/bpedersen/jest-mock-console
[build-badge]: https://travis-ci.org/bpedersen/jest-mock-console.svg
[build]: https://travis-ci.org/bpedersen/jest-mock-console
[dependencyci-badge]: https://dependencyci.com/github/bpedersen/jest-mock-console/badge
[dependencyci]: https://dependencyci.com/github/bpedersen/jest-mock-console
[license-badge]: https://img.shields.io/npm/l/jest-mock-console.svg
[license]: https://github.com/bpedersen/jest-mock-console/blob/master/other/LICENSE