MDN description V2 #2171

Bashamega · 2025-09-29T08:56:01Z

Migrate to be using the json API
closes #2151
closes #2086
closes #2078

saschanaz · 2025-09-29T16:52:58Z

baselines/dom.iterable.generated.d.ts

+     * The
+     * setValueCurveAtTime() method of the
+     * AudioParam interface schedules the parameter's value to change
+     * following a curve defined by a list of values.


newline-to-space normalization seems to be needed.

saschanaz · 2025-09-29T16:54:23Z

src/build/mdn-comments.ts

-import fs from "fs/promises";
-const basePath = new URL("../../inputfiles/mdn/files/en-us/", import.meta.url);
+import { readFile } from "fs/promises";
+const inputFile = new URL("../../inputfiles/mdn/mdnData.json", import.meta.url);


Maybe just inputfiles/mdn.json? And you can do import * as data from "(path)" with { type: "json" }

saschanaz · 2025-09-29T16:56:17Z

src/build/mdn-comments.ts

+import { readFile } from "fs/promises";
+const inputFile = new URL("../../inputfiles/mdn/mdnData.json", import.meta.url);
+
+interface MetaDataEntry {


I don't think we should treat meta and data separately, let's do Metadata.

Bashamega · 2025-09-30T10:00:20Z

I have updated it @saschanaz,
But the import JSON file didn't work for some reason.
This is the error: https://github.com/microsoft/TypeScript-DOM-lib-generator/actions/runs/18124591077/job/51576830796?pr=2171

jakebailey · 2025-09-30T17:56:40Z

baselines/ts5.5/audioworklet.generated.d.ts

-    /**
-     * The **`console.trace()`** static method outputs a stack trace to the console.
-     *
-     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/trace_static)
-     */
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/console/trace_static) */
    trace(...data: any[]): void;


Seems like these docs are missing?

saschanaz

I think you reverted too early. The module error doesn't happen locally.

saschanaz · 2025-09-30T20:41:16Z

.github/workflows/update-core-deps.yml

+                | (startswith("/en-us/docs/web/api/") or startswith("/en-us/docs/webassembly/reference/javascript_interface/")))
+              )
+              | { mdn_url, pageType, summary } ] }' \
+            > mdn.json


Why do bash magic when we can filter it in the script instead?

Bashamega · 2025-10-01T05:53:44Z

The module error also occurs on my local machine (Ubuntu), @saschanaz.

I used the bash magic because it significantly reduces the output size — most of the data isn’t needed.
For comparison:

Current (filtered and formatted): 2.5 MB

Original (unfiltered, unformatted): 28.7 MB

That’s over 11× larger (28.7 MB vs 2.5 MB), so I think the extra shell step is worth it.
Plus, the command is still quite readable.

Bashamega · 2025-10-01T06:04:59Z

I’ve added support for _static, so there is no missing comments now, @jakebailey.

saschanaz · 2025-10-01T08:57:07Z

The module error also occurs on my local machine (Ubuntu), @saschanaz.

Are you seeing the exact same module error? Because that error says you don't have lib/build.js, which means typescript silently failed to compile anything at all. Can you check what's in lib/ in that case?

I used the bash magic because it significantly reduces the output size — most of the data isn’t needed. For comparison:

Current (filtered and formatted): 2.5 MB

Original (unfiltered, unformatted): 28.7 MB

That’s over 11× larger (28.7 MB vs 2.5 MB), so I think the extra shell step is worth it. Plus, the command is still quite readable.

Hmm, fair. I think we should still fetch and filter in typescript instead, as bash usage would break on Windows.

saschanaz · 2025-10-01T09:00:03Z

Or well, in JS, to save a build step.

Bashamega · 2025-10-01T09:08:29Z

Hmm, fair. I think we should still fetch and filter in typescript instead, as bash usage would break on Windows.

I don't think that this is an issue, since no one would actually run it, but sure, I will write a script to generate the file

Bashamega · 2025-10-01T09:11:16Z

Are you seeing the exact same module error? Because that error says you don't have lib/build.js, which means typescript silently failed to compile anything at all. Can you check what's in lib/ in that case?
Yes, it is the same error

saschanaz · 2025-10-01T11:02:07Z

Can you check what's in lib/ in that case?

