Package Exports
- bump-regex
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 (bump-regex) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
bump-regex
bump regex with semver
Information
Package | bump-regex |
Description | bump regex with semver |
Node Version | >= 4.0.0 |
Usage
Install
$ npm install --save bump-regex
var bump = require('bump-regex');
bump('version: "0.1.2"', function(err, out) {
// => 'version: "0.1.3"'
});
Options
options.type
Semver version type to bump
Type: `String`
Default: `patch`
Valid values: `major|minor|patch|prerelease`
options.key
Set the versioning key
Type: `String`
Default: `version`
options.keys
Sets multiple versioning keys.
Type: `Array` of `String`s
Default: null
options.case
Set case insensitive matching
This option enables matching a specific Case Sensitive selector
<xml>
<version>nope</version>
<Version>1.2.3</Version>
</xml>
Type: `Boolean`
Default: `false`
options.version
Set a specific version to bump to.
Type: `String`
Default: `null`
options.preid
Set the prerelase tag to use
Type: `String`
Default: `null`
options.regex
Set the version selector regex
Type: `RegEx`
options.keepmetadata
Keep the metadata of the old version after bumping (exception: you are using options.version)
Type: `Boolean`
Default: `false`
Example:
type: 'prerelease',
preid : 'alphaWhateverTheYWant'
// => '0.0.2-alphaWhateverTheYWant.0'
Versioning
Versioning Used: Semantic
String, lowercase
- MAJOR ("major") version when you make incompatible API changes
- MINOR ("minor") version when you add functionality in a backwards-compatible manner
- PATCH ("patch") version when you make backwards-compatible bug fixes.
- PRERELEASE ("prerelease") a pre-release version
Version example
major: 1.0.0
minor: 0.1.0
patch: 0.0.2
prerelease: 0.0.1-2