Merge pull request #383 from Microsoft/convertToTS

Convert generation script to TS, and update the source webidl

Author: mhegazy

.gitignore

@@ -278,15 +278,6 @@ __pycache__/
 # tools/**
 # !tools/packages.config
 
-# Telerik's JustMock configuration file
-*.jmconfig
-
-# BizTalk build output
-*.btp.cs
-*.btm.cs
-*.odx.cs
-*.xsd.cs
-
-.paket/
-.fake/
-generated/
+generated/
+lib/
+inputfiles/browser.webidl.json

.travis.yml

@@ -1,6 +1,10 @@
-language: csharp
-mono:
-  - latest
+language: node_js
 
-script:
-  - ./build.sh
+node_js:
+  - 'stable'
+
+sudo: false
+
+install:
+  - npm uninstall typescript --no-save
+  - npm install

README.md

@@ -4,14 +4,27 @@ AppVeyor Status: [![Build status](https://ci.appveyor.com/api/projects/status/8o
 Travis CI Status: [![Build Status](https://travis-ci.org/Microsoft/TSJS-lib-generator.svg?branch=master)](https://travis-ci.org/Microsoft/TSJS-lib-generator)
 
 This tool is used to generate `dom.generated.d.ts`, `webworker.generated.d.ts` and `dom.es6.generated.d.ts` for TypeScript.
-The input file is the XML spec file generated by the Microsoft Edge browser.
+The input file is the JSON webidl file generated by the Microsoft Edge browser.
 
 ## Build Instructions
 
-To build the tool, simply clone this repo, and run `build.cmd` (Windows) or `build.sh` (OS X/Unix) on the command line.
-If it runs successfully, the output files will be generated under the `generated` folder.
+To get things setup:
 
-Note: for OS X and Unix users, [Mono 4.2 or higher](http://www.mono-project.com/download/) is required.
+```sh
+npm install
+```
+
+To generate the .d.ts files
+
+```sh
+npm run build
+```
+
+To test:
+
+```sh
+npm run test
+```
 
 ## Contribution Guidelines
 
@@ -22,7 +35,7 @@ In order to make the tests pass, please update the baseline as well in any pull
 For common changes, it is sufficient to change the json files.
 There are three json files that are typically used to alter the type generation: `addedTypes.json`, `overridingTypes.json`, and `removedTypes.json`.
 `comments.json` can used to add comments to the types.
-Finally, `knownWorkerEnums` and `knownWorkerInterfaces` determine which types are available in a WebWorker environment.
+Finally, `knownWorkerTypes.json` determine which types are available in a WebWorker environment.
 
 The format of each file can be inferred from their existing content.
 
@@ -53,16 +66,15 @@ A "Living Standard" ([example](https://xhr.spec.whatwg.org/)) should be added he
 
 ## Code Structure
 
-- `Build.fsx`: Runs `TS.fsx` for all targets, then does a snapshot test by comparing the `generated/` and `baseline/` contents.
-- `TS.fsx`: handles the emitting of the `.d.ts` files.
+- `src/index.ts`: handles the emitting of the `.d.ts` files.
+- `src/test.ts`: verifies the otuput by comparing the `generated/` and `baseline/` contents.
+
 
 ## Input Files
 
-- `browser.webidl.xml`: an XML spec file generated by Microsoft Edge. **Do not edit this file**.
+- `browser.webidl.preprocessed.json`: a JSON file generated by Microsoft Edge. **Do not edit this file**.
     - Due to the different update schedules between Edge and TypeScript, this may not be the most up-to-date version of the spec.
-- `webworker.webidl.xml`: an XML spec file generated by Microsoft Edge that contains types for Web Workers. **Do not edit this file**.
-- `addedTypes.json`: types that should exist in either browser or webworker but are missing from the Edge spec. The type can be `property`, `method`, `interface`, `constructor`, or `indexer`.
+- `addedTypes.json`: types that should exist in either browser or webworker but are missing from the Edge spec. The format of the file mimics that of `browser.webidl.preprocessed.json`.
 - `overridingTypes.json`: types that are defined in the spec file but has a better or more up-to-date definitions in the json files.
 - `removedTypes.json`: types that are defined in the spec file but should be removed.
 - `comments.json`: comment strings to be embedded in the generated .js files.
-- `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. **Do not edit this file**.