# @bytedance/coverage-uploader

> An e2e coverage suite for frontend.

Latest version **1.0.1** (published 2023-02-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install @bytedance/coverage-uploader
pnpm add @bytedance/coverage-uploader
yarn add @bytedance/coverage-uploader
bun add @bytedance/coverage-uploader
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-02-13 |
| First published | 2023-02-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 17 |
| Unpacked size | 75 KB |
| Known vulnerabilities | 0 (+25 in 2 direct dependencies) |
| Install scripts | no |
| Author | guyunlong |
| Maintainers | jiangzc, eligao, emit, tseian, pd4d10, bytedance-name, bytednpm |
| Keywords | coverage, suite, istanbul |

## Links

- npm: https://www.npmjs.com/package/@bytedance/coverage-uploader
- npm.io page: https://npm.io/package/@bytedance/coverage-uploader

## Dependencies (17)

- [koa](https://npm.io/package/koa.md) ^2.11.0
- [axios](https://npm.io/package/axios.md) ^0.21.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.19
- [express](https://npm.io/package/express.md) 4.17.1
- [istanbul](https://npm.io/package/istanbul.md) ^0.4.5
- [koa-body](https://npm.io/package/koa-body.md) ^4.1.1
- [koa-mount](https://npm.io/package/koa-mount.md) ^4.0.0
- [koa-router](https://npm.io/package/koa-router.md) ^8.0.8
- [koa-static](https://npm.io/package/koa-static.md) ^5.0.0
- [koa-bodyparser](https://npm.io/package/koa-bodyparser.md) ^4.3.0
- [istanbul-lib-hook](https://npm.io/package/istanbul-lib-hook.md) ^3.0.0
- [convert-source-map](https://npm.io/package/convert-source-map.md) ^1.7.0
- [regenerator-runtime](https://npm.io/package/regenerator-runtime.md) ~0.13.9
- [istanbul-lib-coverage](https://npm.io/package/istanbul-lib-coverage.md) ^3.0.0
- [istanbul-lib-instrument](https://npm.io/package/istanbul-lib-instrument.md) ^4.0.1
- [istanbul-lib-source-maps](https://npm.io/package/istanbul-lib-source-maps.md) ^4.0.0
- [@types/express-serve-static-core](https://npm.io/package/@types/express-serve-static-core.md) ^4.17.33

## Recent versions

- 1.0.1 (latest) — 2023-02-13
- 1.0.0 — 2023-02-10

## README

# @bytedance/coverage-uploader

## Desc
A sdk used to upload the code coverage info.

## Usage
Insert the init code to your project entry as below:
```
import { createCoverageUploader, preReport } from '@bytedance/coverage-uploader',
const opt = {
    url: ${your report url}, // 上报地址,
    gitRepo: ${you gitrepo name},
    // @ts-ignore,
    preReport: preReport.qa('${your gitrepo name}', '${process.env.COMMIT_HASH}', filePath => (filePath.match(/\/${you repo suffix}\/(\\S+)/) || [])[1]),
    interval: 5000,
    retryLimit: 5,
},
const c = createCoverageUploader(opt);,
c.init();
```

---
_Source: https://npm.io/package/@bytedance/coverage-uploader · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._