VersionIt - Version Management Library

Lightweight Version Management library for managing Semantic Versioning and Calendar Versioning

Features

• Simple to use
• Supports Semantic Versioning
  • Extended with key-value pair support in the PRERELEASE identifier (e.g. 0.1.0-rc.1 < 0.1.0-rc.2 )
• Supports [Calendar Versioning]
  • Extended with key-value pair support in the MODIFIER identifier (e.g. 2023.25.1-build.1)

Semantic Versioning

[!NOTE] Please refer to the SemVer 2.0.0 specification for information about Semantic Versioning.

import { SemVer } from "@dev-build-deploy/version-it";

// Create from string
const currentVersion = SemVer.fromString("0.1.2");

// Increment the version
const alphaVersion = currentVersion.increment("PRERELEASE", "alpha"); // => 0.1.2-alpha.1
const majorVersion = currentVersion.increment("MAJOR"); // => 1.0.0

// Create from interface
const constructed = new SemVer({
  minor: 1,
  patch: 2,
  preReleases: [{ identifier: "alpha", value: 3 }]
});

Incrementing the version

The following increment types can be applied when using .increment(...):

| Type | Description | | --- | --- | | MAJOR | Increments the MAJOR version core | | MINOR | Increments the MINOR version core | | PATCH | Increments the PATCH version core | | PRERELEASE | Increments the PRERELEASE or adds -rc.1 in case no PRERELEASE is present on the version to be incremented.You can specify the pre-release element to increment by providing the optional modifier parameterThis will manage pre-release identifiers a key-value pair (e.g. -alpha.1, -rc.7) |

Calendar Versioning

[!NOTE] Please refer to the CalVer specification for information about Calendar Versioning.

import { CalVer } from "@dev-build-deploy/version-it";

const calverFormat = "YYYY.0M.MICRO";

// Create from string
const currentVersion = new CalVer(calverFormat, "2023.01.12-alpha.2");

// Create from interface
const constructed = new CalVer(
  calverFormat, {
    major: 2023,
    minor: 1,
    micro: 12,
    modifiers: [{ identifier: "alpha", version: 1 }]
  }
);

// Update the calendar related version (e.g. YYYY, MM, WW, DD)
const newVersion = currentVersion.increment("CALENDAR"); // => 2024.0.0

CalVer Formatting

[!WARNING] We only support CalVer formatting with 2 or 3 version cores.

Formatting is provided as a string, where each version core (MAJOR, MINOR, MICRO) can be assigned to a specific format:

| Format | Description | | --- | --- | | YYYY | Full year | | YY | Last three digits of the year (e.g. 3, 23, 101) | 0Y | Zero padded last three digits of the year (e.g. 003, 023, 101) | MM | Month number | | 0M | Zero padded month number | | WW | Week number (according to ISO8601) | | 0W | Zero padded week number (according to ISO8601) | | DD | Day of the month | | 0D | Zero padded day of the month | | MAJOR | Incremental number | | MINOR | Incremental number | | MICRO | Incremental number |

Incrementing the version

[!WARNING] The MODIFIER is using the same precedence rules as "Pre-releases" in the [SemVer] specification.

The following increment types can be applied when using .increment(...):

| Type | Description | | --- | --- | | CALENDAR | Updates any version core associated with calendar-related formatting.Adds the build.1 modifier in case the exact version already exists | | MAJOR | Increments (+1) the version associated with MAJOR formatting | | MINOR | Increments (+1) the version associated with MINOR formatting | | MICRO | Increments (+1) the version associated with MICRO formatting | | MODIFIER | Increments the MODIFIER or adds -rc.1 in case no MODIFIER is present on the version to be incremented.You can specify the modifier element to increment by providing the optional modifier parameterThis will manage pre-release identifiers a key-value pair (e.g. -alpha.1, -rc.7)|

Comparing and sorting

Both SemVer and CalVer can be compared and/or sorted in the same manner:

// Sort versions...
const unsortedVersions = [
  previousVersion,
  currentVersion,
  newVersion
]

const sortedVersions = unsortedVersions.sort((a, b) => a.compareTo(b));

// ...or use the comparator functions:
//   isEqualTo(..)
//   isGreaterThan(..)
//   isLessThan(..)
if (newVersion.isGreaterThan(previousVersion)) {
  // Hurray..!
}

Contributing

If you have suggestions for how version-it could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the Contributing Guide.

License

• MIT © 2023 Kevin de Jong <[email protected]>