1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

tools: fix doc tool behavior for version arrays

Browse Source 
Even though the doc tool supports version arrays in theory, it fails to
sort them properly causing the tool to crash.

PR-URL: https://github.com/nodejs/node/pull/22766
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Tobias Nießen 2018-09-08 11:40:05 +02:00
parent b36c581d5b
commit 1f5261b7c8
No known key found for this signature in database
GPG Key ID: 718207F8FD156B70
2 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
tools/doc/common.js
View File

@ -43,4 +43,4 @@ function extractAndParseYAML(text) {
return meta; return meta;
} }
module.exports = { isYAMLBlock, extractAndParseYAML }; module.exports = { arrify, isYAMLBlock, extractAndParseYAML };

14
tools/doc/html.js
View File

@ -308,7 +308,9 @@ function parseYAML(text) {
.use(htmlStringify) .use(htmlStringify)
.processSync(change.description).toString(); .processSync(change.description).toString();
result += `<tr><td>${change.version}</td>\n` + const version = common.arrify(change.version).join(', ');
result += `<tr><td>${version}</td>\n` +
`<td>${description}</td></tr>\n`; `<td>${description}</td></tr>\n`;
}); });
@ -326,10 +328,16 @@ function parseYAML(text) {
return result; return result;
} }
function minVersion(a) {
return common.arrify(a).reduce((min, e) => {
return !min || versionSort(min, e) < 0 ? e : min;
});
}
const numberRe = /^\d*/; const numberRe = /^\d*/;
function versionSort(a, b) { function versionSort(a, b) {
a = a.trim(); a = minVersion(a).trim();
b = b.trim(); b = minVersion(b).trim();
let i = 0; // Common prefix length. let i = 0; // Common prefix length.
while (i < a.length && i < b.length && a[i] === b[i]) i++; while (i < a.length && i < b.length && a[i] === b[i]) i++;
a = a.substr(i); a = a.substr(i);