Go to file
TypeScript Bot 90600e1b17 Update package-lock.json 2021-11-24 06:07:09 +00:00
.devcontainer Add a basic dev container (#42041) 2021-02-16 14:20:15 -08:00
.github Update github workflows node10 -> node16 (#45996) 2021-09-21 16:00:09 -07:00
.vscode Add support for vscode-js-debug's customDescriptionGenerators (#40308) 2020-09-02 20:05:50 -07:00
bin Moved LKG folder to lib 2015-07-27 10:07:07 -07:00
doc Update link to TypeScript-Handbook (#41460) 2020-11-11 16:11:53 -05:00
lib Intl 2021 Updates (#45647) 2021-09-08 10:43:01 +01:00
loc/lcl LEGO: check in for master to temporary branch. 2019-09-10 08:33:38 +00:00
scripts Fix git remote in cherry pick script (#46647) 2021-11-02 12:39:42 -07:00
src Switch deferredNodes from a Map to a Set. (#46751) 2021-11-23 17:46:33 -08:00
tests Plain JS binder errors (#46816) 2021-11-18 17:13:06 -08:00
.dockerignore Unignore the package-lock.json in the root Dockerignore, fixing docker suite tests 2020-09-02 14:31:51 -07:00
.editorconfig Use CRLF, not LF. 2015-03-02 14:38:24 -08:00
.eslintignore Revert 'awaited' type (#37610) 2020-03-25 18:39:45 -07:00
.eslintrc.json Enable `max-statements-per-line` lint rule (#45475) 2021-08-16 13:53:51 -07:00
.gitattributes Never normalize end-of-lines on clone/commit. 2015-05-31 15:45:41 -07:00
.gitignore Update npm in user tests (#42841) 2021-02-18 17:06:58 -08:00
.mailmap Update .mailmap 2018-10-27 20:39:23 +05:30
.npmignore Ignore .devcontainer for npm (#42826) 2021-02-16 15:56:29 -08:00
.yarnrc Adds a yarnrc which makes sure that the lockfile isn't generated for people using Yarn 2019-06-12 11:20:20 -07:00
AUTHORS.md Update the authors script to generate the content of authors.md (#36867) 2020-02-27 12:47:09 -05:00
CODE_OF_CONDUCT.md Added Microsoft code of conduct file 2018-10-05 22:10:20 +01:00
CONTRIBUTING.md Update CONTRIBUTING.md (#45552) 2021-08-24 08:15:15 +01:00
CopyrightNotice.txt Remove trailing whitespace from copyright notice (#36886) 2020-02-20 09:46:50 -08:00
Dockerfile Adopt package-lock.json and npm ci 2020-08-19 16:50:23 -07:00
Gulpfile.js Remove unused code coverage command (#45684) 2021-09-01 15:39:10 -07:00
LICENSE.txt Add snapshot of compiler sources 2014-07-12 17:30:19 -07:00
README.md Switch references to master to main in the codebase + validating infra post-main migration (#44347) 2021-06-01 20:44:18 +01:00
SECURITY.md Create SECURITY.md (#45474) 2021-08-16 13:54:30 -07:00
ThirdPartyNoticeText.txt Update ThirdPartyNoticeText to include KhronosGroup copyright notice for WebGL. 2018-07-31 12:49:13 -07:00
package-lock.json Update package-lock.json 2021-11-24 06:07:09 +00:00
package.json Bump version to 4.6 and accept baselines. (#46612) 2021-11-01 11:45:22 -07:00

README.md

TypeScript

GitHub Actions CI Devops Build Status npm version Downloads

TypeScript is a language for application-scale JavaScript. TypeScript adds optional types to JavaScript that support 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.

Find others who are using TypeScript at our community page.

Installing

For the latest stable version:

npm install -g typescript

For our nightly builds:

npm install -g typescript@next

Contribute

There are many ways to contribute to TypeScript.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Building

In order to build the TypeScript compiler, ensure that you have Git and Node.js installed.

Clone a copy of the repo:

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

Change to the TypeScript directory:

cd TypeScript

Install Gulp tools and dev dependencies:

npm install -g gulp
npm ci

Use one of the following to build and test:

gulp local             # Build the compiler into built/local.
gulp clean             # Delete the built compiler.
gulp LKG               # Replace the last known good with the built one.
                       # Bootstrapping step to be executed when the built compiler reaches a stable state.
gulp tests             # Build the test infrastructure using the built compiler.
gulp runtests          # Run tests using the built compiler and test infrastructure.
                       # You can override the specific suite runner used or specify a test for this command.
                       # Use --tests=<testPath> for a specific test and/or --runner=<runnerName> for a specific suite.
                       # Valid runners include conformance, compiler, fourslash, project, user, and docker
                       # The user and docker runners are extended test suite runners - the user runner
                       # works on disk in the tests/cases/user directory, while the docker runner works in containers.
                       # You'll need to have the docker executable in your system path for the docker runner to work.
gulp runtests-parallel # Like runtests, but split across multiple threads. Uses a number of threads equal to the system
                       # core count by default. Use --workers=<number> to adjust this.
gulp baseline-accept   # This replaces the baseline test results with the results obtained from gulp runtests.
gulp lint              # Runs eslint on the TypeScript source.
gulp help              # 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.