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

tools: flatten apidoc headers

Browse Source 
ensure optional parameters are not treated as markedown links by
replacing the children of headers nodes with a single text node
containing the raw markup;

Fixes issue identified in
https://github.com/nodejs/node/pull/21490#issuecomment-406859983

PR-URL: https://github.com/nodejs/node/pull/21936
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Minwoo Jung <minwoo@nodesource.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
This commit is contained in:
Sam Ruby 2018-07-22 14:13:56 -07:00 committed by Vse Mozhet Byt
parent e83126a883
commit 83474ae1e3
1 changed files with 21 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
tools/doc/html.js
View File

@ -175,9 +175,9 @@ function linkJsTypeDocs(text) {
return parts.join('`'); return parts.join('`');
} }
// Preprocess stability blockquotes and YAML blocks // Preprocess headers, stability blockquotes, and YAML blocks.
function preprocessElements({ filename }) { function preprocessElements({ filename }) {
return (tree) => { return (tree, file) => {
const STABILITY_RE = /(.*:)\s*(\d)([\s\S]*)/; const STABILITY_RE = /(.*:)\s*(\d)([\s\S]*)/;
let headingIndex = -1; let headingIndex = -1;
let heading = null; let heading = null;
@ -187,6 +187,22 @@ function preprocessElements({ filename }) {
headingIndex = index; headingIndex = index;
heading = node; heading = node;
// Ensure optional API parameters are not treated as links by
// collapsing all of heading into a single text node.
if (heading.children.length > 1) {
const position = {
start: heading.children[0].position.start,
end: heading.position.end
};
heading.children = [{
type: 'text',
value: file.contents.slice(
position.start.offset, position.end.offset),
position
}];
}
} else if (node.type === 'html' && common.isYAMLBlock(node.value)) { } else if (node.type === 'html' && common.isYAMLBlock(node.value)) {
node.value = parseYAML(node.value); node.value = parseYAML(node.value);
@ -331,10 +347,9 @@ function buildToc({ filename }) {
depth = node.depth; depth = node.depth;
const realFilename = path.basename(realFilenames[0], '.md'); const realFilename = path.basename(realFilenames[0], '.md');
const headingText = node.children.map((child) => const headingText = file.contents.slice(
file.contents.slice(child.position.start.offset, node.children[0].position.start.offset,
child.position.end.offset) node.position.end.offset).trim();
).join('').trim();
const id = getId(`${realFilename}_${headingText}`, idCounters); const id = getId(`${realFilename}_${headingText}`, idCounters);
const hasStability = node.stability !== undefined; const hasStability = node.stability !== undefined;