Process html files at build time to modify them depending on the release environment
npm install grunt-processhtml
> Process html files at build time to modify them depending on the release environment
^1.0.1If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
``shell`
npm install grunt-processhtml --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
`js`
grunt.loadNpmTasks('grunt-processhtml');
Process html files with special comments:
`html`
...
##### type
This is required.
Types: js, css, remove, template, include or any html attribute if written like this: [href], [src], etc.
##### target
This is optional.
Is the target name of your grunt task, for example: dist. Is supported for all types, so you can always specify the target if needed.
You can pass multiple comma-separated targets, e.g. and block will be parsed for each.
##### inline
This modifier can be used with js and css types.
If used, the styles or scripts will be included in the output html file.
##### value
Required for types: js, css, include and [attr].
Optional for types: remove, template, js and css types with inline modifier.
Could be a file name: script.min.js or a path if an attribute like [src] is specified to keep the original file name intact but replace its path.
##### build:js[:targets] [inline]
Replace many script tags into one.
[:targets] Optional build targets.
inline Optional modifier.
Required value: A file path.
`html
`
You can embed your javascript:
`html
`
or
`html
`
##### build:css[:targets] [inline]
Replace many stylesheet link tags into one.
[:targets] Optional build targets.
inline Optional modifier.
Required value: A file path.
`html
`
You can embed your styles like with js type above:
`html
`
or
`html
`
##### build:<[attr]>[:targets]
Change the value of an attribute. In most cases using [src] and [href] will be enough but it works with any html attribute.
<[attr]> Required html attribute, i.e. [src], [href].
[:targets] Optional build targets.
Required value: A path, a file path or any string value
`html
`
##### build:include[:targets]
Include an external file.
[:targets] Optional build targets.
Required value: A file path.
`html
This will be replaced by the content of header.html
This will be replaced by the content of dev/content.html
This will be replaced by the content of dist/content.html
`
##### build:template[:targets]
Process a template block with a data object inside options.data.
[:targets] Optional build targets.
`html
`
##### build:remove[:targets]
Remove a block.
[:targets] Optional build targets
` This will be removed when any processhtml target is donehtml
But this one only when doing processhtml:dist target
$3
In your project's Gruntfile, add a section named to the data object passed into grunt.initConfig().`js
grunt.initConfig({
processhtml: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
})
`$3
#### options.process
Type:
Default value: Process the entire
file through grunt.template.process, a default object with the build target will be passed to the
template in the form of {environment: target} where environment will be the build target of the grunt task.*Important note: The
process option is not needed if you don't want to process the entire html file. See the example
below to see that you can have templates blocks to be processed.*If you do want to process the whole file as a template, it will be compiled after compiling the inside template blocks
if any.
#### options.environment
Type:
Object
Default value: The environemnt variable will be available to use in the comments, it defaults to the task target.
#### options.data
Type:
Default value: An object
that is passed to the html file used to compile all template blocks and the entire file if process
is true.#### options.templateSettings
Type:
Default value: (Will use default lodash template delimiters <% and %>)Define the
templateSettings option with lodash templateSettings options to customize the
template syntax.`javascript
templateSettings: {
interpolate: /{{([\s\S]+?)}}/g // mustache
}
`#### options.includeBase
Type:
Default value: (Will use the path of the including file)Specify an optional path to look for include files. ie,
app/assets/includes/#### options.commentMarker
Type:
Default value: Specify the word used to indicate the special begin/end comments. This is useful if you want to use this plugin
in conjunction with other plugins that use a similar, conflicting
comment
(such as grunt-usemin).With
options.commentMarker set to process, a typical comment would look like:`html
...
`#### options.strip
Type:
Default value: Specifying
will strip comments which do not match the current target:`javascript
strip: true
`#### options.recursive
Type:
Default value: Recursively process files that are being included using
.`javascript
recursive: true
`#### options.customBlockTypes
Type:
Default value: Define an array of
files that define custom block types.`javascript
customBlockTypes: ['custom-blocktype.js']
`A custom block type example:
js
'use strict';module.exports = function (processor) {
// This will allow to use this syntax
processor.registerBlockType('customBlock', function (content, block, blockLine, blockContent) {
var title = '
' + block.asset + '
';
var result = content.replace(blockLine, title); return result;
});
};
`html
This will be replaced with the result of the custom block above
`The result will be
html
myValue
`
$3
#### Default Options
Set the task in your grunt file which is going to process the
file and save the output to
dest/index.htmljs
grunt.initConfig({
processhtml: {
options: {
data: {
message: 'Hello world!'
}
},
dist: {
files: {
'dest/index.html': ['index.html']
}
}
}
});
`#### What will be processed?
Following the previous task configuration, the
could look like this:`html
title
This will be replaced by the content of header.html
This is the html file without being processed
`After processing this file, the output will be:
html
title
Content from header.html
Hello world!
`#### Advanced example
In this example there are multiple targets where we can process the html file depending on which target is being run.
js
grunt.initConfig({
processhtml: {
dev: {
options: {
data: {
message: 'This is development environment'
}
},
files: {
'dev/index.html': ['index.html']
}
},
dist: {
options: {
process: true,
data: {
title: 'My app',
message: 'This is production distribution'
}
},
files: {
'dest/index.html': ['index.html']
}
},
custom: {
options: {
templateSettings: {
interpolate: /{{([\s\S]+?)}}/g // mustache
},
data: {
message: 'This has custom template delimiters'
}
},
files: {
'custom/custom.html': ['custom.html']
}
}
}
});
`The
to be processed (the custom.html is below):`html
<%= title %>
This is the html file without being processed
`The
to be processed:`html
Custom template delimiters example
`Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.Release History
- 0.4.1 node-htmlprocessor@0.2.4
- 0.4.0 Update Grunt to 1.0
- 0.3.13 node-htmlprocessor@0.2.3 and clone data object (#85)
- 0.3.12 Update node-htmlprocessor to version 0.2.2 (escape regex from remove)
- 0.3.11 get ready for grunt v1.0.0
- 0.3.10 Update node-htmlprocessor to version 0.2.1
- 0.3.9 Update node-htmlprocessor to version 0.2.0
- 0.3.8 Fix #74
- 0.3.7 Update node-htmlprocessor dependency with added modifier
- 0.3.6 Update node-htmlprocessor version and add specific test for templates
- 0.3.5 Fixes issue when passing data to a template
- 0.3.4 Fixes issue when passing a path te replace an
- 0.3.3 Add node-htmlprocessor as a dependency
- 0.3.2 Fix/feature #39
- 0.3.1 Fix #35
- 0.3.0 Allow creating custom block types.
- 0.2.9 Added option
- 0.2.8 Changed include to not use replace()
- 0.2.7 Added option
- 0.2.6 Fix #14 and added grunt-release
- 0.2.5 Create first tag using grunt-release
- 0.2.3 Fix #8
- 0.2.2 Small code refactor
- 0.2.1 Added templateSettings option tu customize template delimiters
- 0.2.0 Added the build:include` feature to include any external file