Package Exports

@skypilot/versioner

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@skypilot/versioner) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@skypilot/versioner

stable build next build Codacy grade downloads

A collection of functions and classes for managing version numbers.

Installation

$ yarn add @skypilot/versioner
# or
$ npm install @skypilot/versioner

Basic usage

TypeScript

import { bumpVersion, ChangeLevel } from '@skypilot/versioner';

bumpVersion(
  version: string,
  changeLevel: ChangeLevel,
  channel?: string,
  previousVersions?: string[]
)

TypeScript examples

bumpVersion('1.0.1', ChangeLevel.patch)
// '1.0.2'

bumpVersion('1.0.1', ChangeLevel.minor)
// '1.1.0'

bumpVersion('1.0.1', ChangeLevel.major)
// '2.0.0'

bumpVersion('1.0.1', ChangeLevel.minor, 'alpha')
// '1.1.0-alpha.0'

bumpVersion('1.0.1', ChangeLevel.minor, 'alpha', ['1.1.0-alpha.1', '1.1.0-alpha.2'])
// '1.1.0-alpha.3'

ES6

import { bumpVersion } from '@skypilot/versioner';

bumpVersion(
  version, // string
  changeLevel, // 'major' | 'minor' | 'patch' | 'fix'
  channel, // [optional] string
  previousVersions // [optional] string[]
)

ES6 examples

bumpVersion('1.0.1', 'patch')
// '1.0.2'

bumpVersion('1.0.1', 'minor')
// '1.1.0'

bumpVersion('1.0.1', 'major')
// '2.0.0'

bumpVersion('1.0.1', 'minor', 'alpha')
// '1.1.0-alpha.0'

bumpVersion('1.0.1', 'minor', 'alpha', ['1.1.0-alpha.1', '1.1.0-alpha.2'])
// '1.1.0-alpha.3'

Advanced usage

The library exposes the following exports:

Classes

PrereleaseVersion
ReleaseVersion

Constants & enums

ChangeLevel

Functions

parseChangeLevel(changeLevel: string): ChangeLevel

TODO: Document class and function API.