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

Callback Support #907

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

Callback Support #907

Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
8a675e4
Added tests for async style and script minification using callbacks.
Apr 11, 2018
7f1dc9c
Added more tests for async style and script minification using callba…
Apr 11, 2018
8a3105a
Added a test to ensure that the minify function still results a resul…
Apr 11, 2018
a68ee19
Added callback parameter to minify.
Apr 11, 2018
892ca4b
Added callback parameter to minifyCSS and minifyJS.
Apr 11, 2018
77f3786
Added an onComplete function to the the HTMLParser class.
Apr 11, 2018
127669d
Switch out the iterative loop for a recursive loop that supports call…
Apr 11, 2018
16c9ab7
Wrapped the parse error check up into a function so its execution can…
Apr 11, 2018
9c447fd
Refactored HTMLParser's parse loop.
Apr 11, 2018
bac6a0e
Code at the end of the minify function now waits until the HTMLParser…
Apr 11, 2018
b2626ce
Added callback to chars function which will always be called once it …
Apr 11, 2018
143a8fe
HTMLParser now supplies the chars's callback function which will cont…
Apr 11, 2018
e487a50
Moved parse() call up so that it isn't hidden within function definit…
Apr 11, 2018
b51fe21
Added error handling.
Apr 11, 2018
76007a1
Fixed comment.
Apr 11, 2018
65d142d
Switch out undefined compare for typeof undefined compare.
RebeccaStevens Apr 11, 2018
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
206 changes: 133 additions & 73 deletions src/htmlminifier.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -803,7 +803,7 @@ function createSortFns(value, options, uidIgnore, uidAttr) {
}
}

