# reg-simple-keygen-plugin

> Determine snapshot key with given values

Latest version **0.14.2** (published 2024-03-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install reg-simple-keygen-plugin
pnpm add reg-simple-keygen-plugin
yarn add reg-simple-keygen-plugin
bun add reg-simple-keygen-plugin
```

## Health

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

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.14.2 |
| Published | 2024-03-01 |
| First published | 2017-08-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 66 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1295 |
| Author | Quramy |
| Maintainers | quramy |
| Keywords | reg, reg-suit-plugin |

## Links

- npm: https://www.npmjs.com/package/reg-simple-keygen-plugin
- Repository: https://github.com/reg-viz/reg-suit
- Homepage: https://github.com/reg-viz/reg-suit#readme
- Issues: https://github.com/reg-viz/reg-suit/issues
- npm.io page: https://npm.io/package/reg-simple-keygen-plugin

## Recent versions

- 0.14.2 (latest) — 2024-03-01
- 0.14.0 — 2024-02-26
- 0.13.0 — 2024-01-19
- 0.12.2 — 2023-07-04
- 0.12.1 — 2022-06-08
- 0.11.0 — 2021-10-27
- 0.10.17 — 2021-10-16
- 0.10.16 — 2021-06-08
- 0.10.15 — 2021-03-12
- 0.10.10 — 2020-12-22
- 0.10.9 — 2020-12-04
- 0.10.8 — 2020-10-26
- 0.10.7 — 2020-09-18
- 0.10.6 — 2020-09-14
- 0.10.3 — 2020-09-10
- … 10 more at https://npm.io/package/reg-simple-keygen-plugin/versions

## README

# reg-simple-keygen-plugin

A reg-suit plugin to determine the snapshot key with given values.

## Install

```sh
npm i reg-simple-keygen-plugin -D
```

## Configure

```ts
{
  expectedKey: string;
  actualKey: string;
}
```

- `expectedKey` - _Required_ - Identifier key value of the expected(previous) snapshot.
- `actualKey` - _Required_ - Identifier key value of the actual(current) snapshot.

## Example

### Using environment values

Using reg-suit's [replacing environment values feature](https://github.com/reg-viz/reg-suit/blob/master/README.md#embed-environment-values), you can use Git commit sha1 hashes provided with CI service. The following example allows reg-suit to compare HEAD of the master branch with the PR's commit.

```yml
# .travis.yml
script:
  - export EXPECTED_KEY=$(git rev-parse origin/master)
  - export ACTUAL_KEY=$TRAVIS_COMMIT # set by TravisCI
  - reg-suit run
```

```js
  // regconfig.json
  "plugins": {
    "reg-simple-keygen-plugin": {
      "expectedKey": "${EXPECTED_KEY}",
      "actualKey": "${ACTUAL_KEY}"
    },
    ...
  }
```

---
_Source: https://npm.io/package/reg-simple-keygen-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._