Bashamega · 2025-10-01T13:24:03Z

Here

Bashamega · 2025-10-02T13:26:09Z

I have removed the bash magic @saschanaz

saschanaz

Looks good, but this will need to update with the latest main branch.

saschanaz · 2025-10-04T19:32:25Z

.github/workflows/update-core-deps.yml

      # Example: https://github.com/microsoft/TypeScript-DOM-lib-generator/pull/1463
      - run: npm i
+      - name: Update MDN Data
+        run: node scripts/generateMDN


We are not really generating but more fetching.

really not a fan of camelCasing on file paths though 🫠

I do recognize we have deploy/ which is mostly written by Orta than me, and we do have jsonc files that preexisted, but any new files have been hyphen-cased...

saschanaz · 2025-10-04T19:38:37Z

src/build/mdn-comments.ts

  }
 }

+function extractSlug(slug: string): string[] {


Why reorder the function? Almost thought this is an entirely new function with the same name.. Keeping its position should help reducing the diff.

Bashamega · 2025-10-05T03:39:32Z

I have renamed it, and rebased it @saschanaz

jakebailey · 2025-10-05T06:04:44Z

baselines/ts5.5/dom.iterable.generated.d.ts

 interface RTCRtpTransceiver {
    /**
-     * The **`setCodecPreferences()`** method of the RTCRtpTransceiver interface is used to set the codecs that the transceiver allows for decoding _received_ data, in order of decreasing preference.
+     * The setCodecPreferences() method of the RTCRtpTransceiver interface is used to set the codecs that the transceiver allows for decoding received data, in order of decreasing preference.


Are we just generally losing all markup?

Yes, because the JSON doesn't have Markdown

Yeah. We could hack around by matching the first occurrence of the name though...

This PR is big as is, maybe a separate PR

Technically hacking around would reduce the size of the PR.

(You can open PR on my fork and then I can try it)

Okay, I will hack it today

MDN description V2

b6c27ba

github-actions bot added the maintainers label Sep 29, 2025

github-actions bot assigned jakebailey and sandersn Sep 29, 2025

Bashamega added 5 commits September 29, 2025 11:57

-

edaed97

-

3b35959

-

6c1718d

merge

a6a9114

-

d6385ab

saschanaz reviewed Sep 29, 2025

View reviewed changes

Bashamega added 3 commits September 30, 2025 11:46

-

2bc6046

-

6fe5feb

Fix issues

5aec97d

jakebailey reviewed Sep 30, 2025

View reviewed changes

saschanaz reviewed Sep 30, 2025

View reviewed changes

Support _static

5ff1712

Merge branch 'microsoft:main' into mdn-v2

2d28438

Bashamega and others added 4 commits October 2, 2025 14:48

Merge branch 'main' into mdn-v2

8a91389

Remove magic

9aa7798

-

e563d35

-

9495a53

lint

01ee6ae

saschanaz reviewed Oct 4, 2025

View reviewed changes

saschanaz mentioned this pull request Oct 4, 2025

Use plaintext part of the MDN template #2078

Closed

Bashamega added 2 commits October 5, 2025 06:33

Merge Branch

fb61574

Rename

1391752

jakebailey reviewed Oct 5, 2025

View reviewed changes

Bashamega added 6 commits October 5, 2025 14:07

Add MD

a3fdd43

-

b6c62b7

-

23fe8a8

Make it local

9e27775

-

07acc6d

Fix with quotes

5b06526

MDN description V2 #2171

Are you sure you want to change the base?

MDN description V2 #2171

Conversation

Bashamega commented Sep 29, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Bashamega commented Sep 30, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

saschanaz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Bashamega commented Oct 1, 2025

Uh oh!

Bashamega commented Oct 1, 2025

Uh oh!

saschanaz commented Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

saschanaz commented Oct 1, 2025

Uh oh!

Bashamega commented Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Bashamega commented Oct 1, 2025

Uh oh!

saschanaz commented Oct 1, 2025

Uh oh!

Bashamega commented Oct 1, 2025

Uh oh!

Bashamega commented Oct 2, 2025

Uh oh!

saschanaz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Bashamega commented Oct 5, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

saschanaz commented Oct 1, 2025 •

edited

Loading

Bashamega commented Oct 1, 2025 •

edited

Loading