Skip to content

Commit 1df86e0

Browse files
authored
Update README.md
1 parent 218ad19 commit 1df86e0

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
AppVeyor Status: [![Build status](https://ci.appveyor.com/api/projects/status/8oj3j7u6nvag1xvu/branch/master?svg=true)](https://ci.appveyor.com/project/zhengbli/tsjs-lib-generator/branch/master)
44
Travis CI Status: [![Build Status](https://travis-ci.org/Microsoft/TSJS-lib-generator.svg?branch=master)](https://travis-ci.org/Microsoft/TSJS-lib-generator)
55

6-
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.
6+
This tool is used to generate `dom.generated.d.ts`, `webworker.generated.d.ts` an`dom.es6.generated.d.ts` for TypeScript.
77
The input file is the XML spec file generated by the Microsoft Edge browser.
88

99
## Build Instructions
@@ -15,7 +15,7 @@ Note: for OS X and Unix users, [Mono 4.2 or higher](http://www.mono-project.com/
1515

1616
## Contribution Guidelines
1717

18-
The `dom.generated.d.ts` and `webworker.generated.d.ts` files in the TypeScript repo are used as baselines.
18+
The `dom.generated.d.ts`, `webworker.generated.d.ts` an`dom.es6.generated.d.ts` files from the TypeScript repo are used as baselines.
1919
For each pull request, we will run the script and compare the generated files with the baseline files.
2020
In order to make the tests pass, please update the baseline as well in any pull requests.
2121

@@ -50,9 +50,8 @@ A "Living Standard" ([example](https://xhr.spec.whatwg.org/)) should be added he
5050

5151
## Code Structure
5252

53-
- `Shared.fs`: handles the parsing from XML spec file, and stores the common data structures for later use.
54-
- `TS.fs`: handles the emitting of the `lib.d.ts` file.
55-
- `JS.fs`: handles the emitting of the `domWeb.js` and `domWindows.js`.
53+
- `Build.fsx`: Runs `TS.fsx` for all targets, then does a snapshot test by comparing the `generated/` and `baseline/` contents.
54+
- `TS.fsx`: handles the emitting of the `.d.ts` files.
5655

5756
## Input Files
5857

@@ -63,5 +62,4 @@ A "Living Standard" ([example](https://xhr.spec.whatwg.org/)) should be added he
6362
- `overridingTypes.json`: types that are defined in the spec file but has a better or more up-to-date definitions in the json files.
6463
- `removedTypes.json`: types that are defined in the spec file but should be removed.
6564
- `comments.json`: comment strings to be embedded in the generated .js files.
66-
- `jsTemplate.js`: the initial templates for `domWeb.js` and `domWindows.js`, which contains the necessary helper functions.
6765
- `sample.json`: sample json file used to tell F# json type provider that structure of the json files. The content of it is not used anywhere.

0 commit comments

Comments
 (0)