-
Notifications
You must be signed in to change notification settings - Fork 29.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
tools: build all.html by combining generated HTML
Combine the toc and api contents from the generated doc/api/*.html files. This ensures that the single page version of the documentation exactly matches the individual pages. PR-URL: #21568 Fixes: #20100 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
- Loading branch information
1 parent
a27b0a3
commit f85962f
Showing
2 changed files
with
79 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
'use strict'; | ||
|
||
// Build all.html by combining the generated toc and apicontent from each | ||
// of the generated html files. | ||
|
||
const fs = require('fs'); | ||
|
||
const source = `${__dirname}/../../out/doc/api`; | ||
|
||
// Get a list of generated API documents. | ||
const htmlFiles = fs.readdirSync(source, 'utf8') | ||
.filter((name) => name.includes('.html') && name !== 'all.html'); | ||
|
||
// Read the table of contents. | ||
const toc = fs.readFileSync(source + '/_toc.html', 'utf8'); | ||
|
||
// Extract (and concatenate) the toc and apicontent from each document. | ||
let contents = ''; | ||
let apicontent = ''; | ||
|
||
// Identify files that should be skipped. As files are processed, they | ||
// are added to this list to prevent dupes. | ||
const seen = { | ||
'all.html': true, | ||
'index.html': true | ||
}; | ||
|
||
for (const link of toc.match(/<a.*?>/g)) { | ||
const href = /href="(.*?)"/.exec(link)[1]; | ||
if (!htmlFiles.includes(href) || seen[href]) continue; | ||
const data = fs.readFileSync(source + '/' + href, 'utf8'); | ||
|
||
// Split the doc. | ||
const match = /(<\/ul>\s*)?<\/div>\s*<div id="apicontent">/.exec(data); | ||
|
||
contents += data.slice(0, match.index) | ||
.replace(/[\s\S]*?<div id="toc">\s*<h2>.*?<\/h2>\s*(<ul>\s*)?/, ''); | ||
|
||
apicontent += data.slice(match.index + match[0].length) | ||
.replace(/(<\/div>\s*)*\s*<script[\s\S]*/, '') | ||
.replace(/<a href="(\w[^#"]*)#/g, (match, href) => { | ||
return htmlFiles.includes(href) ? '<a href="#' : match; | ||
}) | ||
.trim() + '\n'; | ||
|
||
// Mark source as seen. | ||
seen[href] = true; | ||
} | ||
|
||
// Replace various mentions of _toc with all. | ||
let all = toc.replace(/_toc\.html/g, 'all.html') | ||
.replace('_toc.json', 'all.json') | ||
.replace('api-section-_toc', 'api-section-all') | ||
.replace('data-id="_toc"', 'data-id="all"'); | ||
|
||
// Clean up the title. | ||
all = all.replace(/<title>.*?\| /, '<title>'); | ||
|
||
// Insert the combined table of contents. | ||
const tocStart = /<div id="toc">\s*<h2>.*?<\/h2>\s*/.exec(all); | ||
all = all.slice(0, tocStart.index + tocStart[0].length) + | ||
'<ul>\n' + contents + '</ul>\n' + | ||
all.slice(tocStart.index + tocStart[0].length); | ||
|
||
// Replace apicontent with the concatenated set of apicontents from each source. | ||
const apiStart = /<div id="apicontent">\s*/.exec(all); | ||
const apiEnd = /(\s*<\/div>)*\s*<script /.exec(all); | ||
all = all.slice(0, apiStart.index + apiStart[0].length) + | ||
apicontent + | ||
all.slice(apiEnd.index); | ||
|
||
// Write results. | ||
fs.writeFileSync(source + '/all.html', all, 'utf8'); |