html-script-hook


About

Calls a callback function with the code for each


This is a test.

`

Run the parser on test.html:

` javascript
var fs = require("fs");
var testParser = require("html-script-hook");

var html = fs.readFileSync("test.html", {
encoding: "utf8"
});

// callback receives code from


This is a test.

`

Usage With Istanbul

As a bit more of a real world example, here's how to instrument a HTML file for Istanbul code coverage:

` javascript
var istanbul = require('istanbul');
var scriptHook = require('html-script-hook');
var fs = require("fs");

// create a new Istanbul instrumenter
var instrumenter = new istanbul.Instrumenter();

// read in a HTML file
var html = fs.readFileSync(htmlFilePath, 'utf8');
// parse the HTML file and replace it with a HTML file where the code has been instrumented
// (using the gotScript() callback)
html = scriptHook (html, {scriptCallback: gotScript});

// catch the code in the script section
function gotScript(code, loc) {
// replace the existing code with instrumented code
return instrumenter.instrumentSync(code, htmlFilePath);
}
`

For the complete example, see the example code from web-component-tester-istanbul, which instruments the files on the server as the files are being requested by the browser.

Options

The parser that is returned by require('html-script-hook') takes the following arguments:
* parser (html, options)
* html[required] : the string containing the HTML file
* options [optional] : an object with the configuration options for the parser. Those options include the following properties:
* scriptCallback (code, details) [function, default=undefined] : if defined, this function will be called with the code from inside each tag, and a unexpectedEof flag that indicates that the scriptCallback was called even though a final tag wasn't found.
* padLineNo [boolean, default=true] : whether the JavaScript passed to the script callback should start with a number of newlines ("\n") so that it matches the line numbers of the code in the HTML file. Useful for making sure that tools that pick up line numbers use the same line numbers.
* htmlCallback (html) [function, default=undefined] : if defined, this function will be called with a single argument that is the final HTML with any modified JavaScript. It is the exact same as the return value from parser and rather silly, since the parser is synchronous.

The parser returns the HTML that was modified by scriptCallback`.

Tests

npm test