@chatie/semver

The Enhanced Semantic Versioner for NPM

Usage no npm install needed!

<script type="module">
  import chatieSemver from 'https://cdn.skypack.dev/@chatie/semver';
</script>

README

@chatie/semver

NPM Version npm (tag) Build Status

Linux Kernel Numbering

Source: How do Linux Versions Work?

The Enhanced Semantic Versioner for NPM

USAGE

This module is a wrapper of the NPM module semver, it provide following additional features:

  1. Two CLI utils that will identify whether this VERSION is for production(stable) or development(unstable):
    1. semver-is-prod
    2. semver-id-dev
  2. Added two methods to SemVer class:
    1. isProd(version: string): boolean
    2. isDev(version: string): boolean
  3. TypeScript support. It contains the typing definations already

Learn more about the original semver from its GitHub homepage: semver

BACKGROUND

Copy from Linux Kernel Version Numbering - http://www.linfo.org/kernel_version_numbering.html:

The second number denotes the major revision of the kernel version. It was formerly the case that even numbers indicated a stable release, that is, one that was deemed fit for production use (i.e., use in a non-experimental environment), such as 1.2, 2.4 or 2.6. Likewise, odd numbers, such as 1.1 or 2.5, have historically represented development releases. They were for testing new features and device drivers until they became sufficiently stable to be included in a stable release. However, this has changed starting with the Linux 2.6.x series, and new feature development now takes place in the same revision number.

Following the Semantic Versioning 2.0 http://semver.org/, and we will be able to use the MINOR version to indicated the release is STABLE or NOT.

Numbering rule:

  1. even numbers, such as 0.8, 0.12 indicated a stable release, which is fit for production use.
  2. odd numbers, such as 0.11 or 0.13, represented as development releases.

See also: https://github.com/Chatie/wechaty/issues/905

CHANGELOG

v0.3 (master)

  1. remove binary semver-is-dev because it might introduce bugs when using in devops. Use semver-is-prod instead.

v0.2 June 09, 2019

  1. Beta Release

v0.0.1 June 08, 2019

  1. Wrap semver
  2. add new methods: isProd & isDev
  3. add new binary: semver-is-prod & semver-is-dev

AUTHOR

Huan LI (李卓桓) zixia@zixia.net

Profile of Huan LI (李卓桓) on StackOverflow

COPYRIGHT & LICENSE

  • Code & Docs © 2019 - now Huan LI zixia@zixia.net
  • Code released under the Apache-2.0 License
  • Docs released under Creative Commons