Getting Started

These instructions will get you a copy of update-v on your local machine.

Installing

update-v is available via npm

npm i -g update-v

Built With

• node-fs-extra - Reading/writing JSON files
• command-line-args - Processing command-line flags

Versioning

We use SemVer for versioning.

Contributing

If you would like to contribute to this project, first of all, thank you.

Authors

• Martin Cox - Initial work

License

This project is licensed under the MIT License - see the LICENSE file for details

Usage

This is how you can use update-v.

Basic Usage

Just run update [-m|-f|-p].

Example

$ cd my/awesome/module
$ update-v -p

Updates the package.json file -> version by 0.0.1.

API Reference

Below is update-v's API reference.

-m|--major

Increment the first version digit (breaking change)

• Type: Boolean

Example

$ update-v -m

// Change package.json file from this:
{

    "version": "1.0.0"

}

// Into this:
{

    "version": "2.0.0"

}

-f|--feature|--minor

Increment the second version digit (additional feature)

• Type: Boolean

Example

$ update-v -f

// Change package.json file from this:
{

    "version": "1.0.0"

}

// Into this:
{

    "version": "1.1.0"

}

-p|--patch

Increment the third version digit (patched issue)

• Type: Boolean

Example

$ update-v -p

// Change package.json file from this:
{

    "version": "1.0.0"

}

// Into this:
{

    "version": "1.0.1"

}