function minify(value, options, partialMarkup) {
function minify(value, options, partialMarkup, cb) {
options = options || {};
var optionsStack = [];
processOptions(options);
Expand Down Expand Up @@ -867,14 +867,14 @@ function minify(value, options, partialMarkup) {
uidPattern = new RegExp('(\\s*)' + uidAttr + '([0-9]+)(\\s*)', 'g');
var minifyCSS = options.minifyCSS;
if (minifyCSS) {
options.minifyCSS = function(text) {
return minifyCSS(escapeFragments(text));
options.minifyCSS = function(text, cb) {
return minifyCSS(escapeFragments(text), cb);
};
}
var minifyJS = options.minifyJS;
if (minifyJS) {
options.minifyJS = function(text, inline) {
return minifyJS(escapeFragments(text), inline);
options.minifyJS = function(text, inline, cb) {
return minifyJS(escapeFragments(text), inline, cb);
};
}
}
Expand Down Expand Up @@ -941,7 +941,8 @@ function minify(value, options, partialMarkup) {
trimTrailingWhitespace(charsIndex, nextTag);
}

new HTMLParser(value, {
var str;
var parser = new HTMLParser(value, {
partialMarkup: partialMarkup,
html5: options.html5,

Expand Down Expand Up @@ -1106,7 +1107,7 @@ function minify(value, options, partialMarkup) {
}
}
},
chars: function(text, prevTag, nextTag) {
chars: function(text, prevTag, nextTag, cb) {
prevTag = prevTag === '' ? 'comment' : prevTag;
nextTag = nextTag === '' ? 'comment' : nextTag;
if (options.decodeEntities && text && !specialContentTags(currentTag)) {
Expand Down Expand Up @@ -1160,42 +1161,85 @@ function minify(value, options, partialMarkup) {
if (options.processScripts && specialContentTags(currentTag)) {
text = processScript(text, options, currentAttrs);
}

var tasksWaitingFor = 0, tasksComplete = 0;

function onTaskFinished(result) {
text = result;
if (tasksWaitingFor === ++tasksComplete) {
afterTasksFinish();
}
}

if (isExecutableScript(currentTag, currentAttrs)) {
text = options.minifyJS(text);
try {
tasksWaitingFor++;
var minifyJSResult = options.minifyJS(text, null, onTaskFinished);

// If the result is defined then minifyJS completed synchronously.
// eslint-disable-next-line no-undefined
if (minifyJSResult !== undefined) {
onTaskFinished(minifyJSResult);
}
}
catch (error) {
cb(error);
}
}

if (isStyleSheet(currentTag, currentAttrs)) {
text = options.minifyCSS(text);
}
if (options.removeOptionalTags && text) {
// <html> may be omitted if first thing inside is not comment
// <body> may be omitted if first thing inside is not space, comment, <meta>, <link>, <script>, <style> or <template>
if (optionalStartTag === 'html' || optionalStartTag === 'body' && !/^\s/.test(text)) {
removeStartTag();
try {
tasksWaitingFor++;
var minifyCSSResult = options.minifyCSS(text, onTaskFinished);

// If the result is defined then minifyCSS completed synchronously.
// eslint-disable-next-line no-undefined
if (minifyCSSResult !== undefined) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please use typeof minifyCSSResult !== 'undefined' instead of overriding eslint

Copy link
Author

Choose a reason for hiding this comment

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

Will do.

onTaskFinished(minifyCSSResult);
}
}
optionalStartTag = '';
// </html> or </body> may be omitted if not followed by comment
// </head>, </colgroup> or </caption> may be omitted if not followed by space or comment
if (compactTags(optionalEndTag) || looseTags(optionalEndTag) && !/^\s/.test(text)) {
removeEndTag();
catch (error) {
cb(error);
}
optionalEndTag = '';
}
charsPrevTag = /^\s*$/.test(text) ? prevTag : 'comment';
if (options.decodeEntities && text && !specialContentTags(currentTag)) {
// semi-colon can be omitted
// https://mathiasbynens.be/notes/ambiguous-ampersands
text = text.replace(/&(#?[0-9a-zA-Z]+;)/g, '&amp$1').replace(/</g, '&lt;');
}
if (uidPattern && options.collapseWhitespace && stackNoTrimWhitespace.length) {
text = text.replace(uidPattern, function(match, prefix, index) {
return ignoredCustomMarkupChunks[+index][0];
});

if (tasksWaitingFor === 0) {
afterTasksFinish();
}
currentChars += text;
if (text) {
hasChars = true;

function afterTasksFinish() {
if (options.removeOptionalTags && text) {
// <html> may be omitted if first thing inside is not comment
// <body> may be omitted if first thing inside is not space, comment, <meta>, <link>, <script>, <style> or <template>
if (optionalStartTag === 'html' || optionalStartTag === 'body' && !/^\s/.test(text)) {
removeStartTag();
}
optionalStartTag = '';
// </html> or </body> may be omitted if not followed by comment
// </head>, </colgroup> or </caption> may be omitted if not followed by space or comment
if (compactTags(optionalEndTag) || looseTags(optionalEndTag) && !/^\s/.test(text)) {
removeEndTag();
}
optionalEndTag = '';
}
charsPrevTag = /^\s*$/.test(text) ? prevTag : 'comment';
if (options.decodeEntities && text && !specialContentTags(currentTag)) {
// semi-colon can be omitted
// https://mathiasbynens.be/notes/ambiguous-ampersands
text = text.replace(/&(#?[0-9a-zA-Z]+;)/g, '&amp$1').replace(/</g, '&lt;');
}
if (uidPattern && options.collapseWhitespace && stackNoTrimWhitespace.length) {
text = text.replace(uidPattern, function(match, prefix, index) {
return ignoredCustomMarkupChunks[+index][0];
});
}
currentChars += text;
if (text) {
hasChars = true;
}
buffer.push(text);
cb();
}
buffer.push(text);
},
comment: function(text, nonStandard) {
var prefix = nonStandard ? '<!' : '<!--';
Expand Down Expand Up @@ -1228,48 +1272,64 @@ function minify(value, options, partialMarkup) {
customAttrSurround: options.customAttrSurround
});

if (options.removeOptionalTags) {
// <html> may be omitted if first thing inside is not comment
// <head> or <body> may be omitted if empty
if (topLevelTags(optionalStartTag)) {
removeStartTag();
parser.onComplete(function() {
if (options.removeOptionalTags) {
// <html> may be omitted if first thing inside is not comment
// <head> or <body> may be omitted if empty
if (topLevelTags(optionalStartTag)) {
removeStartTag();
}
// except for </dt> or </thead>, end tags may be omitted if no more content in parent element
if (optionalEndTag && !trailingTags(optionalEndTag)) {
removeEndTag();
}
}
// except for </dt> or </thead>, end tags may be omitted if no more content in parent element
if (optionalEndTag && !trailingTags(optionalEndTag)) {
removeEndTag();
if (options.collapseWhitespace) {
squashTrailingWhitespace('br');
}
}
if (options.collapseWhitespace) {
squashTrailingWhitespace('br');
}

var str = joinResultSegments(buffer, options);
str = joinResultSegments(buffer, options);

if (uidPattern) {
str = str.replace(uidPattern, function(match, prefix, index, suffix) {
var chunk = ignoredCustomMarkupChunks[+index][0];
if (options.collapseWhitespace) {
if (prefix !== '\t') {
chunk = prefix + chunk;
}
if (suffix !== '\t') {
chunk += suffix;
if (uidPattern) {
str = str.replace(uidPattern, function(match, prefix, index, suffix) {
var chunk = ignoredCustomMarkupChunks[+index][0];
if (options.collapseWhitespace) {
if (prefix !== '\t') {
chunk = prefix + chunk;
}
if (suffix !== '\t') {
chunk += suffix;
}
return collapseWhitespace(chunk, {
preserveLineBreaks: options.preserveLineBreaks,
conservativeCollapse: !options.trimCustomFragments
}, /^[ \n\r\t\f]/.test(chunk), /[ \n\r\t\f]$/.test(chunk));
}
return collapseWhitespace(chunk, {
preserveLineBreaks: options.preserveLineBreaks,
conservativeCollapse: !options.trimCustomFragments
}, /^[ \n\r\t\f]/.test(chunk), /[ \n\r\t\f]$/.test(chunk));
}
return chunk;
});
}
if (uidIgnore) {
str = str.replace(new RegExp('<!--' + uidIgnore + '([0-9]+)-->', 'g'), function(match, index) {
return ignoredMarkupChunks[+index];
});
}
return chunk;
});
}
if (uidIgnore) {
str = str.replace(new RegExp('<!--' + uidIgnore + '([0-9]+)-->', 'g'), function(match, index) {
return ignoredMarkupChunks[+index];
});
}

options.log('minified in: ' + (Date.now() - t) + 'ms');

if (typeof cb === 'function') {
return cb(null, str);
}
});

parser.onError(function(error) {
if (typeof cb === 'function') {
return cb(error);
}

// No callback to handle the error?
throw error;
});

options.log('minified in: ' + (Date.now() - t) + 'ms');
return str;
}

Expand Down Expand Up @@ -1300,6 +1360,6 @@ function joinResultSegments(results, options) {
return options.collapseWhitespace ? collapseWhitespace(str, options, true, true) : str;
}

exports.minify = function(value, options) {
return minify(value, options);
exports.minify = function(value, options, cb) {
return minify(value, options, null, cb);
};
Loading