# @coralproject/package-version-lint

> This is a simple linter that compares your `version` in your `package.json` and `package-lock.json` file (if it exists) to ensure that they are up to date. It also comes with a `--expect` flag that can be used to verify a specific version.

Latest version **2.0.0** (published 2020-12-29) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @coralproject/package-version-lint
pnpm add @coralproject/package-version-lint
yarn add @coralproject/package-version-lint
bun add @coralproject/package-version-lint
```

Provides the command `package-version-lint`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2020-12-29 |
| First published | 2020-03-18 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | The Coral Project |
| Maintainers | nick.funk, tessat, kgardnr, wyattjoh, wikiwi, immber |

## Links

- npm: https://www.npmjs.com/package/@coralproject/package-version-lint
- Repository: https://github.com/coralproject/package-version-lint
- Homepage: https://github.com/coralproject/package-version-lint#readme
- Issues: https://github.com/coralproject/package-version-lint/issues
- npm.io page: https://npm.io/package/@coralproject/package-version-lint

## Dependencies (1)

- [yargs](https://npm.io/package/yargs.md) ^16.2.0

## Recent versions

- 2.0.0 (latest) — 2020-12-29
- 1.0.4 — 2020-03-18
- 1.0.3 — 2020-03-18
- 1.0.2 — 2020-03-18
- 1.0.1 — 2020-03-18
- 1.0.0 — 2020-03-18

## README

# package-version-lint

This is a simple linter that compares your `version` in your `package.json` and
`package-lock.json` file (if it exists) to ensure that they are up to date. It
also comes with a `--expect` flag that can be used to verify a specific version.

## Usage

To run standalone and verify that the package versions are in sync, use:

```sh
npx @coralproject/package-version-lint
```

Or to verify a specific version:

```sh
npx @coralproject/package-version-lint --expect 1.0.2
```

If using in CI (this example uses CircleCI), you can use a combination of the
`--expect` flag and [shell parameter expansion](https://www.gnu.org/software/bash/manual/html_node/Shell-Parameter-Expansion.html) to do the following:

```sh
CIRCLE_TAG=v1.0.2
npx @coralproject/package-version-lint --expect ${CIRCLE_TAG/#v}
```

The `${CIRCLE_TAG/#v}` will take the variable, `CIRCLE_TAG` and strip the
leading `v` from it, leaving us with `1.0.2` which can be used with the
`--expect` flag. This can be used with any other CI that provides the tag in the
environment.

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