-
Notifications
You must be signed in to change notification settings - Fork 12.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from Microsoft/master
update
- Loading branch information
Showing
5,997 changed files
with
216,056 additions
and
120,901 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,14 @@ | ||
| built | ||
| doc | ||
| lib/README.md | ||
| scripts | ||
| src | ||
| tests | ||
| internal | ||
| tslint.json | ||
| Jakefile.js | ||
| .travis.yml | ||
| .editorconfig | ||
| .gitattributes | ||
| .settings/ | ||
| .travis.yml | ||
| .vscode/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,8 @@ | ||
| language: node_js | ||
|
|
||
| node_js: | ||
| - 'stable' | ||
| - '4' | ||
| - '0.10' | ||
|
|
||
| sudo: false | ||
| sudo: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,21 @@ | ||
| ## Contributing bug fixes | ||
|
|
||
| TypeScript is currently accepting contributions in the form of bug fixes. A bug must have an issue tracking it in the issue tracker that has been approved ("Milestone == Community") by the TypeScript team. Your pull request should include a link to the bug that you are fixing. If you've submitted a PR for a bug, please post a comment in the bug to avoid duplication of effort. | ||
|
|
||
| ## Contributing features | ||
|
|
||
| Features (things that add new or improved functionality to TypeScript) may be accepted, but will need to first be approved (marked as "Milestone == Community" by a TypeScript coordinator with the message "Approved") in the suggestion issue. Features with language design impact, or that are adequately satisfied with external tools, will not be accepted. | ||
|
|
||
| Design changes will not be accepted at this time. If you have a design change proposal, please log a suggestion issue. | ||
|
|
||
| ## Legal | ||
|
|
||
| You will need to complete a Contributor License Agreement (CLA). Briefly, this agreement testifies that you are granting us permission to use the submitted change according to the terms of the project's license, and that the work being submitted is under appropriate copyright. | ||
|
|
||
| Please submit a Contributor License Agreement (CLA) before submitting a pull request. You may visit https://cla.microsoft.com to sign digitally. Alternatively, download the agreement ([Microsoft Contribution License Agreement.docx](https://www.codeplex.com/Download?ProjectName=typescript&DownloadId=822190) or [Microsoft Contribution License Agreement.pdf](https://www.codeplex.com/Download?ProjectName=typescript&DownloadId=921298)), sign, scan, and email it back to <[email protected]>. Be sure to include your github user name along with the agreement. Once we have received the signed CLA, we'll review the request. | ||
|
|
||
| ## Housekeeping | ||
|
|
||
| Your pull request should: | ||
|
|
||
| * Include a description of what your change intends to do | ||
|
|
@@ -28,8 +32,24 @@ Your pull request should: | |
| * Follow the code conventions descriped in [Coding guidelines](https://github.com/Microsoft/TypeScript/wiki/Coding-guidelines) | ||
| * To avoid line ending issues, set `autocrlf = input` and `whitespace = cr-at-eol` in your git configuration | ||
|
|
||
| ## Contributing `lib.d.ts` fixes | ||
|
|
||
| The library sources are in: [src/lib](https://github.com/Microsoft/TypeScript/tree/master/src/lib) | ||
|
|
||
| Library files in `built/local/` are updated by running | ||
| ```Shell | ||
| jake | ||
| ``` | ||
|
|
||
| The files in `lib/` are used to bootstrap compilation and usually do not need to be updated. | ||
|
|
||
| #### `src/lib/dom.generated.d.ts` and `src/lib/webworker.generated.d.ts` | ||
|
|
||
| These two files represent the DOM typings and are auto-generated. To make any modifications to them, please submit a PR to https://github.com/Microsoft/TSJS-lib-generator | ||
|
|
||
| ## Running the Tests | ||
| To run all tests, invoke the runtests target using jake: | ||
|
|
||
| To run all tests, invoke the `runtests` target using jake: | ||
|
|
||
| ```Shell | ||
| jake runtests | ||
|
|
@@ -47,23 +67,42 @@ e.g. to run all compiler baseline tests: | |
| jake runtests tests=compiler | ||
| ``` | ||
|
|
||
| or to run specifc test: `tests\cases\compiler\2dArrays.ts` | ||
| or to run a specific test: `tests\cases\compiler\2dArrays.ts` | ||
|
|
||
| ```Shell | ||
| jake runtests tests=2dArrays | ||
| ``` | ||
|
|
||
| ## Debugging the tests | ||
|
|
||
| To debug the tests, invoke the `runtests-browser` task from jake. | ||
| You will probably only want to debug one test at a time: | ||
|
|
||
| ```Shell | ||
| jake runtests-browser tests=2dArrays | ||
| ``` | ||
|
|
||
| You can specify which browser to use for debugging. Currently Chrome and IE are supported: | ||
|
|
||
| ```Shell | ||
| jake runtests-browser tests=2dArrays browser=chrome | ||
| ``` | ||
|
|
||
| You can debug with VS Code or Node instead with `jake runtests debug=true`: | ||
|
|
||
| ```Shell | ||
| jake runtests tests=2dArrays debug=true | ||
| ``` | ||
|
|
||
| ## Adding a Test | ||
| To add a new testcase, simply place a `.ts` file in `tests\cases\compiler` containing code that exemplifies the bugfix or change you are making. | ||
|
|
||
| These files support metadata tags in the format `// @metaDataName: value`. The supported names and values are: | ||
| To add a new test case, simply place a `.ts` file in `tests\cases\compiler` containing code that exemplifies the bugfix or change you are making. | ||
|
|
||
| * `comments`, `sourcemap`, `noimplicitany`, `declaration`: true or false (corresponds to the compiler command-line options of the same name) | ||
| * `target`: ES3 or ES5 (same as compiler) | ||
| * `out`, outDir: path (same as compiler) | ||
| * `module`: local, commonjs, or amd (local corresponds to not passing any compiler --module flag) | ||
| * `fileName`: path | ||
| * These tags delimit sections of a file to be used as separate compilation units. They are useful for tests relating to modules. See below for examples. | ||
| These files support metadata tags in the format `// @metaDataName: value`. | ||
| The supported names and values are the same as those supported in the compiler itself, with the addition of the `fileName` flag. | ||
| `fileName` tags delimit sections of a file to be used as separate compilation units. | ||
| They are useful for tests relating to modules. | ||
| See below for examples. | ||
|
|
||
| **Note** that if you have a test corresponding to a specific spec compliance item, you can place it in `tests\cases\conformance` in an appropriately-named subfolder. | ||
| **Note** that filenames here must be distinct from all other compiler testcase names, so you may have to work a bit to find a unique name if it's something common. | ||
|
|
@@ -86,6 +125,7 @@ var x = g(); | |
| One can also write a project test, but it is slightly more involved. | ||
|
|
||
| ## Managing the Baselines | ||
|
|
||
| Compiler testcases generate baselines that track the emitted `.js`, the errors produced by the compiler, and the type of each expression in the file. Additionally, some testcases opt in to baselining the source map output. | ||
|
|
||
| When a change in the baselines is detected, the test will fail. To inspect changes vs the expected baselines, use | ||
|
|
@@ -102,4 +142,4 @@ jake baseline-accept | |
|
|
||
| to establish the new baselines as the desired behavior. This will change the files in `tests\baselines\reference`, which should be included as part of your commit. It's important to carefully validate changes in the baselines. | ||
|
|
||
| **Note** that baseline-accept should only be run after a full test run! Accepting baselines after running a subset of tests will delete baseline files for the tests that didn't run. | ||
| **Note** that `baseline-accept` should only be run after a full test run! Accepting baselines after running a subset of tests will delete baseline files for the tests that didn't run. | ||
Oops, something went wrong.