# html-script-hook > For each local HTML script tag, calls a function with the code inside the tag and replaces the code with the return value Latest version **1.0.0** (published 2017-01-31) · MIT license · 0 weekly downloads ## Install ```sh npm install html-script-hook pnpm add html-script-hook yarn add html-script-hook bun add html-script-hook ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.0 | | Published | 2017-01-31 | | First published | 2015-09-07 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 1 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 4 | | Author | Adam Powers | | Maintainers | apowers313 | | Keywords | HTML, JavaScript, Code, Coverage, Analysis, Documentation | ## Links - npm: https://www.npmjs.com/package/html-script-hook - Repository: https://github.com/apowers313/html-script-hook - Homepage: https://github.com/apowers313/html-script-hook#readme - Issues: https://github.com/apowers313/html-script-hook/issues - npm.io page: https://npm.io/package/html-script-hook ## Dependencies (1) - [pegjs](https://npm.io/package/pegjs.md) ^0.9.0 ## Alternatives - [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads - [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads - [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads - [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads - [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads ## Recent versions - 1.0.0 (latest) — 2017-01-31 - 0.10.0 — 2015-09-20 - 0.9.1 — 2015-09-08 - 0.9.0 — 2015-09-08 - 0.7.0 — 2015-09-07 ## README # html-script-hook [![Build Status](https://travis-ci.org/apowers313/html-script-hook.svg?branch=master)](https://travis-ci.org/apowers313/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](https://github.com/thedeeno/web-component-tester-istanbul/pull/14) from [web-component-tester-istanbul](https://github.com/thedeeno/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 --- _Source: https://npm.io/package/html-script-hook · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._