Skip to content

feat: Support for injecting resource hints in generated HTML by placeholder #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: Support for injecting resource hints in generated HTML by placeholder #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,11 @@ On final bundle generation the provided template file will have a `script` tag i
- `replaceVars`: An object containing variables that will be replaced in the generated html.
Example: `replaceVars: { '__CDN_URL__': process.env.NODE_ENV === 'production' ? 'https://mycdn.com' : '' }` will replace all instances of `__CDN_URL__` with `http://mycdn.com` if the environment is production


### Resource hints

You can indicate a desired location to inject preload/prefetch resource hints for the bundled files with the placeholder `#{resource_hints}#`.

## License

MIT
10 changes: 10 additions & 0 deletions __tests__/fixtures/template_resource_hints.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<html>
<head>
<meta name="something">
#{resource_hints}#
<title>Resource hints</title>
</head>
<body>
<h1>Hello World.</h1>
</body>
</html>
36 changes: 36 additions & 0 deletions __tests__/tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,3 +411,39 @@ it("should add any css files to the head of the template", async () => {
getHtmlString("bundle.js", "", [], [], "CSS Injection Test", ["bundle.css"])
);
});

it("should add inject resource hints at the specified location", async () => {
const BUNDLE_PATH = path.join(TEST_DIR, "bundle.js");
const TEMPLATE_PATH = path.join(TEST_DIR, "template_resource_hints.html");

const input = {
input: `${__dirname}/fixtures/index.js`,
plugins: [
htmlTemplate({
template: `${__dirname}/fixtures/template_resource_hints.html`,
}),
],
};
const output = {
file: BUNDLE_PATH,
format: "iife",
name: "test",
};
const bundle = await rollup(input);
await bundle.write(output);

// Ensure files exist
await expect(fs.pathExists(BUNDLE_PATH)).resolves.toEqual(true);
await expect(fs.pathExists(TEMPLATE_PATH)).resolves.toEqual(true);

// Ensure output has bundle injected
const generatedTemplate = await fs.readFile(TEMPLATE_PATH, "utf8");
const resourceHintsLocation = `<head>
<meta name="something">
<link rel="preload" as="script" href="bundle.js">
<title>Resource hints</title>
</head>`.replace(/[\s]/gi, "");
expect(generatedTemplate.replace(/[\s]/gi, "")).toContain(
resourceHintsLocation
);
});
104 changes: 58 additions & 46 deletions coverage/clover.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,55 +1,67 @@
<?xml version="1.0" encoding="UTF-8"?>
<coverage generated="1592734915356" clover="3.2.0">
<project timestamp="1592734915356" name="All files">
<metrics statements="46" coveredstatements="46" conditionals="30" coveredconditionals="28" methods="10" coveredmethods="10" elements="86" coveredelements="84" complexity="0" loc="46" ncloc="46" packages="1" files="1" classes="1"/>
<file name="index.js" path="C:\Development\rollup-plugin-generate-html-template\src\index.js">
<metrics statements="46" coveredstatements="46" conditionals="30" coveredconditionals="28" methods="10" coveredmethods="10"/>
<coverage generated="1659859376958" clover="3.2.0">
<project timestamp="1659859376958" name="All files">
<metrics statements="58" coveredstatements="55" conditionals="38" coveredconditionals="34" methods="20" coveredmethods="17" elements="116" coveredelements="106" complexity="0" loc="58" ncloc="58" packages="1" files="1" classes="1"/>
<file name="index.js" path="D:\GitHub\rollup-plugin-generate-html-template\src\index.js">
<metrics statements="58" coveredstatements="55" conditionals="38" coveredconditionals="34" methods="20" coveredmethods="17"/>
<line num="8" count="1" type="stmt"/>
<line num="16" count="10" type="stmt"/>
<line num="17" count="10" type="cond" truecount="4" falsecount="0"/>
<line num="18" count="10" type="stmt"/>
<line num="22" count="10" type="stmt"/>
<line num="23" count="10" type="stmt"/>
<line num="24" count="10" type="stmt"/>
<line num="25" count="10" type="cond" truecount="4" falsecount="0"/>
<line num="28" count="9" type="cond" truecount="2" falsecount="0"/>
<line num="30" count="9" type="stmt"/>
<line num="31" count="9" type="stmt"/>
<line num="33" count="9" type="cond" truecount="4" falsecount="0"/>
<line num="16" count="11" type="stmt"/>
<line num="17" count="11" type="cond" truecount="4" falsecount="0"/>
<line num="18" count="11" type="stmt"/>
<line num="22" count="11" type="stmt"/>
<line num="23" count="11" type="stmt"/>
<line num="24" count="11" type="stmt"/>
<line num="25" count="11" type="cond" truecount="4" falsecount="0"/>
<line num="28" count="10" type="cond" truecount="2" falsecount="0"/>
<line num="30" count="10" type="stmt"/>
<line num="31" count="10" type="stmt"/>
<line num="33" count="10" type="cond" truecount="4" falsecount="0"/>
<line num="34" count="1" type="stmt"/>
<line num="35" count="1" type="stmt"/>
<line num="36" count="1" type="cond" truecount="2" falsecount="0"/>
<line num="40" count="9" type="cond" truecount="2" falsecount="0"/>
<line num="44" count="9" type="cond" truecount="1" falsecount="1"/>
<line num="47" count="9" type="stmt"/>
<line num="50" count="9" type="stmt"/>
<line num="51" count="9" type="cond" truecount="2" falsecount="0"/>
<line num="52" count="1" type="stmt"/>
<line num="53" count="1" type="stmt"/>
<line num="54" count="2" type="stmt"/>
<line num="55" count="2" type="stmt"/>
<line num="39" count="13" type="cond" truecount="2" falsecount="0"/>
<line num="42" count="10" type="cond" truecount="2" falsecount="0"/>
<line num="46" count="10" type="cond" truecount="1" falsecount="1"/>
<line num="49" count="10" type="stmt"/>
<line num="52" count="10" type="stmt"/>
<line num="53" count="10" type="cond" truecount="2" falsecount="0"/>
<line num="54" count="1" type="stmt"/>
<line num="55" count="1" type="stmt"/>
<line num="56" count="2" type="stmt"/>
<line num="60" count="9" type="stmt"/>
<line num="63" count="9" type="stmt"/>
<line num="66" count="9" type="stmt"/>
<line num="69" count="12" type="stmt"/>
<line num="72" count="1" type="cond" truecount="2" falsecount="0"/>
<line num="78" count="9" type="stmt"/>
<line num="81" count="9" type="stmt"/>
<line num="84" count="12" type="stmt"/>
<line num="87" count="11" type="stmt"/>
<line num="95" count="9" type="stmt"/>
<line num="96" count="9" type="stmt"/>
<line num="97" count="9" type="stmt"/>
<line num="98" count="9" type="stmt"/>
<line num="100" count="1" type="stmt"/>
<line num="108" count="2" type="stmt"/>
<line num="109" count="2" type="stmt"/>
<line num="110" count="4" type="cond" truecount="2" falsecount="0"/>
<line num="111" count="2" type="stmt"/>
<line num="113" count="4" type="stmt"/>
<line num="118" count="1" type="stmt"/>
<line num="119" count="1" type="stmt"/>
<line num="57" count="2" type="stmt"/>
<line num="58" count="2" type="stmt"/>
<line num="62" count="10" type="stmt"/>
<line num="63" count="1" type="stmt"/>
<line num="65" count="1" type="cond" truecount="1" falsecount="1"/>
<line num="66" count="0" type="stmt"/>
<line num="68" count="1" type="cond" truecount="2" falsecount="0"/>
<line num="69" count="0" type="stmt"/>
<line num="71" count="1" type="cond" truecount="1" falsecount="1"/>
<line num="72" count="0" type="stmt"/>
<line num="74" count="1" type="cond" truecount="2" falsecount="0"/>
<line num="75" count="1" type="stmt"/>
<line num="78" count="1" type="stmt"/>
<line num="81" count="10" type="stmt"/>
<line num="84" count="10" type="stmt"/>
<line num="86" count="10" type="stmt"/>
<line num="89" count="13" type="stmt"/>
<line num="92" count="1" type="cond" truecount="2" falsecount="0"/>
<line num="98" count="10" type="stmt"/>
<line num="101" count="10" type="stmt"/>
<line num="104" count="13" type="stmt"/>
<line num="107" count="12" type="stmt"/>
<line num="115" count="10" type="stmt"/>
<line num="116" count="10" type="stmt"/>
<line num="117" count="10" type="stmt"/>
<line num="118" count="10" type="stmt"/>
<line num="120" count="1" type="stmt"/>
<line num="128" count="2" type="stmt"/>
<line num="129" count="2" type="stmt"/>
<line num="130" count="4" type="cond" truecount="2" falsecount="0"/>
<line num="131" count="2" type="stmt"/>
<line num="133" count="4" type="stmt"/>
<line num="138" count="1" type="stmt"/>
<line num="139" count="1" type="stmt"/>
</file>
</project>
</coverage>
Loading