https://github.com/nickfla1/vermi

A bare-bone and flexible versioning tool for JavaScript
https://github.com/nickfla1/vermi

javascript monorepo node nodejs typescript version

Last synced: about 2 months ago
JSON representation

A bare-bone and flexible versioning tool for JavaScript

• Host: GitHub
• URL: https://github.com/nickfla1/vermi
• Owner: nickfla1
• License: mit
• Created: 2023-05-11T18:51:56.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-26T21:01:38.000Z (4 months ago)
• Last Synced: 2024-10-14T02:26:35.001Z (2 months ago)
• Topics: javascript, monorepo, node, nodejs, typescript, version
• Language: JavaScript
• Homepage:
• Size: 287 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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".

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

[![Coverage Status](https://coveralls.io/repos/github/nickfla1/vermi/badge.svg)](https://coveralls.io/github/nickfla1/vermi)

## Installation

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

```sh

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

```sh

npx vermi version 

```

Supported strategies are `patch`, `minor`, `major` and `prerelease`.

> Vermi uses is powered by the [semver] package and follows [SemVer][semver-specs] specifications.

[semver]: https://www.npmjs.com/package/semver

[semver-specs]: https://semver.org/

#### As a library

```js

const vermi = require('vermi')

// ...

try {

    vermi.version({

    strategy: 'minor',

    packageDir: './my/subfolder/',

    })

} catch (error) {

  if (error instanceof vermi.errors.VermiError) {

    // handle error

  }

  

  // ...

}

```