Replace build blocks in HTML. Like useref but done right.
Install:
npm install --save-dev gulp-html-replace
Put some blocks in your HTML file:
<!-- build:<name> -->
Everything here will be replaced
<!-- endbuild -->
name
is the name of the block. Could consist of letters, digits, underscore ( _ ) and hyphen ( - ) symbols.
Type: Object
{task-name: replacement}
- task-name - The name of the block in your HTML.
- replacement -
String|Array|Object
The replacement. See examples below.
// Options is a single string
htmlreplace({js: 'js/main.js'})
// Options is an array of strings
htmlreplace({js: ['js/monster.js', 'js/hero.js']})
If your options strings ends with
.js
or.css
they will be replaced by correct script/style tags, so you don't need to specify a template like in the example below.
// Options is an object
htmlreplace({
js: {
src: 'img/avatar.png',
tpl: '<img src="%s" align="left" />'
}
})
// Multiple tag replacement
htmlreplace({
js: {
src: [['data-main.js', 'require-src.js']],
tpl: '<script data-main="%s" src="%s"></script>'
}
})
- src -
String|Array
Same thing as in simple example. - tpl -
String
Template string. Uses util.format() internally.
In the first example
%s
will be replaced withimg/avatar.png
producing<img src="img/avatar.png" align="left">
as the result.
In the second example
data-main="%s"
andsrc="%s"
will be replaced withdata-main.js
andrequire-src.js
accordingly, producing<script data-main="data-main.js" src="require-src.js"></script>
as the result
Type: object
All false
by default.
- {Boolean} keepUnassigned - Whether to keep blocks with unused names or remove them.
- {Boolean} keepBlockTags - Whether to keep
<!-- build -->
and<!-- endbuild -->
comments or remove them. - {Boolean} resolvePaths - Try to resolve relative paths. For example if your
cwd
is/
, your html file is/page/index.html
and you set replacement aslib/file.js
the result path in that html will be../lib/file.js
index.html:
<!DOCTYPE html>
<html>
<head>
<!-- build:css -->
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/main.css">
<!-- endbuild -->
</head>
<body>
<!-- build:js -->
<script src="js/player.js"></script>
<script src="js/monster.js"></script>
<script src="js/world.js"></script>
<!-- endbuild -->
gulpfile.js:
var gulp = require('gulp');
var htmlreplace = require('gulp-html-replace');
gulp.task('default', function() {
gulp.src('index.html')
.pipe(htmlreplace({
'css': 'styles.min.css',
'js': 'js/bundle.min.js'
}))
.pipe(gulp.dest('build/'));
});
Result:
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" href="styles.min.css">
</head>
<body>
<script src="js/bundle.min.js"></script>
This version introduces streaming support, less confusing API, new option keepUnused and full code overhaul.
- If you used single task like this:
htmlreplace('js', 'script.js')
just change it tohtmlreplace({js: 'script.js'})
- If you used single task with template:
htmlreplace('js', 'script.js', '<script="%s">')
change it tohtmlreplace({js: {src: 'script.js', tpl: '<script="%s">'})
files
renamed tosrc
, see previous example. Rename if needed.
This version switches to the new way of specifying options which is more future-proof. Before it was
htmlreplace(tasks, keepUnassigned = false)
, now it'shtmlreplace(tasks, {keepUnassigned: false})
. No action required, old syntax will still work, but it is advisable to switch to the new syntax.