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.

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

doc: list the stability status of each module #36223

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
6 changes: 5 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -696,7 +696,7 @@ doc-only: tools/doc/node_modules \
@if [ "$(shell $(node_use_openssl))" != "true" ]; then \
echo "Skipping doc-only (no crypto)"; \
else \
$(MAKE) out/doc/api/all.html out/doc/api/all.json; \
$(MAKE) out/doc/api/all.html out/doc/api/all.json out/doc/api/stability; \
fi

.PHONY: doc
Expand Down Expand Up @@ -749,6 +749,10 @@ out/doc/api/all.html: $(apidocs_html) tools/doc/allhtml.js \
out/doc/api/all.json: $(apidocs_json) tools/doc/alljson.js | out/doc/api
$(call available-node, tools/doc/alljson.js)

.PHONY: out/doc/api/stability
out/doc/api/stability: out/doc/api/all.json tools/doc/stability.js | out/doc/api
Lxxyx marked this conversation as resolved.
Show resolved Hide resolved
$(call available-node, tools/doc/stability.js)

.PHONY: docopen
docopen: out/doc/api/all.html
@$(PYTHON) -mwebbrowser file://$(abspath $<)
Expand Down
3 changes: 3 additions & 0 deletions doc/api/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ Bugs or behavior changes may surprise users when Experimental API
modifications occur. To avoid surprises, use of an Experimental feature may need
a command-line flag. Experimental features may also emit a [warning][].

## Stability overview
<!-- STABILITY_OVERVIEW_SLOT -->

## JSON output
<!-- YAML
added: v0.6.12
Expand Down
4 changes: 4 additions & 0 deletions doc/api_assets/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,10 @@ ol.version-picker li:last-child a {
background-color: var(--green2);
}

.module_stability {
vertical-align: middle;
}

.api_metadata {
font-size: .85rem;
margin-bottom: 1rem;
Expand Down
3 changes: 3 additions & 0 deletions tools/doc/alljson.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ for (const link of toc.match(/<a.*?>/g)) {

for (const property in data) {
if (results.hasOwnProperty(property)) {
data[property].forEach((mod) => {
mod.source = data.source;
});
results[property].push(...data[property]);
}
}
Expand Down
111 changes: 111 additions & 0 deletions tools/doc/stability.js
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.
fs.writeSync(fd, value, index, 'utf-8');
Lxxyx marked this conversation as resolved.
Show resolved Hide resolved

// Re-write the end of the file after `value`.
fs.writeSync(fd, content, index + mark.length);
Lxxyx marked this conversation as resolved.
Show resolved Hide resolved
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), `"${mark}"`);
Lxxyx marked this conversation as resolved.
Show resolved Hide resolved