Go to file

Micah Zoltu 386eeee856 Never normalize end-of-lines on clone/commit.		2015-05-31 15:45:41 -07:00
.settings	Adjusted spacing in tasks.json	2015-05-19 10:56:46 -07:00
bin	Update LKG	2015-05-15 10:35:06 -07:00
doc	Add SVG version of logo as per #1375	2015-04-22 00:57:59 +01:00
scripts	Add script to create a benchmark test using the compiler	2015-04-24 11:00:14 -07:00
src	Addressing CR feedback	2015-05-30 17:11:38 -07:00
tests	Accepting new baselines	2015-05-30 11:41:33 -07:00
.editorconfig	Use CRLF, not LF.	2015-03-02 14:38:24 -08:00
.gitattributes	Never normalize end-of-lines on clone/commit.	2015-05-31 15:45:41 -07:00
.gitignore	Merge pull request #3156 from Microsoft/codeSettings	2015-05-19 10:58:04 -07:00
.npmignore	Fixes helpers in strict mode	2015-05-01 10:49:54 -07:00
.travis.yml	Remove CodeClimate stuff	2015-03-17 12:15:13 -07:00
CONTRIBUTING.md	Update CONTRIBUTING.md	2015-04-01 16:16:04 -07:00
CopyrightNotice.txt	Add snapshot of compiler sources	2014-07-12 17:30:19 -07:00
Jakefile.js	Parsing support for jsDocComments.	2015-05-28 10:14:18 -07:00
LICENSE.txt	Add snapshot of compiler sources	2014-07-12 17:30:19 -07:00
package.json	Initial PR feedback	2015-05-20 16:38:13 -07:00
README.md	Added Gitter badge	2015-05-22 18:26:48 +00:00
ThirdPartyNoticeText.txt	Remove unused third party tools	2014-09-18 11:49:40 -07:00

README.md

TypeScript

TypeScript is a language for application-scale JavaScript. TypeScript adds optional types, classes, and modules to JavaScript. TypeScript supports tools for large-scale JavaScript applications for any browser, for any host, on any OS. TypeScript compiles to readable, standards-based JavaScript. Try it out at the playground, and stay up to date via our blog and twitter account.

Contribute

There are many ways to contribute to TypeScript.

Submit bugs and help us verify fixes as they are checked in.
Review the source code changes.
Engage with other TypeScript users and developers on StackOverflow.
Join the #typescript discussion on Twitter.
Contribute bug fixes.
Read the language specification (docx, pdf).

Documentation

Building

In order to build the TypeScript compiler, ensure that you have Git and Node.js installed. Note that you need to have autocrlf off as we track whitespace changes (git config --global core.autocrlf false).

Clone a copy of the repo:

git clone https://github.com/Microsoft/TypeScript.git

Change to the TypeScript directory:

cd TypeScript

Install Jake tools and dev dependencies:

npm install -g jake
npm install

Use one of the following to build and test:

jake local            # Build the compiler into built/local 
jake clean            # Delete the built compiler 
jake LKG              # Replace the last known good with the built one.
                      # Bootstrapping step to be executed when the built compiler reaches a stable state.
jake tests            # Build the test infrastructure using the built compiler. 
jake runtests         # Run tests using the built compiler and test infrastructure. 
                      # You can override the host or specify a test for this command. 
                      # Use host=<hostName> or tests=<testPath>. 
jake runtests-browser # Runs the tests using the built run.js file. Syntax is jake runtests. Optional
                        parameters 'host=', 'tests=[regex], reporter=[list|spec|json|<more>]'.
jake baseline-accept  # This replaces the baseline test results with the results obtained from jake runtests. 
jake -T               # List the above commands.

Usage

node built/local/tsc.js hello.ts

Roadmap

For details on our planned features and future direction please refer to our roadmap.