Nodejs/node
1
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2024-11-21 10:59:27 +00:00
Code Issues Actions 25 Packages Projects Releases Wiki Activity

tools: add [src] links to assert.html

Browse Source 
Parse `const assert = module.exports = ok;` as exporting a constructor
named `assert`.

PR-URL: https://github.com/nodejs/node/pull/22601
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
This commit is contained in:
Sam Ruby 2018-08-30 10:37:04 -04:00
parent a55c57b8c4
commit 5da155398e
3 changed files with 73 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
test/fixtures/apilinks/reverse.js vendored Normal file
View File

@ -0,0 +1,13 @@
'use strict';
// Parallel assignment to the exported variable and module.exports.
function ok() {
}
const asserts = module.exports = ok;
asserts.ok = ok;
asserts.strictEqual = function() {
}

5
test/fixtures/apilinks/reverse.json vendored Normal file
View File

@ -0,0 +1,5 @@
{
"asserts": "reverse.js#L8",
"asserts.ok": "reverse.js#L5",
"asserts.strictEqual": "reverse.js#L12"
}

79
tools/doc/apilinks.js
View File

@ -55,35 +55,50 @@ process.argv.slice(2).forEach((file) => {
const ast = acorn.parse(source, { ecmaVersion: 10, locations: true });
const program = ast.body;
// Build link
const link = `https://github.com/${repo}/blob/${tag}/` +
path.relative('.', file).replace(/\\/g, '/');
// Scan for exports.
const exported = { constructors: [], identifiers: [] };
program.forEach((statement) => {
if (statement.type !== 'ExpressionStatement') return;
const expr = statement.expression;
if (expr.type !== 'AssignmentExpression') return;
if (statement.type === 'ExpressionStatement') {
const expr = statement.expression;
if (expr.type !== 'AssignmentExpression') return;
let lhs = expr.left;
if (expr.left.object.type === 'MemberExpression') lhs = lhs.object;
if (lhs.type !== 'MemberExpression') return;
if (lhs.object.name !== 'module') return;
if (lhs.property.name !== 'exports') return;
let lhs = expr.left;
if (expr.left.object.type === 'MemberExpression') lhs = lhs.object;
if (lhs.type !== 'MemberExpression') return;
if (lhs.object.name !== 'module') return;
if (lhs.property.name !== 'exports') return;
let rhs = expr.right;
while (rhs.type === 'AssignmentExpression') rhs = rhs.right;
let rhs = expr.right;
while (rhs.type === 'AssignmentExpression') rhs = rhs.right;
if (rhs.type === 'NewExpression') {
exported.constructors.push(rhs.callee.name);
} else if (rhs.type === 'ObjectExpression') {
rhs.properties.forEach((property) => {
if (property.value.type === 'Identifier') {
exported.identifiers.push(property.value.name);
if (/^[A-Z]/.test(property.value.name[0])) {
exported.constructors.push(property.value.name);
if (rhs.type === 'NewExpression') {
exported.constructors.push(rhs.callee.name);
} else if (rhs.type === 'ObjectExpression') {
rhs.properties.forEach((property) => {
if (property.value.type === 'Identifier') {
exported.identifiers.push(property.value.name);
if (/^[A-Z]/.test(property.value.name[0])) {
exported.constructors.push(property.value.name);
}
}
}
});
} else if (rhs.type === 'Identifier') {
exported.identifiers.push(rhs.name);
});
} else if (rhs.type === 'Identifier') {
exported.identifiers.push(rhs.name);
}
} else if (statement.type === 'VariableDeclaration') {
for (const decl of statement.declarations) {
let init = decl.init;
while (init && init.type === 'AssignmentExpression') init = init.left;
if (!init || init.type !== 'MemberExpression') continue;
if (init.object.name !== 'module') continue;
if (init.property.name !== 'exports') continue;
exported.constructors.push(decl.id.name);
definition[decl.id.name] = `${link}#L${statement.loc.start.line}`;
}
}
});
@ -93,8 +108,7 @@ process.argv.slice(2).forEach((file) => {
// ClassName.prototype.foo = ...;
// function Identifier(...) {...};
//
const link = `https://github.com/${repo}/blob/${tag}/` +
path.relative('.', file).replace(/\\/g, '/');
const indirect = {};
program.forEach((statement) => {
if (statement.type === 'ExpressionStatement') {
@ -128,6 +142,11 @@ process.argv.slice(2).forEach((file) => {
}
definition[name] = `${link}#L${statement.loc.start.line}`;
if (expr.left.property.name === expr.right.name) {
indirect[expr.right.name] = name;
}
} else if (statement.type === 'FunctionDeclaration') {
const name = statement.id.name;
if (!exported.identifiers.includes(name)) return;
@ -136,6 +155,18 @@ process.argv.slice(2).forEach((file) => {
`${link}#L${statement.loc.start.line}`;
}
});
// Search for indirect references of the form ClassName.foo = foo;
if (Object.keys(indirect).length > 0) {
program.forEach((statement) => {
if (statement.type === 'FunctionDeclaration') {
const name = statement.id.name;
if (indirect[name]) {
definition[indirect[name]] = `${link}#L${statement.loc.start.line}`;
}
}
});
}
});
console.log(JSON.stringify(definition, null, 2));