Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tasshi-me/jest-md-dashboard
Generating a pretty Markdown dashboard for Jest
https://github.com/tasshi-me/jest-md-dashboard
ci jest jest-reporter markdown
Last synced: about 2 months ago
JSON representation
Generating a pretty Markdown dashboard for Jest
- Host: GitHub
- URL: https://github.com/tasshi-me/jest-md-dashboard
- Owner: tasshi-me
- License: mit
- Created: 2022-06-21T16:49:54.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-09T20:11:18.000Z (5 months ago)
- Last Synced: 2024-09-09T20:25:05.581Z (5 months ago)
- Topics: ci, jest, jest-reporter, markdown
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/jest-md-dashboard
- Size: 2.1 MB
- Stars: 8
- Watchers: 2
- Forks: 5
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# jest-md-dashboard
[](https://badge.fury.io/js/jest-md-dashboard)
[](https://codecov.io/gh/tasshi-me/jest-md-dashboard)
[](https://github.com/tasshi-me/jest-md-dashboard/actions/workflows/test.yml)
[](https://github.com/tasshi-me/jest-md-dashboard/actions/workflows/lint.yml)
[](LICENSE)
Generating a pretty Markdown dashboard for Jest
## Table of Contents
- [Example](#Example)
- [Installation](#Installation)
- [Usage](#Usage)
- [Options](#Options)
- [Contribution](#Contribution)
- [License](#License)
## Example
See https://github.com/tasshi-me/jest-md-dashboard/issues/20
## Installation
### npm
```shell
npm install -D jest-md-dashboard
```
### yarn
```shell
yarn add -D jest-md-dashboard
```
### pnpm
```shell
pnpm add -D jest-md-dashboard
```
## Usage
Add `reporters` field in `jest.config.js`.
```js
const config = {
reporters: ["default", "jest-md-dashboard"],
};
module.exports = config;
```
Run jest and the dashboard is generated to `test-dashboard.md`.
### With [options](#Options)
```js
const config = {
reporters: ["default", ["jest-md-dashboard", { title: "My Dashboard" }]],
};
module.exports = config;
```
## Options
| Name | Type | Default | Description |
| ------------------ | -------- | ------------------- | ------------------------------------------------------------------------------------------- |
| `title` | `string` | `"Test Dashboard"` | The title of a dashboard.
It will be printed at the top of the markdown output. |
| `outputPath` | `string` | `test-dashboard.md` | The file path to output dashboard.
If you want to output to stdout, specify `-`. |
| `permalinkBaseUrl` | `string` | `undefined` | Override baseUrl of permalink.
See [Permalink](#Permalink) section for more information. |
### Permalink
jest-md-dashboard generates permalink to test files on GitHub (or other services) by default.
It tries to find git information from the following sources.
1. `permalinkBaseUrl` option
2. (on GitHub Actions) environment variables
3. (in git repository) repository config
#### 1. `permalinkBaseUrl` option
If `permalinkBaseUrl` is specified on jest config, jest-md-dashboard generates permalink using it.
Specify this option when if generated permalinks are incorrect.
The URL must have a trailing slash.
e.g. `https://github.com/tasshi-me/jest-md-dashboard/blob/`
#### 2. Run on GitHub Actions
If jest runs on GitHub Actions, jest-md-dashboard refers to the the [environment variables](https://docs.github.com/ja/actions/learn-github-actions/environment-variables).
#### 3. Run in git repository
If jest runs in a git repository, jest-md-dashboard refers to the local repository config.
## Contribution
We appreciate your help!
## License
- [MIT](LICENSE)