Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Ashvin-Pal/jest-console-group-reporter
A Jest reporter that groups console messages, allows filtering, and provides flexible display configuration options.
https://github.com/Ashvin-Pal/jest-console-group-reporter
console group jest reporter
Last synced: 26 days ago
JSON representation
A Jest reporter that groups console messages, allows filtering, and provides flexible display configuration options.
- Host: GitHub
- URL: https://github.com/Ashvin-Pal/jest-console-group-reporter
- Owner: Ashvin-Pal
- License: mit
- Created: 2023-12-02T18:00:52.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-25T22:09:04.000Z (10 months ago)
- Last Synced: 2024-10-06T04:05:45.797Z (2 months ago)
- Topics: console, group, jest, reporter
- Language: TypeScript
- Homepage:
- Size: 3.13 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-jest - jest-console-group-reporter
README
# jest-console-group-reporter
A Jest reporter that groups console messages, allows filtering, and provides flexible display configuration options.
- Written in Typescript :zap:
- Supports displaying in GitHub Actions
- Provides configuration types for type safety
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Basic configuration](#basic-configuration)
- [Filtering console messages](#filtering-console-messages)
- [Grouping console messages](#grouping-console-messages)
- [Dynamic group names](#dynamic-group-names)
- [Configuration](#configuration)
- [filters](#filters)
- [groups](#groups)
- [consoleLevels](#consolelevels)
- [afterEachTest](#aftereachtest)
- [afterAllTests](#afteralltests)
- [useGitHubActions](#usegithubactions)
- [onlyFailingTestSuites](#onlyFailingTestSuites)
- [Summary Reporter](#summary-reporter)
- [Known issues](#known-issues)
## Installation
Install `jest-console-group-reporter` using your favorite package manager:
```bash
# npm
npm install jest-console-group-reporter -D
# yarn
yarn add jest-console-group-reporter -D
# pnpm
pnpm add jest-console-group-reporter -D
```
Minimum requirements
- Jest 25.1
- Node.js 16
## Usage
### Basic configuration
To use jest-console-group-reporter with the default configuration, simply add it to your Jest configuration:
```ts
// Add the reporter to your jest config
module.exports = {
// ...
reporters: ["jest-console-group-reporter"],
};
```
If you would like to use GitHub Actions grouping, see the example [here](#usegithubactions)
### Filtering console messages
You can filter specific console messages by providing a string, regular expression, or predicate function in the `filters` option:
```ts
// Add as many as you like!
const filters = ["error", /^react/];
module.exports = {
// ...
reporters: [["jest-console-group-reporter", { filters }]],
};
```
### Grouping console messages
You can create custom groups by specifying them in the `groups` option:
```ts
// Add as many as you like!
const groups = [
{
name: "React console messages",
match: /react/,
},
];
module.exports = {
// ...
reporters: [["jest-console-group-reporter", { groups }]],
};
```
### Dynamic group names
You can create dynamic group names by specifying them in the `groups` option:
```ts
const groups = [
{
name: ({ type }) => `React console.${type}`,
match: /react/,
},
];
module.exports = {
// ...
reporters: [["jest-console-group-reporter", { groups }]],
};
```
### Configuration
Default configuration:
```ts
const defaultOptions: Options = {
consoleLevels: ["error", "warn", "info", "debug", "log"],
filters: [],
groups: [],
onlyFailingTestSuites: false,
afterEachTest: {
enable: true,
reportType: "summary",
filePaths: false,
},
afterAllTests: {
reportType: "detailed",
enable: true,
filePaths: true,
},
useGitHubActions: false,
};
```
Here are the available configuration options:
### filters
An array of regular expressions, strings, or functions to filter out console messages.
Type declaration
```ts
interface ConsoleMessage {
type: string;
message: string;
origin: string | undefined;
}
type Filters = Array boolean)>;
```
##### Using a predicate function
When using a predicate function, the return type must be a `boolean`.
**Note: The origin is not available for all types of console message. So you will need to test it before using it.**
```ts
interface ConsoleMessage {
origin: string;
type: string | undefined;
message: string;
}
const filters = [
({ message }: ConsoleMessage) => message === "react",
({ origin }: ConsoleMessage) => origin && origin.match(/node_modules/),
({ type }: ConsoleMessage) => type === "error",
];
module.exports = {
// ...
reporters: [["jest-console-group-reporter", { filters }]],
};
```
### groups
An array of custom groups, where each group has a `name` and `match` property. Messages matching the `match` criteria will be grouped under the specified `name`.
**Note: The origin is not available for all types of console message. So you will need to test it before using it.**
Type declaration
```ts
interface ConsoleMessage {
type: string;
message: string;
origin: string;
}
type Matcher = string | RegExp | (({ type, message, origin }: ConsoleMessage) => boolean);
type Groups = Array<{
match: Matcher;
name: string | (({ type, message, origin }: ConsoleMessage) => string);
}>;
```
#### Using a predicate function
```ts
interface ConsoleMessage {
origin: string;
type: string | undefined;
message: string;
}
const groups = [
{
name: "React warnings",
match: ({ message, type }: ConsoleMessage) => message.match(/react/) && type === "warn",
},
{
name: "Error from some module",
match: ({ origin }: ConsoleMessage) => origin && origin.match(/some_module/),
},
];
module.exports = {
// ...
reporters: [["jest-console-group-reporter", { groups }]],
};
```
### consoleLevels
An array of console message types to capture (e.g., 'log', 'warn', 'error').
Type declaration
```ts
type ConsoleLevels = string[];
```
#### Example of only capturing error and warning messages
```ts
const consoleLevels = ["error", "warn"];
module.exports = {
// ...
reporters: [["jest-console-group-reporter", { consoleLevels }]],
};
```
### afterEachTest
Configuration for displaying console messages after each test.
Type declaration
```ts
interface DisplayOptions {
enable: boolean;
filePaths: boolean;
reportType: "summary" | "detailed";
}
```
- `enable` (boolean): Enable or disable displaying messages after each test.
- `filePaths` (boolean): Include file paths in the report.
- `reportType` ("summary" | "detailed"): Choose between "summary" and "detailed" report types
#### Disable displaying summary report after each test
```ts
const afterEachTest = {
enable: false;
}
module.exports = {
// ...
reporters: [["jest-console-group-reporter", { afterEachTest }]],
};
```
### afterAllTests
Configuration for displaying console messages after all tests have run.
Type declaration
```ts
interface DisplayOptions {
enable: boolean;
filePaths: boolean;
reportType: "summary" | "detailed";
}
```
- `enable` (boolean): Enable or disable displaying messages after all tests.
- `filePaths` (boolean): Include file paths in the report.
- `reportType` ("summary" | "detailed"): Choose between "summary" and "detailed" report types.
#### Disable displaying filePaths
```ts
const afterAllTest = {
filePaths: false;
}
module.exports = {
// ...
reporters: [["jest-console-group-reporter", { afterAllTest }]],
};
```
### useGitHubActions
Enable GitHub Actions specific behavior. This will wrap each console message in a dropdown. You will only want to enable this property when running in github actions.
Type declaration
```ts
type UseGithubActions = boolean;
```
#### Using the is-ci package
```ts
/**
* @see https://www.npmjs.com/package/is-ci
*/
const isCI = require("is-ci");
module.exports = {
// ...
reporters: [["jest-console-group-reporter", { useGithubActions: isCI }]],
};
```
#### Using a process.env variable
```ts
const useGithubActions = process.env.IS_CI;
module.exports = {
// ...
reporters: [["jest-console-group-reporter", { useGithubActions }]],
};
```
### onlyFailingTestSuites
This reporter shows console messages for all tests by default. Use the `onlyFailingTestSuites` option to see messages only for failing test suites. Due to Jest's limitations, messages can't be filtered for individual failing tests, only for the entire failing suites.
```ts
module.exports = {
// ...
reporters: [["jest-console-group-reporter", { onlyFailingTestSuites: true }]],
};
```
## Summary Reporter
The jest-console-group-reporter internally uses the summary reporter provided by Jest to display the overall test summary. You do not need to explicitly pass the summary reporter to the reporter options, as it is automatically integrated by default.
## Known issues
When running Jest for a single test file (e.g. jest src/someTest.ts), the reporter is not activated. This seems to be a bug with Jest and not this reporter :)