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
argvyourself as the first argument (an array), or asoptions.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
|
|
| ignore1 | --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"2
|
| minor | --minor | Sets the option type for gulp-regex to "minor"2
|
| new-version | --new-version value -V value |
Gulp prints it's own version with --version, so this happened... |
| only1 | --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"2
|
| quiet | --quit | Flag to silence the summary. |
| summary3 | 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
typeorversionoptions - 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.
@futagoza/gulp-bump is Copyright (c) 2018+ Futago-za Ryuu
gulp-bump and gulp-regex are Copyright (c) 2015+ Steve Lacy