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 BUILD and PRERELEASE identifier (e.g. 0.1.0-rc.1 < 0.1.0-rc.2, 0.2.3-rc.3+build.2 < 0.2.3-rc.3+build.3 )
• Supports [Calendar Versioning]
  • Extended with key-value pair support in the MODIFIER identifier (e.g. 2023.25.1-build.1)

Semantic Versioning

💡 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 = new SemVer("0.1.2-alpha.4");

// Create from interface
const previousVersion = new SemVer({
  minor: 1,
  patch: 2,
  preRelease: "alpha.3"
});

// Increment the version
const newVersion = currentVersion.increment("PRERELEASE");

Incrementing the version

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

Calendar Versioning

💡 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 previousVersion = new CalVer(
  calverFormat, {
    major: 2023,
    minor: 1,
    micro: 12,
    modified: "alpha.1"
  }
);

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

CalVer Formatting

NOTE: Wwe 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:

Incrementing the version

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

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 <monkaii@hotmail.com>