Skip to content

allow jsdoc type declarations #1110

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

Merged
merged 2 commits into from
Nov 23, 2022
Merged

allow jsdoc type declarations #1110

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3233c63
allow jsdoc type declarations
mbostock Nov 23, 2022
fae6ba4
prettier
Nov 23, 2022
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
8 changes: 5 additions & 3 deletions scripts/readme-to-jsdoc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,15 +54,17 @@ for (const file of glob.sync("build/**/*.js")) {
let count = 0;
for (let i = 0, n = lines.length; i < n; ++i) {
let match: RegExpExecArray | null;
if ((match = /^\/\*\*\s+@jsdoc\s+(\w+)\s+\*\/$/.exec(lines[i]))) {
const [, name] = match;
if ((match = /^(\s*(?:\/\*)?\*\s+)@jsdoc\s+(\w+)((?:\s*\*\/)?\s*)$/.exec(lines[i]))) {
const [, pre, name, post] = match;
const docs = docmap.get(name);
if (!docs) throw new Error(`missing @jsdoc definition: ${name}`);
if (!unused.has(name)) throw new Error(`duplicate @jsdoc reference: ${name}`);
unused.delete(name);
++count;
lines[i] = docs
.map((line, i, lines) => (i === 0 ? `/** ${line}` : i === lines.length - 1 ? ` * ${line}\n */` : ` * ${line}`))
.map((line, i, lines) =>
i === 0 ? `${pre}${line}` : i === lines.length - 1 ? ` * ${line}${post ? `\n${post}` : ""}` : ` * ${line}`
)
.join("\n");
}
}
Expand Down