Skip to content

Identify whether a semver string refers to an exact (single) version or range of (multiple) versions

License

Notifications You must be signed in to change notification settings

jacobq/is-exact-version

Repository files navigation

is-exact-version

npm version build status CodeClimate maintainability rating (percent) test coverage This project uses conventional commits

This module is a complete re-write of bendrucker/exact-version. It drops support for end-of-life versions of node, is written in TypeScript, and uses Jest for testing.

Why another library?

I needed something more consistent and complete (e.g. behavior matching package.json version range string spec, including support for "commitish" values), and I first attempted to make a PR but then was met with belligerence. Making my own implementation seemed the more civil course of action than engaging in an argument.

Why should I use this library?

  • Uses node's own semver module as much as possible, and consequently uses no RegExp of its own.
  • strictNullChecks & noImplicitAny are both enabled in tsconfig.json.
  • Thorough test suite clearly indicates behavior.

Usage

Example: (try it on RunKit)

import { isExactVersion } from "is-exact-version";

const examples = [
  '^1.0.0',
  '~1.1.0',
  '1.1.1',
  '1.0.0-beta.1',
  'user/is-exact-version#commit'
];
for (const s of examples) {
  console.log(`${s} -> ${isExactVersion(s)}`);
}

// Log:
// "^1.0.0 -> false"
// "~1.1.0 -> false"
// "1.1.1 -> true"
// "1.0.0-beta.1 -> true"

Requirements

  • Node >= 16.* (>= 12.* should work, but is not tested) For older versions use the 1.x version of this package.

Support / questions

If you have any questions or suggestions related to this package feel free to create a new issue. However, it should be noted that I have not actually needed to use this for a long time, and the main reason I keep it around is for practice ("kata" if you will), e.g. learning to use GitHub Actions as well as ESM in TypeScript.

Development

This package (optionally) uses debug-js/debug and will output debugging information if the DEBUG environment variable enables is-exact-version. e.g.

$ DEBUG=is-exact-version node some-app.js

Not that that's particularly useful for most people...

This project also strives to adhere to the conventional commits standard.

License

This project is licensed under the terms of the open source MIT License. See LICENSE for the complete text.

About

Identify whether a semver string refers to an exact (single) version or range of (multiple) versions

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •