Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flesler/uver
Bump the version on package.json and other files
https://github.com/flesler/uver
Last synced: 2 months ago
JSON representation
Bump the version on package.json and other files
- Host: GitHub
- URL: https://github.com/flesler/uver
- Owner: flesler
- License: mit
- Created: 2014-08-26T17:14:24.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-10-18T00:10:25.000Z (about 9 years ago)
- Last Synced: 2024-09-13T22:58:40.411Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 195 KB
- Stars: 7
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
README
# uver
Bump the version on package.json and other files
## CLI
To bump file versions from the command-line, check [uver-cli](https://github.com/flesler/uver-cli)
## Installation
[](https://npmjs.org/package/uver)
``` bash
$ npm install uver
```
## Basic usage
```js
var uver = require('uver');
var newVersion = uver({ /* options */ });
// package.json version was incremented and saved
```
`uver` can receive an object with options (none required):
- `patch: true`: Update patch version (this is the default)
- `minor: true`: Update minor version
- `major: true`: Update major version
- `index: 1`: Update the version on the specified index (0 for major)
- `revert: true`: Decrement instead of increment
- `root: './files'`: Where to look for the source file (default is `process.cwd()`)
- `filename: 'bower.json'`: Filename of the source (default is package.json)
- `ver: '1.2.3'`: Specify a fixed version
- `output: './package.json.bkp'`: Where to save the file (default is override source)
- `stream: process.stdout`: Output file to a stream instead of output or source
You can also pass the `version` directly as the argument:
```js
uver('1.2.3');
```
## Some notes
- uver won't reformat the file in any way, indentation and new lines will be preserved
- Given more than one out of `major`, `minor` and `patch`, only the "highest" will be updated.
- Updating a component will reset to 0 all the ones on the right (1.1.1 -> 1.2.0 and not 1.2.1)
## Why not npm version
[npm version](https://www.npmjs.org/doc/cli/npm-version.html) is pretty cool and I used it as a reference to write this module.
One of the problems is it also:
- Creates a commit
- Creates a tag for that commit
There's currently no way to prevent these 2 from happening as well.
Also, npm version doesn't allow reverting (decrementing) a version.
## Tests
``` bash
$ npm test
```
## TODO
- See if viable to rely on [semver](https://github.com/npm/node-semver) to update the version. It's much more solid but doesn't allow decrementing.
- Support pre-release and similar?
## LICENSE
The MIT License (MIT)
Copyright (c) 2014 Ariel Flesler
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.