|
1 | 1 | # TypeScript and JavaScript lib generator
|
2 | 2 |
|
3 |
| -Travis CI Status: [](https://travis-ci.org/Microsoft/TSJS-lib-generator) |
| 3 | +This tool is used to generate the web-based `lib.dom.d.ts` file which is included with TypeScript releases, and as the `@types/web` package. |
4 | 4 |
|
5 |
| -This tool is used to generate `dom.generated.d.ts`, `webworker.generated.d.ts` and `dom.iterable.generated.d.ts` for TypeScript. |
6 |
| -The input file is the JSON webidl file generated by the Microsoft Edge browser. |
| 5 | +## Why is my fancy API still not available here? |
| 6 | + |
| 7 | +A feature needs to be supported by more than two major browser engines to be included here, to make sure there is a good consensus among vendors: __Gecko__ (Firefox), __Blink__ (Chrome/Edge), and __WebKit__ (Safari). |
| 8 | + |
| 9 | +If the condition is met but still is not available here, please [file an issue](hthttps://github.com/microsoft/TypeScript-DOM-lib-generator/issues/new). |
7 | 10 |
|
8 | 11 | ## Build Instructions
|
9 | 12 |
|
@@ -53,11 +56,10 @@ The format of each file can be inferred from their existing content.
|
53 | 56 |
|
54 | 57 | The common steps to send a pull request are:
|
55 | 58 |
|
56 |
| -0. Open or refer to an issue in the [TypeScript repo](https://github.com/Microsoft/TypeScript). |
57 |
| -1. Add missing elements to `inputfiles/addedTypes.json`, overriding elements to `inputfiles/overridingTypes.json`, or elements to remove to `inputfiles/removedTypes.json`. |
| 59 | +0. Open or refer to an issue in the [TypeScript repo](https://github.com/Microsoft/TypeScript) which might get moved back to this repo. |
| 60 | +1. Update an IDL or add missing elements to `inputfiles/addedTypes.json`, overriding elements to `inputfiles/overridingTypes.json`, or elements to remove to `inputfiles/removedTypes.json`. |
58 | 61 | 2. Run the build script locally to obtain new `dom.generated.d.ts` and `webworker.generated.d.ts`.
|
59 |
| -3. Update the files in the `baselines` folder using the newly generated files |
60 |
| - under `generated` folder (`npm run baseline-accept`). |
| 62 | +3. Update the files in the `baselines` folder using the newly generated files under `generated` folder (`npm run baseline-accept`). |
61 | 63 |
|
62 | 64 | ### What are the TypeScript team's heuristics for PRs to the DOM APIs
|
63 | 65 |
|
@@ -95,6 +97,8 @@ To give you a sense of whether we will accept changes, you can use these heurist
|
95 | 97 | - Does an internet search for the fields show results in blogs/recommendations?
|
96 | 98 | - When was the deprecation (this can be hard to find) but was it at least 2 years ago if so?
|
97 | 99 |
|
| 100 | +## Build Instructions |
| 101 | + |
98 | 102 | # This repo
|
99 | 103 |
|
100 | 104 | ## Code Structure
|
|
0 commit comments