gulp-useref-plus
v0.0.8
Published
Parse build blocks in HTML files to replace references to non-optimized scripts or stylesheets.
Downloads
2,253
Maintainers
hexReadme
gulp-useref-plus
Install
Install with npm
npm install --save-dev gulp-useref-plusUsage
The following example will parse the build blocks in the HTML, replace them and pass those files through. Assets inside the build blocks will be concatenated and passed through in a stream as well.
var gulp = require('gulp'),
useref = require('gulp-useref-plus');
gulp.task('default', function () {
return gulp.src('app/*.html')
.pipe(useref())
.pipe(gulp.dest('dist'));
});With options:
var gulp = require('gulp'),
useref = require('gulp-useref-plus');
gulp.task('default', function () {
return gulp.src('app/*.html')
.pipe(useref({ searchPath: '.tmp' }))
.pipe(gulp.dest('dist'));
});If you want to minify your assets or perform some other modification, you can use gulp-if to conditionally handle specific types of assets.
var gulp = require('gulp'),
useref = require('gulp-useref-plus'),
gulpif = require('gulp-if'),
uglify = require('gulp-uglify'),
minifyCss = require('gulp-minify-css');
gulp.task('html', function () {
return gulp.src('app/*.html')
.pipe(useref())
.pipe(gulpif('*.js', uglify()))
.pipe(gulpif('*.css', minifyCss()))
.pipe(gulp.dest('dist'));
});Blocks are expressed as:
<!-- build:<type>(alternate search path) <path> <parameters> -->
... HTML Markup, list of script / link tags.
<!-- endbuild -->- type: either
js,cssorremove;removewill remove the build block entirely without generating a file - alternate search path: (optional) By default the input files are relative to the treated file. Alternate search path allows one to change that
- path: the file path of the optimized file, the target output
- parameters: extra parameters that should be added to the tag
An example of this in completed form can be seen below:
<html>
<head>
<!-- build:css css/combined.css -->
<link href="css/one.css" rel="stylesheet">
<link href="css/two.css" rel="stylesheet">
<!-- endbuild -->
</head>
<body>
<!-- build:js scripts/combined.js -->
<script type="text/javascript" src="scripts/one.js"></script>
<script type="text/javascript" src="scripts/two.js"></script>
<!-- endbuild -->
</body>
</html>The resulting HTML would be:
<html>
<head>
<link rel="stylesheet" href="css/combined.css"/>
</head>
<body>
<script src="scripts/combined.js"></script>
</body>
</html>See useref for more information.
API
useref(options [, transformStream1 [, transformStream2 [, ... ]]])
Returns a stream with the asset replaced resulting HTML files as well as the concatenated asset files from the build blocks inside the HTML. Supports all options from useref.
Transform Streams
Type: Stream
Default: none
Transform assets before concat. For example, to integrate source maps:
var gulp = require('gulp'),
sourcemaps = require('gulp-sourcemaps'),
useref = require('gulp-useref-plus'),
lazypipe = require('lazypipe');
gulp.task('default', function () {
return gulp.src('index.html')
.pipe(useref({}, lazypipe().pipe(sourcemaps.init, { loadMaps: true })()))
.pipe(sourcemaps.write('maps'))
.pipe(gulp.dest('dist'));
});Options
options.searchPath
Type: String or Array
Default: none
Specify the location to search for asset files, relative to the current working directory. Can be a string or array of strings.
options.base
Type: String
Default: process.cwd()
Specify the output folder relative to the cwd.
options.noAssets
Type: Boolean
Default: false
Skip assets and only process the HTML files.
options.noconcat
Type: Boolean
Default: false
Skip concatenation and add all assets to the stream instead.
options.additionalStreams
Type: Array<Stream>
Default: none
Use additional streams as sources of assets. Useful for combining gulp-useref-plus with preprocessing tools. For example, to use with TypeScript:
var ts = require('gulp-typescript');
// create stream of virtual files
var tsStream = gulp.src('src/**/*.ts')
.pipe(ts());
gulp.task('default', function () {
// use gulp-useref-plus normally
return gulp.src('src/index.html')
.pipe(useref({ additionalStreams: [tsStream] }))
.pipe(gulp.dest('dist'));
});options.transformPath
Type: Function
Default: none
Add a transformPath function in case the path needs to be modified before search happens.
var gulp = require('gulp'),
useref = require('gulp-useref-plus');
gulp.task('default', function () {
return gulp.src('app/*.html')
.pipe(useref({
transformPath: function(filePath) {
return filePath.replace('/rootpath','')
}
}))
.pipe(gulp.dest('dist'));
});Notes
- ClosureCompiler.js doesn't support Buffers, which means if you want to use gulp-closure-compiler you'll have to first write out the
combined.jsto disk. See this for more information.