Skip to content

Generate links to MDN docs #1526

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

Merged
merged 2 commits into from
Mar 18, 2023
Merged
Show file tree
Hide file tree
Changes from all 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
524 changes: 461 additions & 63 deletions baselines/audioworklet.generated.d.ts

Large diffs are not rendered by default.

6 changes: 5 additions & 1 deletion baselines/audioworklet.iterable.generated.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@
/////////////////////////////

interface MessageEvent<T = any> {
/** @deprecated */
/**
* @deprecated
*
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/MessageEvent/initMessageEvent)
*/
initMessageEvent(type: string, bubbles?: boolean, cancelable?: boolean, data?: any, origin?: string, lastEventId?: string, source?: MessageEventSource | null, ports?: Iterable<MessagePort>): void;
}

Expand Down
10,778 changes: 9,609 additions & 1,169 deletions baselines/dom.generated.d.ts

Large diffs are not rendered by default.

85 changes: 82 additions & 3 deletions baselines/dom.iterable.generated.d.ts

Large diffs are not rendered by default.

2,691 changes: 2,436 additions & 255 deletions baselines/serviceworker.generated.d.ts

Large diffs are not rendered by default.

73 changes: 71 additions & 2 deletions baselines/serviceworker.iterable.generated.d.ts

Large diffs are not rendered by default.

2,701 changes: 2,440 additions & 261 deletions baselines/sharedworker.generated.d.ts

Large diffs are not rendered by default.

73 changes: 71 additions & 2 deletions baselines/sharedworker.iterable.generated.d.ts

Large diffs are not rendered by default.

2,894 changes: 2,617 additions & 277 deletions baselines/webworker.generated.d.ts

Large diffs are not rendered by default.

73 changes: 71 additions & 2 deletions baselines/webworker.iterable.generated.d.ts

Large diffs are not rendered by default.

7 changes: 6 additions & 1 deletion src/build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@ import { merge, resolveExposure, arrayToMap } from "./build/helpers.js";
import { emitWebIdl } from "./build/emitter.js";
import { convert } from "./build/widlprocess.js";
import { getExposedTypes } from "./build/expose.js";
import { getDeprecationData, getRemovalData } from "./build/bcd.js";
import {
getDeprecationData,
getDocsData,
getRemovalData,
} from "./build/bcd.js";
import { getInterfaceElementMergeData } from "./build/webref/elements.js";
import { getWebidls } from "./build/webref/idl.js";
import jsonc from "jsonc-parser";
Expand Down Expand Up @@ -253,6 +257,7 @@ async function emitDom() {

webidl = merge(webidl, getDeprecationData(webidl));
webidl = merge(webidl, getRemovalData(webidl));
webidl = merge(webidl, getDocsData(webidl));
webidl = prune(webidl, removedItems);
webidl = mergeApiDescriptions(webidl, documentationFromMDN);
webidl = merge(webidl, addedItems);
Expand Down
8 changes: 8 additions & 0 deletions src/build/bcd.ts
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,11 @@ export function getDeprecationData(webidl: Browser.WebIdl): Browser.WebIdl {
}
}) as Browser.WebIdl;
}

export function getDocsData(webidl: Browser.WebIdl): Browser.WebIdl {
return mapToBcdCompat(webidl, ({ compat }) => {
if (compat?.mdn_url) {
return { mdnUrl: compat.mdn_url };
}
}) as Browser.WebIdl;
}
5 changes: 5 additions & 0 deletions src/build/emitter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -841,6 +841,7 @@ export function emitWebIdl(
comment?: string;
deprecated?: boolean | string;
secureContext?: boolean;
mdnUrl?: string;
},
print: (s: string) => void
) {
Expand All @@ -857,6 +858,10 @@ export function emitWebIdl(
if (entity.secureContext) {
comments.push("Available only in secure contexts.");
}
if (entity.mdnUrl) {
if (comments.length > 0) comments.push("");
comments.push(`[MDN Reference](${entity.mdnUrl})`);
}

if (comments.length > 1) {
print("/**");
Expand Down
3 changes: 3 additions & 0 deletions src/build/types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ export interface Property extends Typed {
deprecated?: boolean;
exposed?: string;
secureContext?: boolean;
mdnUrl?: string;
}

export interface Event {
Expand Down Expand Up @@ -88,6 +89,7 @@ export interface AnonymousMethod {
deprecated?: boolean;
signature: Signature[];
secureContext?: boolean;
mdnUrl?: string;
}

export interface Method extends AnonymousMethod {
Expand Down Expand Up @@ -194,6 +196,7 @@ export interface Interface {
};
deprecated?: boolean | string;
secureContext?: boolean;
mdnUrl?: string;
transferable?: boolean;
}

Expand Down