appversion
appversion is a cli tool for keep track the version, build and commit of your javascript application.
Project built following semver guidelines.
Usually a project has different configuration/package-manager files, such as package.json and/or bower.json, and can be really tedious update the project number in every file.
Here comes to help appversion, an easy to use command line tool who updates all the files for you.
In addition appversion keeps track of the build date and number.
The tool creates a json file named appversion.json
in the root of your project with the following structure:
{
"version": {
"major": 0,
"minor": 0,
"patch": 0
},
"status": null,
"build": {
"date": null,
"number": 0,
"total": 0
},
"commit": null,
"json": [
"package.json",
"bower.json"
]
}
As you can see, the version is divided in major
, minor
and patch
, the build is divided in date
, number
and total
, in addition, there's the status
field, who can assume stable|rc|beta|alpha
value.
The last field, json
, is the list of the json files who appversion must update when you change the version number, is not available via the import.
The code is written in javascript es6 and compiled in es5 via babel.io.
Install
Install the tool globally:
npm install appversion -g
If you want to access the appversion.json
inside your application, install the module also locally:
npm install appversion
Usage
CLI:
$ apv <cmd> <args>
Commands list:
cmd | args | description |
---|
update | major | Updates major number. |
| minor | Updates minor number. |
| patch | Updates patch number. |
| build | Updates build number. |
| commit | Updates commit code. |
| | |
version | "x.y.z" | Sets a specific version number. |
| | |
status | "stable" | Set the status to stable. |
| "rc" | Set the status to rc. |
| "beta" | Set the status to beta. |
| "alpha" | Set the status to alpha. |
| | |
init | | Generates the appversion.json file. |
| | |
help | | Prints the commnds list. |
Usage example:
$ apv update minor
In app:
Function | |
---|
getAppVersion() | async |
getAppVersionSync() | sync |
compose() | async |
composeSync() | sync |
getAppVersion(callback)
Returns the content of appversion.json as a object.
This is the asyncronous version, so you must pass a callback to the function.
getAppVersionSync()
Returns the content of appversion.json as a object.
This is the syncronous version, so you don't need to pass a callback to the function.
composePattern(pattern, callback)
Return a string with the version following the pattern you passed as a input.
pattern:
- M : mayor
- m : minor
- p : patch
- s : status
- n : build number
- t : build total
- d : build Date
- c : commit
- . : separator
- - : separator
The pattern must be a string, for example a pattern could be
'M.m.p-s n-d'
.
This is the asyncronous version, so you must pass a callback to the function.
composePatternSync(pattern)
Return a string with the version following the pattern you passed as a input.
The pattern string follow the same rules as above.
This is the syncronous version, so you don't need to pass a callback to the function.
Sometimes you want to have the version/build number accessible in your application, for this, you can use the module with a standard import:
var av = require('appversion');
console.log(av.getAppVersionSync());
console.log(av.getAppVersionSync().version);
av.getAppVersion(function (err, data) {
console.log(data);
});
console.log(a.composePatternSync('M.m.p-s n-d'));
a.composePattern('M.m.p-s n-d', function(ptt) {
console.log(ptt);
});
import { getAppVersion, getAppVersionSync, composePattern, composePatternSync } from 'appversion';
console.log(getAppVersionSync());
console.log(getAppVersionSync().version);
getAppVersion(function (err, data) {
console.log(data);
});
console.log(composePatternSync('M.m.p-s n-d'));
composePattern('M.m.p-s n-d', function(ptt) {
console.log(ptt);
});
Automating
If you are using npm scripts you can easily integrate appversion in your workflow, below you can find an example of a package.json:
...
"scripts": {
"build": "apv update build && <build command>"
},
...
Contributing
If you feel you can help in any way, be it with examples, extra testing, or new features please open a pull request or open an issue.
License
The code is released under the GPLv2 license.
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 non infringement. 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.