appversion - npm Package Compare versions

Comparing version 1.5.2 to 1.6.0

appversion.default.json

@@ -18,3 +18,3 @@ {
   "config": {
-    "appversion": "1.5.2",
+    "appversion": "1.6.0",
     "markdown": [],
@@ -21,0 +21,0 @@ "json": [],

appversion.js

 /*
  * Project: appversion
- * Version: 1.5.2
+ * Version: 1.6.0
  * Author: delvedor
@@ -12,2 +12,3 @@ * Twitter: @delvedor
 
+// Modules
 const fs = require('fs')
@@ -17,2 +18,3 @@ const join = require('path').join
 const check = require('type-check').typeCheck
+// apv parameters and functions
 const JSON_FILE = 'appversion.json'
@@ -19,0 +21,0 @@

appversion.json

 {
   "version": {
     "major": 1,
-    "minor": 5,
-    "patch": 2
+    "minor": 6,
+    "patch": 0
   },
@@ -18,3 +18,3 @@ "status": {
   "config": {
-    "appversion": "1.5.2",
+    "appversion": "1.6.0",
     "markdown": [
@@ -21,0 +21,0 @@ "README.md"

apv.js

@@ -5,3 +5,3 @@ #! /usr/bin/env node
  * Project: appversion
- * Version: 1.5.2
+ * Version: 1.6.0
  * Author: delvedor
@@ -8,0 +8,0 @@ * Twitter: @delvedor

CHANGELOG.md

 # Changelog
 
+## v1.6.0
+- Added automation functionality
+
 ## v1.5.2
@@ -4,0 +7,0 @@ - Reimplemented argv management with minimist

lib/parameters.js

@@ -6,4 +6,4 @@ 'use strict'
 // apv parameters and functions
-exports.apvVersion = '1.5.2'
+exports.apvVersion = '1.6.0'
 exports.JSON_FILE = 'appversion.json'
 exports.JSON_FILE_DEFAULT = resolve(__dirname, '../', 'appversion.default.json')

package.json

 {
   "name": "appversion",
-  "version": "1.5.2",
+  "version": "1.6.0",
   "description": "AppVersion is a CLI tool whose purpose is to provide a unique manager of the version of you application.",
@@ -5,0 +5,0 @@ "main": "appversion.js",

README.md

 # AppVersion <a name="version"></a><a name="status"></a>
-[![AppVersion-version](https://img.shields.io/badge/AppVersion-1.5.2-brightgreen.svg?style=flat)](https://github.com/delvedor/appversion?#version) [![AppVersion-status](https://img.shields.io/badge/Status-RC-brightgreen.svg?style=flat)](https://github.com/delvedor/appversion?#status) [![Build Status](https://travis-ci.org/delvedor/appversion.svg?branch=master)](https://travis-ci.org/delvedor/appversion) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)
+[![AppVersion-version](https://img.shields.io/badge/AppVersion-1.6.0-brightgreen.svg?style=flat)](https://github.com/delvedor/appversion?#version) [![AppVersion-status](https://img.shields.io/badge/Status-RC-brightgreen.svg?style=flat)](https://github.com/delvedor/appversion?#status) [![Build Status](https://travis-ci.org/delvedor/appversion.svg?branch=master)](https://travis-ci.org/delvedor/appversion) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)
 
@@ -8,3 +8,3 @@ **AppVersion** is a CLI tool whose purpose is to provide a **unique manager** of the version of you application.
 
-AppVersion interacts with **NPM**, when you update the version using the AppVersion CLI tool, it updates automatically the *package.json* as well, and you can use the CLI commands inside your **NPM scripts**.  
+AppVersion interacts with **NPM**, when you update the version using the AppVersion CLI tool, it updates automatically the *package.json* as well, and you can use the CLI commands inside your **NPM scripts**. See <a href="#automation">here</a> for more info about automation.  
 Furthermore AppVersion works well with **Git**, indeed you can add a Tag with the current version of your application to the repository and you can add one badge with the version and one badge with the status of your application to the *README.md*.  
@@ -199,4 +199,4 @@ AppVersion also provides easy to use APIs to access your version, build, status and commit from your application.
 ```
-
-## Automating
+<a name="automation"></a>
+## Automation
 If you are using *npm scripts* you can easily integrate AppVersion in your workflow, below you can find an example of a package.json:
@@ -210,2 +210,16 @@ ```json
 ```
+If you are using Grunt or Gulp for automating your project, you can easily use AppVersion inside you grunt/gulp file.
+Just require **appversion/automation** and call the `update|setVersion|setStatus` method with the correct parameter.  
+Below you can find an example:
+```javascript
+const apv = require('appversion/automation')
+...
+apv.update('minor')
+...
+apv.setVersion('1.4.2')
+...
+apv.setStatus('Beta.2')
+...
+
+```
 ## TODO
@@ -219,4 +233,4 @@ - [x] Update status number
 - [x] When init is called, apv must create appversion.json with the same version number of package.json.
+- [x] Integration with Grunt/Gulp
 - [ ] SHA generator
-- [ ] Integration with Grunt/Gulp
 
@@ -223,0 +237,0 @@ ## Build

test.js

 /*
  * Project: appversion
- * Version: 1.5.2
+ * Version: 1.6.0
  * Author: delvedor
@@ -5,0 +5,0 @@ * Twitter: @delvedor

No alert changes

Improved metrics

Total package byte prevSize

47421

increased by2.09%

Number of package files

22

increased by4.76%

Lines of code

880

increased by1.97%

Number of lines in readme file

255

increased by5.81%

No dependency changes