Skip to content

warhog/gulp-inject-version2

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 

Repository files navigation

gulp-inject-version2

fork from https://github.com/dvinciinteractive/gulp-inject-version and https://github.com/dvinciinteractive/gulp-inject-version to fix dependency on deprecated gulp-util

Gulp plugin for reading a version number out of a JSON file and injecting it into text based files.

By default, this plugin will read the version property from your project's package.json. It will then search the content of all files in the stream for the text %%GULP_INJECT_VERSION%% and replace that text with vX.Y.Z (where X.Y.Z is the version number it read from package.json).

installation

npm install gulp-inject-version2

usage

var injectVersion2 = require('gulp-inject-version2');

gulp.task('build', function () {
    return gulp.src('src/index.html')
        .pipe(injectVersion2())
        // whatever else you want to do to index.html...
        .pipe(gulp.dest('dist'));
});

In this usage example, if src/index.html contained the html

<div class="footer">My Project %%GULP_INJECT_VERSION%%</div>

and the version property in your project's package.json was set to '1.0.3', then after running you'd find that dist/index.html now contains the replacement text:

<div class="footer">My Project v1.0.3</div>

options

An options object can be passed into the plugin like so:

var injectVersion2 = require('gulp-inject-version2');

gulp.task('build', function () {
    return gulp.src('src/index.html')
        .pipe(injectVersion2({
            package_file: 'bower.json',
            // your other option overrides here
        }))
        // whatever else you want to do to index.html...
        .pipe(gulp.dest('dist'));
});

Option properties that you can override are:

Option property type description default value
package_file string The JSON containing file from which we should read the version 'package.json'
version_property string The name of the property that holds the version text within the JSON file 'version'
prepend string A string to prepend to the outputted version text 'v'
append string A string to append to the outputted version text ''
replace string The text or pattern to be sought out and replaced with the version text in the source files /%%GULP_INJECT_VERSION%%/g

About

Inject a package version into text based files

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%