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.

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

Feat: add source[src] & srcset support to minifyUrls #117

Merged
merged 2 commits into from
Nov 1, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
49 changes: 42 additions & 7 deletions lib/modules/minifyUrls.es6
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import RelateUrl from 'relateurl';
import srcset from 'srcset';

// Adopts from https://github.com/kangax/html-minifier/blob/51ce10f4daedb1de483ffbcccecc41be1c873da2/src/htmlminifier.js#L209-L221
const tagsHaveUriValuesForAttributes = new Set([
Expand Down Expand Up @@ -50,7 +51,22 @@ const isUriTypeAttribute = (tag, attr) => {
tag === 'form' && attr === 'action' ||
tag === 'input' && (attr === 'src' || attr === 'usemap') ||
tag === 'head' && attr === 'profile' ||
tag === 'script' && (attr === 'src' || attr === 'for')
tag === 'script' && (attr === 'src' || attr === 'for') ||
/**
* https://html.spec.whatwg.org/#attr-source-src
*
* Although most of browsers recommend not to use "src" in <source>,
* but technically it does comply with HTML Standard.
*/
tag === 'source' && attr === 'src'
);
};

const isSrcsetAttribute = (tag, attr) => {
return (
tag === 'source' && attr === 'srcset' ||
tag === 'img' && attr === 'srcset' ||
tag === 'link' && attr === 'imagesrcset'
);
};

Expand Down Expand Up @@ -106,13 +122,32 @@ export default function minifyUrls(tree, options, moduleOptions) {
for (const [attrName, attrValue] of Object.entries(node.attrs)) {
const attrNameLower = attrName.toLowerCase();

if (!isUriTypeAttribute(node.tag, attrNameLower)) continue;
if (isUriTypeAttribute(node.tag, attrNameLower)) {
// FIXME!
// relateurl@1.0.0-alpha only supports URL while stable version (0.2.7) only supports string
// the WHATWG URL API is very strict while attrValue might not be a valid URL
// new URL should be used, and relateUrl#relate should be wrapped in try...catch after relateurl@1 is stable
node.attrs[attrName] = relateUrlInstance.relate(attrValue);

continue;
}

if (isSrcsetAttribute(node.tag, attrNameLower)) {
try {
const parsedSrcset = srcset.parse(attrValue);

node.attrs[attrName] = srcset.stringify(parsedSrcset.map(srcset => {
srcset.url = relateUrlInstance.relate(srcset.url);

return srcset;
}));
} catch (e) {
// srcset will throw an Error for invalid srcset.
}


// FIXME!
// relateurl@1.0.0-alpha only supports URL while stable version (0.2.7) only supports string
// the WHATWG URL API is very strict while attrValue might not be a valid URL
// new URL should be used, and relateUrl#relate should be wrapped in try...catch after relateurl@1 is stable
node.attrs[attrName] = relateUrlInstance.relate(attrValue);
continue;
}
}

return node;
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
"posthtml-render": "^1.2.2",
"purgecss": "^2.3.0",
"relateurl": "^0.2.7",
"srcset": "^3.0.0",
"svgo": "^1.3.2",
"terser": "^4.8.0",
"timsort": "^0.3.0",
Expand Down
18 changes: 18 additions & 0 deletions test/modules/minifyUrls.js
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,22 @@ describe('minifyUrls', () => {

init(html, html, { ...safePreset, minifyUrls: 'https://example.com/' });
});

it('should process srcset', () => {
init(
'<img srcset="https://example.com/foo/bar/image.png 1x, https://example.com/foo/bar/image2.png.png 2x">',
'<img srcset="../bar/image.png 1x, ../bar/image2.png.png 2x">',
{ ...safePreset, minifyUrls: 'https://example.com/foo/baz/' }
);
});

it('shouldn\'t process "invalid" srcset', () => {
const html = '<img srcset="https://example.com/foo/bar/image.png 1x,https://example.com/foo/bar/image2.png.png 2x">';

init(
html,
html,
{ ...safePreset, minifyUrls: 'https://example.com/foo/baz/' }
);
});
});