refactor - switch to regex parsing

Author: stephenlacy

README.md

@@ -2,7 +2,7 @@
 [![Build Status](https://travis-ci.org/stevelacy/gulp-bump.png?branch=master)](https://travis-ci.org/stevelacy/gulp-bump)
 [![NPM version](https://badge.fury.io/js/gulp-bump.png)](http://badge.fury.io/js/gulp-bump)
 
-> Bump any JSON file which supports [semver](http://semver.org/) versioning
+> Bump any version in any file which supports [semver](http://semver.org/) versioning
 
 ## Information
 
@@ -12,7 +12,7 @@
 </tr>
 <tr>
 <td>Description</td>
-<td>Bump any Semver version json file
+<td>Bump any Semver version in any file
  with gulp (gulpjs.com)</td>
 </tr>
 <tr>
@@ -34,6 +34,9 @@ If you are just requiring a bump for npm, consider using [npm version](https://d
 ```bash
 $ npm install gulp-bump --save
 ```
+#### Breaking changes
+
+`gulp-bump` v2 supports Any valid semver in any filetype
 
 ## Example
 
@@ -60,7 +63,7 @@ gulp.task('bump', function(){
 // Defined method of updating:
 // Semantic major
 gulp.task('bump', function(){
-  gulp.src('./bower.json')
+  gulp.src('./package.yml')
   .pipe(bump({type:'major'}))
   .pipe(gulp.dest('./'));
 });
@@ -80,14 +83,6 @@ gulp.task('bump', function(){
   .pipe(gulp.dest('./'));
 });
 
-// Override the tab size for indenting
-// (or simply omit to keep the current formatting)
-gulp.task('bump', function(){
-  gulp.src('./package.json')
-  .pipe(bump({type:'major', indent: 4 }))
-  .pipe(gulp.dest('./'));
-});
-
 // Define the key for versioning off
 gulp.task('bump', function(){
   gulp.src('./package.json')
@@ -138,79 +133,8 @@ gulp.task('default', function(){
 ####You can view more examples in the [example folder.](https://github.com/stevelacy/gulp-bump/tree/master/examples)
 
 ## Options
-### options.type
-Semver version type to bump.
-
-    Type: `String`
-    Default: `patch`
-    Valid values: `major|minor|patch|prerelease`
-
-Example:
-
-```js
-.pipe(bump({type: 'Major'})
-.pipe(bump()) //--> defaults to patch
-```
-
-### options.key
-Set the versioning key
-
-    Type: `String`
-    Default: `version`
-
-Example:
 
-```js
-.pipe(bump({key: 'appversion'}))
-.pipe(bump({key: 'build-version'}))
-.pipe(bump({key: 'dev-version', type: 'major'}))
-```
-##### Dot notation is supported for nested versions:
-
-```js
-
-.pipe(bump({key: {'sublevel.version'}}))
-
-/*
-{
-  "sublevel": {
-    "version": "<semver>"
-  }
-}
-*/
-```
-
-### options.version
-Set a specific version to bump to.
-
-    Type: `String`
-    Default: `null`
-
-Example:
-
-```js
-.pipe(bump({version: '1.2.3'}))
-.pipe(bump({version: '1.0.0-alpha'}))
-```
-
-### options.indent
-Set the amount of spaces for indentation in the result JSON file.
-
-    Type: `Number`
-    Default: Same as original source file
-
-### options.preid
-Set the prerelase tag to use
-
-    Type: `String`
-    Default: `null`
-
-Example:
-
-```js
-bump({type: 'prerelease', preid : 'alphaWhateverTheYWant'});
- // => '0.0.2-alphaWhateverTheYWant.0'
-```
+All options are passed to [bump-regex](https://github.com/stevelacy/bump-regex)
 
 ## Versioning
 #### Versioning Used: [Semantic](http://semver.org/)

index.js

@@ -4,109 +4,34 @@ var path = require('path');
 var pluginError = require('plugin-error');
 var log = require('plugin-log');
 var through = require('through2');
+var bump = require('bump-regex');
 var semver = require('semver');
-var Dot = require('dot-object');
+
+const PLUGIN_NAME = 'gulp-bump';
 
 module.exports = function(opts) {
-  // set task options
-  opts = setDefaultOptions(opts);
+
+  opts = opts || {};
+  if (!opts.type || !semver.inc('0.0.1', opts.type)) {
+    opts.type = 'patch';
+  }
 
   return through.obj(function(file, enc, cb) {
 
     if (file.isNull()) {
       return cb(null, file);
     }
     if (file.isStream()) {
-      return cb(new pluginError('gulp-bump', 'Streaming not supported'));
-    }
-
-    var content = String(file.contents);
-    var json;
-    var ver;
-    var dot;
-
-    try {
-      json = JSON.parse(content);
-    } catch (e) {
-      return cb(new pluginError('gulp-bump', 'Problem parsing JSON file', {
-        fileName: file.path,
-        showStack: true
-      }));
+      return cb(new pluginError(PLUGIN_NAME, 'Streaming not supported'));
     }
 
-    // get the version and key
-    if (opts.key.indexOf('.') > -1) {
-      dot = new Dot();
-      opts.value = dot.pick(opts.key, json);
-      ver = bump(opts);
-    }
-    else {
-      opts.value = json[opts.key];
-      if (!semver.valid(opts.value) && !opts.version) {
-        return cb(new pluginError('gulp-bump', 'Detected invalid semver ' + opts.key, {
-          fileName: file.path,
-          showStack: false
-        }));
+    opts.str = String(file.contents);
+    bump(opts, function(err, res) {
+      if (err) {
+        return cb(new pluginError(PLUGIN_NAME, err));
       }
-      ver = bump(opts);
-    }
-
-    // set key
-    if (!json[opts.key]) {
-      // log to user that key didn't exist before
-      log('Creating key', log.colors.red(opts.key), 'with version:', log.colors.cyan(ver));
-    }
-
-    if (dot) {
-      dot.str(opts.key, ver, json);
-    }
-
-    else {
-      json[opts.key] = ver;
-    }
-
-    file.contents = new Buffer(JSON.stringify(json, null, opts.indent || space(content)) + possibleNewline(content));
-
-    log('Bumped \'' + log.colors.cyan(path.basename(file.path)) +
-      '\' ' + log.colors.magenta(opts.key) +
-      ' to: ' + log.colors.cyan(ver));
-
-    cb(null, file);
+      file.contents = new Buffer(res);
+      cb(null, file);
+    });
   });
 };
-
-function bump(opts) {
-  if (opts.version) {
-    return opts.version;
-  }
-
-  return semver.inc(opts.value, opts.type, opts.preid);
-}
-
-function setDefaultOptions(opts) {
-  opts = opts || {};
-  opts.key = opts.key || 'version';
-  opts.indent = opts.indent || void 0;
-  // default type bump is patch
-  if (!opts.type || !semver.inc('0.0.1', opts.type)) {
-    opts.type = 'patch';
-  }
-  // if passed specific version - validate it
-  if (opts.version && !semver.valid(opts.version, opts.type)) {
-    log('invalid version used as option', log.colors.red(opts.version));
-    opts.version = null;
-  }
-  return opts;
-}
-
-// Preserve new line at the end of a file
-function possibleNewline(json) {
-  var lastChar = (json.slice(-1) === '\n') ? '\n' : '';
-  return lastChar;
-}
-
-// Figured out which "space" params to be used for JSON.stringfiy.
-function space(json) {
-  var match = json.match(/^(?:(\t+)|( +))"/m);
-  return match ? (match[1] ? '\t' : match[2].length) : '';
-}

package.json

@@ -7,11 +7,11 @@
   "author": "Steve Lacy <[email protected]> (http://slacy.me)",
   "main": "./index.js",
   "dependencies": {
-    "dot-object": "^1.2.0",
     "plugin-error": "^0.1.2",
     "plugin-log": "^0.1.0",
     "semver": "^5.0.3",
-    "through2": "^0.5.1"
+    "through2": "^0.5.1",
+    "bump-regex": "^1.0.0"
   },
   "devDependencies": {
     "mocha": "*",