# @wopian/jest-reporter-github-annotations

> Report Jest test failures with GitHub annotations

Latest version **0.0.2** (published 2022-01-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install @wopian/jest-reporter-github-annotations
pnpm add @wopian/jest-reporter-github-annotations
yarn add @wopian/jest-reporter-github-annotations
bun add @wopian/jest-reporter-github-annotations
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2022-01-28 |
| First published | 2022-01-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >= 14 < 15 \|\| >= 16 |
| Dependencies | 0 |
| Unpacked size | 6.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | wopian |
| Maintainers | wopian |
| Keywords | jest, reporter, reporters, integration, github, annotations, ci, cd, actions, workflow, results, processor |

## Links

- npm: https://www.npmjs.com/package/@wopian/jest-reporter-github-annotations
- Repository: https://github.com/wopian/jest-reporter-github-annotations
- Homepage: https://github.com/wopian/jest-reporter-github-annotations#readme
- Issues: https://github.com/wopian/jest-reporter-github-annotations/issues
- npm.io page: https://npm.io/package/@wopian/jest-reporter-github-annotations

## Alternatives

- [random-seedable](https://npm.io/package/random-seedable.md) — 27.9K weekly downloads
- [n2words](https://npm.io/package/n2words.md) — 22.2K weekly downloads
- [@stdlib/math-base-special-factorialln](https://npm.io/package/@stdlib/math-base-special-factorialln.md) — 5.7K weekly downloads
- [@stdlib/math-base-special-abs2](https://npm.io/package/@stdlib/math-base-special-abs2.md) — 1.7K weekly downloads
- [commons-math-interpolation](https://npm.io/package/commons-math-interpolation.md) — 1.4K weekly downloads

## Recent versions

- 0.0.2 (latest) — 2022-01-28
- 0.0.1 — 2022-01-26

## README

<h1 align=center>Jest Reporter GitHub Annotations</h1>

<p align=center>
  <a href='https://www.npmjs.com/package/@wopian/jest-reporter-github-annotations'><img alt='npm' src='https://flat.badgen.net/npm/v/@wopian/jest-reporter-github-annotations'></a>
  <a href='https://www.npmjs.com/package/@wopian/jest-reporter-github-annotations'><img alt='npm' src='https://flat.badgen.net/npm/dt/@wopian/jest-reporter-github-annotations'></a>
  <a href='https://bundlephobia.com/result?p=@wopian/jest-reporter-github-annotations'><img alt='bundlephobia' src='https://flat.badgen.net/bundlephobia/minzip/@wopian/jest-reporter-github-annotations?label=library%20size'></a>
</p>

<p align=center>
  <a href='https://github.com/wopian/jest-reporter-github-annotations/actions'><img alt='checks' src='https://flat.badgen.net/github/checks/wopian/jest-reporter-github-annotations'></a>
  <a href='https://github.com/wopian/jest-reporter-github-annotations/network/dependents'><img alt='repoDependants' src='https://flat.badgen.net/github/dependents-repo/wopian/jest-reporter-github-annotations'></a>
  <a href='https://github.com/wopian/jest-reporter-github-annotations/graphs/contributors'><img alt='devDeps' src='https://flat.badgen.net/github/contributors/wopian/jest-reporter-github-annotations'></a>
  <a href='https://github.com/sponsors/wopian'><img alt='sponsor' src='https://flat.badgen.net/badge/sponsor/%E2%9D%A4/pink?icon=github'></a>
</p>

<p align=center>Report Jest test failures directly on pull requests with GitHub annotations</p>

## Install

```
yarn install -D @wopian/jest-reporter-github-annotations
```

## Usage

This reporter only outputs failing test results in GitHub's annotation format, so you must include the default Jest reporter to get human readable test results in the terminal logs.

### CLI (preferred)

Add it to your Jest script used by your GitHub Actions workflow in `package.json`:

```json
{
  "scripts": {
    "test": "jest --reporters=default --reporters=@wopian/jest-reporter-github-annotations",
  }
}
```

### Jest Configuration

Or add it to your Jest configuration in `jest.config.js`:

```js
export default {
  reporters: [
    'default',
    '@wopian/jest-reporter-github-annotations',
  ],
}
```

Or `package.json`:

```json
{
  "jest": {
    "reporters": [
      "default",
      "@wopian/jest-reporter-github-annotations",
    ],
  }
}
```

---
_Source: https://npm.io/package/@wopian/jest-reporter-github-annotations · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._