useref

Parse build blocks in HTML files to replace references

Extracted from the grunt plugin grunt-useref.

Installation

``
npm install node-useref
`

Usage

`js
useref = require('node-useref')
var result = useref(inputHtml)
// result = [ replacedHtml, { type: { path: { 'assets': [ replacedFiles] }}} ]
`


Blocks are expressed as:

`html

... HTML Markup, list of script / link tags.

`

- type: either js, css or remove
- 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



















`

The module would be used with the above sample HTML as follows:

`js
var result = useref(sampleHtml)

// [
// resultHtml,
// {
// css: {
// 'css/combined.css': {
// 'assets': [ 'css/one.css', 'css/two.css' ]
// }
// },
// js: {
// 'scripts/combined.js': {
// 'assets': [ 'scripts/one.js', 'scripts/two.js' ]
// },
// 'scripts/async.js': {
// 'assets': [ 'scripts/three.js', 'scripts/four.js' ]
// }
// }
// }
// ]
`


The resulting HTML would be:

`html









`

IE Conditional Comments

Internet Explorer Conditional Comments are preserved. The code below:

`html



`

Results in:

`html

`

$3

Sometimes you need a bit more. If you would like to do custom processing, this is possible with a custom block, as demonstrated below.

`



`

With

`
useref = require('node-useref')
var result = useref(inputHtml, {
// each property corresponds to any blocks with the same name, e.g. "build:import"
import: function (content, target, options, alternateSearchPath) {
// do something with content and return the desired HTML to replace the block content
return content.replace('bower_components', target);
}
});
`

Becomes

`

``

The handler function gets the following arguments:

- content (String): The content of the custom use block
- target (String): The "path" value of the use block definition
- options (String): The extra attributes from the use block definition, the developer can parse as JSON or do whatever they want with it
- alternateSearchPath (String): The alternate search path that can be used to maintain a coherent interface with standard handlers

Include a handler for each custom block type.