HTML include generator for static assets, e.g., foo.min.js => foo.min.js.html
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
test
.gitignore
.jshintrc
.travis.yml
LICENSE
README.md
index.js
package.json

README.md

gulp-html-include Build Status

HTML include generator for static assets, e.g., foo.min.js => foo.min.js.html

Usage

This plugin generates an HTML file with solely a script or link reference to JS or CSS files passed to it, respectively. It pairs well with gulp-rev and gulp-rename to make it easy to include dynamically named static files (e.g., via JSP include). Now you can enjoy versioned files without having to manually update the references to your generated files.

gulp.src( '/path/to/my/files' )
    .pipe( rev() )
    .pipe( include() )
    .pipe( rename(function ( dir, base, ext ) {
        return base.replace( /\-[^\.]+/, '' ) + ext;
    }))
    .pipe( gulp.dest( '/path/to/web/root' ) )

You can optionally pass in the path to prefix these files with (e.g., /static/) and the destination directory to set as the base for these files (e.g., ../../static/). The default path prefix is /, and the default destination directory is ./.

gulp.src( '/path/to/my/files' )
    .pipe( rev() )
    .pipe( include( { path: '/static/', dest: '../../static/' } ) )
    .pipe( rename(function ( dir, base, ext ) {
        return base.replace( /\-[^\.]+/, '' ) + ext;
    }))
    .pipe( gulp.dest( '../../static' ) )

By default this plugin does not use self-closing tags for the link reference. You can enable XHTML-compliant output by setting the xhtml option to true.

gulp.src( '/path/to/my/files' )
    .pipe( rev() )
    .pipe( include( { xhtml: true } ) )
    .pipe( rename(function ( dir, base, ext ) {
        return base.replace( /\-[^\.]+/, '' ) + ext;
    }))
    .pipe( gulp.dest( '/path/to/web/root' ) )

Testing

You can run the tests with Mocha by running npm run test in the project directory.

License

MIT © 2014 Recreational Equipment Inc.