Skip to content
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

Minify content within script tag of type JSON (importmap, manifest, JSON-LD, etc.) #1157

Open
wants to merge 3 commits into
base: gh-pages
Choose a base branch
from
Open

Minify content within script tag of type JSON (importmap, manifest, JSON-LD, etc.) #1157

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ab4c9d6
Minify content within script tag of type="application/ld+json"
simonewebdesign Dec 1, 2024
f63fdbd
Log the error
simonewebdesign Jan 11, 2025
25e77e8
Add support for `importmap` and other JSON types
simonewebdesign Feb 13, 2025
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
15 changes: 15 additions & 0 deletions src/htmlminifier.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,6 +387,11 @@ function cleanConditionalComment(comment, options) {

function processScript(text, options, currentAttrs) {
for (var i = 0, len = currentAttrs.length; i < len; i++) {
if (currentAttrs[i].name.toLowerCase() === 'type' &&
currentAttrs[i].value === 'application/ld+json') {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Import maps (type="importmap") are also often used and should be minified. Could we use an array of acceptable types?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great shout! I've implemented that in 25e77e8. It adds support for import maps and makes it much simpler to implement a new format (it will just be a matter of adding it to the array of acceptable types). I've added more types to the list as well, let me know if you think there are any others I've missed!

return minifyJson(text, options);
}

if (currentAttrs[i].name.toLowerCase() === 'type' &&
options.processScripts.indexOf(currentAttrs[i].value) > -1) {
return minify(text, options);
Expand All @@ -395,6 +400,16 @@ function processScript(text, options, currentAttrs) {
return text;
}

function minifyJson(text, options) {
try {
return JSON.stringify(JSON.parse(text));
}
catch (err) {
options.log(err);
return text;
}
}

// Tag omission rules from https://html.spec.whatwg.org/multipage/syntax.html#optional-tags
// with the following deviations:
// - retain <body> if followed by <noscript>
Expand Down
18 changes: 18 additions & 0 deletions tests/minifier.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2822,6 +2822,24 @@ QUnit.test('processScripts', function(assert) {
}), output);
});

QUnit.test('processScripts application/ld+json', function(assert) {
var input = '<script type="application/ld+json">{"foo": "bar"}\n\n</script>';
var output = '<script type="application/ld+json">{"foo":"bar"}</script>';
assert.equal(minify(input, {
collapseWhitespace: true,
processScripts: ['application/ld+json']
}), output);
});

QUnit.test('processScripts application/ld+json (invalid/malformed)', function(assert) {
var input = '<script type="application/ld+json">{"foo: "bar"}\n\n</script>';
var output = '<script type="application/ld+json">{"foo: "bar"}</script>';
assert.equal(minify(input, {
collapseWhitespace: true,
processScripts: ['application/ld+json']
}), output);
});

QUnit.test('ignore', function(assert) {
var input, output;

Expand Down