-
Notifications
You must be signed in to change notification settings - Fork 30k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
tools,doc: list the stability status of each API
Fixes: #23723 PR-URL: #36223 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
- Loading branch information
Showing
5 changed files
with
126 additions
and
1 deletion.
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
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
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,111 @@ | ||
'use strict'; | ||
|
||
// Build stability table to documentation.html/json/md by generated all.json | ||
|
||
const fs = require('fs'); | ||
const path = require('path'); | ||
const unified = require('unified'); | ||
const raw = require('rehype-raw'); | ||
const markdown = require('remark-parse'); | ||
const htmlStringify = require('rehype-stringify'); | ||
const gfm = require('remark-gfm'); | ||
const remark2rehype = require('remark-rehype'); | ||
const visit = require('unist-util-visit'); | ||
|
||
const source = `${__dirname}/../../out/doc/api`; | ||
const data = require(path.join(source, 'all.json')); | ||
const mark = '<!-- STABILITY_OVERVIEW_SLOT -->'; | ||
|
||
const output = { | ||
json: path.join(source, 'stability.json'), | ||
docHTML: path.join(source, 'documentation.html'), | ||
docJSON: path.join(source, 'documentation.json'), | ||
docMarkdown: path.join(source, 'documentation.md'), | ||
}; | ||
|
||
function collectStability(data) { | ||
const stability = []; | ||
|
||
for (const mod of data.modules) { | ||
if (mod.displayName && mod.stability >= 0) { | ||
const link = mod.source.replace('doc/api/', '').replace('.md', '.html'); | ||
// const link = re.exec(toc)[1] | ||
stability.push({ | ||
api: mod.name, | ||
link: link, | ||
stability: mod.stability, | ||
stabilityText: `(${mod.stability}) ${mod.stabilityText}`, | ||
}); | ||
} | ||
} | ||
|
||
stability.sort((a, b) => a.api.localeCompare(b.api)); | ||
return stability; | ||
} | ||
|
||
function createMarkdownTable(data) { | ||
const md = ['| API | Stability |', '| --- | --------- |']; | ||
|
||
for (const mod of data) { | ||
md.push(`| [${mod.api}](${mod.link}) | ${mod.stabilityText} |`); | ||
} | ||
|
||
return md.join('\n'); | ||
} | ||
|
||
function createHTML(md) { | ||
const file = unified() | ||
.use(markdown) | ||
.use(gfm) | ||
.use(remark2rehype, { allowDangerousHtml: true }) | ||
.use(raw) | ||
.use(htmlStringify) | ||
.use(processStability) | ||
.processSync(md); | ||
|
||
return file.contents.trim(); | ||
} | ||
|
||
function processStability() { | ||
return (tree) => { | ||
visit(tree, { type: 'element', tagName: 'tr' }, (node) => { | ||
const [api, stability] = node.children; | ||
if (api.tagName !== 'td') { | ||
return; | ||
} | ||
|
||
api.properties.class = 'module_stability'; | ||
|
||
const level = stability.children[0].value[1]; | ||
stability.properties.class = `api_stability api_stability_${level}`; | ||
}); | ||
}; | ||
} | ||
|
||
function updateStabilityMark(file, value, mark) { | ||
const fd = fs.openSync(file, 'r+'); | ||
const content = fs.readFileSync(fd); | ||
|
||
// Find the position of the `mark`. | ||
const index = content.indexOf(mark); | ||
|
||
// Overwrite the mark with `value` parameter. | ||
const offset = fs.writeSync(fd, value, index, 'utf-8'); | ||
|
||
// Re-write the end of the file after `value`. | ||
fs.writeSync(fd, content, index + mark.length, undefined, index + offset); | ||
fs.closeSync(fd); | ||
} | ||
|
||
const stability = collectStability(data); | ||
|
||
// add markdown | ||
const markdownTable = createMarkdownTable(stability); | ||
updateStabilityMark(output.docMarkdown, markdownTable, mark); | ||
|
||
// add html table | ||
const html = createHTML(markdownTable); | ||
updateStabilityMark(output.docHTML, html, mark); | ||
|
||
// add json output | ||
updateStabilityMark(output.docJSON, JSON.stringify(html), JSON.stringify(mark)); |