@futagoza/gulp-bump

This package is included with @futagoza/gulp

Will bump the version field of any file passed to it from Gulp.

example

const gulp = require( "gulp" );
const bump = require( "@futagoza/gulp-bump" );
const pump = require( "pump" );

// Bump the "version" field of every `package.json` in the packages directory
gulp.task( "bump", () => pump(

    gulp.src( "packages/**/package.json" ),
    bump( /* [ argv = process.argv, options = {} ] */ ),
    gulp.dest( "packages/" )

) );

cli usage

This module was created to always read the CLI arguments passed to the current Gulp task. It takes the arguments from the command line interface, processes them before finally passing them to gulp-regex. You can also programmatically pass default options.

Optionally you can pass the argv yourself as the first argument (an array), or as options.argv

options

As well as the options from gulp-regex, you can use the following:

api option	cli option	description
argv		Used if no `argv` argument was provided; otherwise defaults to `process.argv`
ignore₁	--ignore	Inverts the job of only, bumping every file but those that match the pattern
major	--major	Sets the option `type` for gulp-regex to `"major"`₂
minor	--minor	Sets the option `type` for gulp-regex to `"minor"`₂
new-version	--new-version value -V value	Gulp prints it's own version with `--version`, so this happened...
only₁	--only pattern	Only bump files with the property name that match pattern (a RegExp string)
patch	--patch	Sets the option `type` for gulp-regex to `"patch"`₂
quiet	--quit	Flag to silence the summary.
summary₃		A callback that by default prints the summary to the console.
tag	--tag, --keepmetadata	Flag that enables the `keepmetadata` option for gulp-regex.

This has only implemented for and tested on JSON files
Only used if there's no type or version options
Has a call signature of (filename: string, results: {}) => void

license

This module was originally a wrapper around gulp-bump until v0.4; at which point because I needed a way to change the summary, I copy-pasted the code and it's dependencies, as well as updating the code for Node 6+ and adding what I needed; so now it's a direct wrapper around gulp-regex instead.