# jscpd-badge-reporter

> Reporter for jscpd fo generation copy/paste badges.

Latest version **1.1.3** (published 2018-11-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install jscpd-badge-reporter
pnpm add jscpd-badge-reporter
yarn add jscpd-badge-reporter
bun add jscpd-badge-reporter
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2018-11-21 |
| First published | 2018-11-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=8.9 |
| Dependencies | 2 |
| Unpacked size | 15.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Maintainers | apk |

## Links

- npm: https://www.npmjs.com/package/jscpd-badge-reporter
- Repository: https://github.com/kucherenko/jscpd-bootstrap-reporter
- Homepage: https://github.com/kucherenko/jscpd-bootstrap-reporter#readme
- Issues: https://github.com/kucherenko/jscpd-bootstrap-reporter/issues
- npm.io page: https://npm.io/package/jscpd-badge-reporter

## Dependencies (2)

- [badgen](https://npm.io/package/badgen.md) ^2.5.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^7.0.1

## Recent versions

- 1.1.3 (latest) — 2018-11-21
- 1.1.2 — 2018-11-21
- 1.1.1 — 2018-11-19
- 1.1.0 — 2018-11-19
- 1.0.1 — 2018-11-17

## README

# jscpd-badge-reporter

The badge reporter for [jscpd](https://github.com/kucherenko/jscpd).

Generate badges:

![jscpd-badge-green](badges/jscpd-badge-green.svg)
![jscpd-badge-green](badges/jscpd-badge-red.svg)

## Getting started

### Install

```bash
npm install jscpd@1.0.0-rc.5 jscpd-badge-reporter -g
```

### Usage

```bash
jscpd [...options] --reporters badge /path/to/source
```

### Options

```typescript

interface IBadgeOptions {
  color?: string, // color of badge, if threshold > current - green, if  threshold < current - red, no threshold provided - grey
  subject?: string, // label of the badge, default "Copy/Paste" 
  style?: string, // "flat" of undefined, default - undefined
  icon?: string, // 'data:image/svg+xml;base64,...' icon
  iconWidth?: number, // width of the icon
  path?: string, // path to badge, default is 'jscpd-badge.svg' in output folder
}

```

[MIT](LICENSE) © Andrey Kucherenko

---
_Source: https://npm.io/package/jscpd-badge-reporter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._