You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This tool is used to generate the DOM related part of `lib.d.ts` for TypeScript, and `domWeb.js` and `domWindows.js` for Visual Studio JavaScript language service. The input file is the XML spec file generated by the Microsoft Edge browser.
1
+
# TypeScript and JavaScript lib generator
2
+
This tool is used to generate `dom.generated.d.ts` and `webworker.generated.d.ts` for TypeScript, and `domWeb.js` and `domWindows.js` for Visual Studio JavaScript language service. The input file is the XML spec file generated by the Microsoft Edge browser.
3
3
4
4
## Build Instruction
5
5
**Required Software**: Visual Studio 2015 Community Version (with Visual F# installed)
@@ -14,9 +14,11 @@ Press `F5` in Visual Studio to run the tool. If it runs successfully, the output
14
14
-`JS.fs`: handles the emitting of the `domWeb.js` and `domWindows.js`
15
15
files used for Visual Studio JavaScript language service;
16
16
-`Program.fs`: entry point of the tool;
17
-
- Inside the `inputfiles` folder:
18
-
-`browser.webidl.xml`: the XML spec file generated by Microsoft Edge (due to the different updating schedules between Edge and TypeScript, this is **not** the most up-to-date version of the spec);
19
-
-`jsTemplate.js`: the initial templates for `domWeb.js` and `domWindows.js`, which contains the necessary helper functions;
20
-
-`additionalSharedTypes.ts`: types should exist in both browser and webworker that are missing from the Edge spec.
21
-
-`additionalDomTypes.ts`: types should exist in only browser that are missing from the Edge spec.
22
-
-`additionalWorkerTypes.ts`: types should exist in only webworker that are missing from the Edge spec.
17
+
18
+
## Input Files:
19
+
-`browser.webidl.xml`: the XML spec file generated by Microsoft Edge (due to the different updating schedules between Edge and TypeScript, this may **not** be the most up-to-date version of the spec.);
20
+
-`addedTypes.json`: types should exist in either browser or webworker that are missing from the Edge spec. The type can be `property`, `method`, `interface`, `constructor`, or `indexer`.
21
+
-`overridingTypes.json`: types that are defined in the spec file but has a better or more up-to-date definitions in the json files.
22
+
-`removedTypes.json`: types that are defined in the spec file but should be removed.
23
+
-`comments.json`:
24
+
-`jsTemplate.js`: the initial templates for `domWeb.js` and `domWindows.js`, which contains the necessary helper functions;
0 commit comments