Skip to content

[v10.x backport] doc,tools: get altDocs versions from CHANGELOG.md #32642

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.

Sign up for GitHub

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

Closed
richardlau wants to merge 6 commits into from
Closed

[v10.x backport] doc,tools: get altDocs versions from CHANGELOG.md #32642

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b0a4d45
doc,tools: get altDocs versions from CHANGELOG.md
richardlau May 12, 2019
ed69a5f
test: fix flaky doctool and test
Trott Oct 15, 2019
ac9127e
tools: make doctool work if no internet available
richardlau Nov 2, 2019
2c3c6a0
tools: add NODE_TEST_NO_INTERNET to the doc builder
joyeecheung Feb 18, 2020
df5d115
tools: only fetch previous versions when necessary
richardlau Mar 27, 2020
91ea203
test: fix tool path in test-doctool-versions.js
richardlau Apr 3, 2020
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
Prev Previous commit
Next Next commit
test: fix flaky doctool and test 
Doctool tests have been failing a lot in CI on Win2008 R2. It appears
async functions and callback-based functions are being used in
combination such that the callback-based function cannot guarantee that
it will invoke its callback. Convert the callback-based functions to
async functions so we have one paradigm and reliable results.

Backport-PR-URL: #32642
PR-URL: #29979
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
  • Loading branch information
@Trott @richardlau
Trott authored and richardlau committed Apr 6, 2020
commit ed69a5f9887d6b671aa0d15bab188623ccf94ee9
32 changes: 11 additions & 21 deletions test/doctool/test-doctool-html.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ const remark2rehype = require('remark-rehype');
const raw = require('rehype-raw');
const htmlStringify = require('rehype-stringify');

function toHTML({ input, filename, nodeVersion }, cb) {
async function toHTML({ input, filename, nodeVersion }) {
const content = unified()
.use(markdown)
.use(html.firstHeader)
Expand All @@ -34,10 +34,7 @@ function toHTML({ input, filename, nodeVersion }, cb) {
.use(htmlStringify)
.processSync(input);

html.toHTML(
{ input, content, filename, nodeVersion },
cb
);
return html.toHTML({ input, content, filename, nodeVersion });
}

// Test data is a list of objects with two properties.
Expand Down Expand Up @@ -107,23 +104,16 @@ testData.forEach(({ file, html }) => {
// Normalize expected data by stripping whitespace.
const expected = html.replace(spaces, '');

readFile(file, 'utf8', common.mustCall((err, input) => {
readFile(file, 'utf8', common.mustCall(async (err, input) => {
assert.ifError(err);
toHTML(
{
input: input,
filename: 'foo',
nodeVersion: process.version,
},
common.mustCall((err, output) => {
assert.ifError(err);
const output = await toHTML({ input: input,
filename: 'foo',
nodeVersion: process.version });

const actual = output.replace(spaces, '');
// Assert that the input stripped of all whitespace contains the
// expected markup.
assert(actual.includes(expected),
`ACTUAL: ${actual}\nEXPECTED: ${expected}`);
})
);
const actual = output.replace(spaces, '');
// Assert that the input stripped of all whitespace contains the
// expected markup.
assert(actual.includes(expected),
`ACTUAL: ${actual}\nEXPECTED: ${expected}`);
}));
});
17 changes: 6 additions & 11 deletions tools/doc/generate.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ if (!filename) {
}


fs.readFile(filename, 'utf8', (er, input) => {
fs.readFile(filename, 'utf8', async (er, input) => {
if (er) throw er;

const content = unified()
Expand All @@ -84,15 +84,10 @@ fs.readFile(filename, 'utf8', (er, input) => {

const basename = path.basename(filename, '.md');

html.toHTML(
{ input, content, filename, nodeVersion },
(err, html) => {
const target = path.join(outputDir, `${basename}.html`);
if (err) throw err;
fs.writeFileSync(target, html);
}
);
const myHtml = await html.toHTML({ input, content, filename, nodeVersion });
const htmlTarget = path.join(outputDir, `${basename}.html`);
fs.writeFileSync(htmlTarget, myHtml);

const target = path.join(outputDir, `${basename}.json`);
fs.writeFileSync(target, JSON.stringify(content.json, null, 2));
const jsonTarget = path.join(outputDir, `${basename}.json`);
fs.writeFileSync(jsonTarget, JSON.stringify(content.json, null, 2));
});
4 changes: 2 additions & 2 deletions tools/doc/html.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ const gtocHTML = unified()
const templatePath = path.join(docPath, 'template.html');
const template = fs.readFileSync(templatePath, 'utf8');

async function toHTML({ input, content, filename, nodeVersion }, cb) {
async function toHTML({ input, content, filename, nodeVersion }) {
filename = path.basename(filename, '.md');

const id = filename.replace(/\W+/g, '-');
Expand All @@ -87,7 +87,7 @@ async function toHTML({ input, content, filename, nodeVersion }, cb) {
HTML = HTML.replace('__ALTDOCS__', '');
}

cb(null, HTML);
return HTML;
}

// Set the section name based on the first header. Default to 'Index'.
Expand Down