Skip to content

docs: apply generics to typescript example #8801

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
Feb 1, 2023
Merged

docs: apply generics to typescript example #8801

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b7a0183
docs: apply generics to typescript example
tristan-f-r Jan 31, 2023
55785cd
fix: same line non-json generics
tristan-f-r Feb 1, 2023
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
21 changes: 14 additions & 7 deletions sites/kit.svelte.dev/src/lib/docs/server/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -478,7 +478,7 @@ function convert_to_ts(js_code, indent = '', offset = '') {

for (const tag of comment.tags ?? []) {
if (ts.isJSDocTypeTag(tag)) {
const name = get_type_name(tag);
const [name, generics] = get_type_info(tag);

if (ts.isFunctionDeclaration(node)) {
const is_export = node.modifiers?.some(
Expand All @@ -497,7 +497,8 @@ function convert_to_ts(js_code, indent = '', offset = '') {
}`
);
code.appendLeft(node.body.getStart(), '=> ');
code.appendLeft(node.body.getEnd(), `) satisfies ${name};`);
const type = generics !== undefined ? `${name}${generics}` : name;
code.appendLeft(node.body.getEnd(), `) satisfies ${type};`);

modified = true;
} else if (
Expand All @@ -522,7 +523,7 @@ function convert_to_ts(js_code, indent = '', offset = '') {
'Unhandled @type JsDoc->TS conversion; needs more params logic: ' + node.getText()
);
}
const name = get_type_name(tag);
const [name] = get_type_info(tag);
code.appendLeft(node.parameters[0].getEnd(), `: ${name}`);

modified = true;
Expand Down Expand Up @@ -565,21 +566,27 @@ function convert_to_ts(js_code, indent = '', offset = '') {
return transformed === js_code ? undefined : transformed.replace(/\n\s*\n\s*\n/g, '\n\n');

/** @param {ts.JSDocTypeTag | ts.JSDocParameterTag} tag */
function get_type_name(tag) {
function get_type_info(tag) {
const type_text = tag.typeExpression.getText();
let name = type_text.slice(1, -1); // remove { }

const import_match = /import\('(.+?)'\)\.(\w+)/.exec(type_text);
const import_match = /import\('(.+?)'\)\.(\w+)(<{?[\n\* \w:;,]+}?>)?/.exec(type_text);
if (import_match) {
const [, from, _name] = import_match;
const [, from, _name, generics] = import_match;
name = _name;
const existing = imports.get(from);
if (existing) {
existing.add(name);
} else {
imports.set(from, new Set([name]));
}
if (generics !== undefined) {
return [name, generics
.replaceAll("*", "") // get rid of JSDoc asterisks
.replace(" }>", "}>") // unindent closing brace
];
}
}
return name;
return [name];
}
}