upvn

upvn

====

This library is tool to update version info in the package.json with current version info in the NPM.
Mainly this library is used to update npm version before publish.

Purpose

Update version info before publish library to NPM.

Usage

This library have two ways to use.
Command line mode and library mode. Command line mode is made for purpose of CI.
Library mode is made to update version data in program.

Command line

In this mode, latest version is set from NPM information data.
And next, update package.json with updated version data.

$upvn [parameter]

In the Program

const upvn = require('upvn');

const test = 'v0.1.2-beta4';

upvn.update(test, 'major');     // -> v1.0.0
upvn.update(test, 'minor');     // -> v0.2.0
upvn.update(test, 'patch');     // -> v0.1.3
upvn.update(test, 'v1.1.1');    // -> v1.1.1
upvn.update(test, 'premajor');  // -> v1.0.0-beta0
upvn.update(test, 'preminor');  // -> v0.2.0-beta0
upvn.update(test, 'prepatch');  // -> v0.1.3-beta0
upvn.update(test, 'prerelease');// -> v0.1.2-beta5

About parameter

parameter	description	version info in NPM	sample param	result
<newversion>	version info. X.Y.Z ... format. default value is override with this.	1.2.3	3.4.5	3.4.5
major	increment major version	1.2.3	major	2.0.0
minor	increment minor version	1.2.3	minor	1.3.0
patch	increment patch version	1.2.3	patch	1.2.4
premajor	increment major version and set release info	1.2.3	premajor	2.0.0-0
preminor	increment minor version and set release info	1.2.3	preminor	1.3.0-0
prepatch	increment patch version and set release info	1.2.3	prepatch	1.2.4-0
prerelease	increment release version	1.2.3-0	prerelease	1.2.3-1

License

(The ISC License)

Copyright 2017 Shunsuke <[e-mail]>

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.