README.md

Vermi 🪱

A bare-bone and flexible versioning tool for JavaScript.

Vermi (IPA: /'vɛrmi/) means "worms" in italian and it comes from the contraction of the words "version" and "me".

Installation

Vermi can be either installed globally or locally as a dev dependency.

npm install vermi -g
npm install vermi --save-dev

yarn global add vermi
yarn add vermi -D

pnpm add vermi -g
pnpm add vermi -D

Monorepo support

Vermi does not currently support versioning monorepos on an higher level.

You can work around this limitation by installing Vermi globally and running it where necessary.

Usage

Version bump

As CLI

npx vermi version <strategy>

Supported strategies are patch, minor, major and prerelease.

Vermi uses is powered by the semver package and follows SemVer specifications.

As a library

const vermi = require('vermi')

// ...

try {
    vermi.version({
    strategy: 'minor',
    packageDir: './my/subfolder/',
    })
} catch (error) {
  if (error instanceof vermi.errors.VermiError) {
    // handle error
  }
  
  // ...
}