--- /dev/null
+\r
+# TypeScript\r
+\r
+[](https://github.com/microsoft/TypeScript/actions?query=workflow%3ACI)\r
+[](https://dev.azure.com/typescript/TypeScript/_build?definitionId=7)\r
+[](https://www.npmjs.com/package/typescript)\r
+[](https://www.npmjs.com/package/typescript)\r
+\r
+[TypeScript](https://www.typescriptlang.org/) 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](https://www.typescriptlang.org/play/), and stay up to date via [our blog](https://blogs.msdn.microsoft.com/typescript) and [Twitter account](https://twitter.com/typescript).\r
+\r
+Find others who are using TypeScript at [our community page](https://www.typescriptlang.org/community/).\r
+\r
+## Installing\r
+\r
+For the latest stable version:\r
+\r
+```bash\r
+npm install -g typescript\r
+```\r
+\r
+For our nightly builds:\r
+\r
+```bash\r
+npm install -g typescript@next\r
+```\r
+\r
+## Contribute\r
+\r
+There are many ways to [contribute](https://github.com/microsoft/TypeScript/blob/master/CONTRIBUTING.md) to TypeScript.\r
+* [Submit bugs](https://github.com/microsoft/TypeScript/issues) and help us verify fixes as they are checked in.\r
+* Review the [source code changes](https://github.com/microsoft/TypeScript/pulls).\r
+* Engage with other TypeScript users and developers on [StackOverflow](https://stackoverflow.com/questions/tagged/typescript).\r
+* Help each other in the [TypeScript Community Discord](https://discord.gg/typescript).\r
+* Join the [#typescript](https://twitter.com/search?q=%23TypeScript) discussion on Twitter.\r
+* [Contribute bug fixes](https://github.com/microsoft/TypeScript/blob/master/CONTRIBUTING.md).\r
+* Read the archived language specification ([docx](https://github.com/microsoft/TypeScript/blob/master/doc/TypeScript%20Language%20Specification%20-%20ARCHIVED.docx?raw=true),\r
+ [pdf](https://github.com/microsoft/TypeScript/blob/master/doc/TypeScript%20Language%20Specification%20-%20ARCHIVED.pdf?raw=true), [md](https://github.com/microsoft/TypeScript/blob/master/doc/spec-ARCHIVED.md)).\r
+\r
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see\r
+the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com)\r
+with any additional questions or comments.\r
+\r
+## Documentation\r
+\r
+* [TypeScript in 5 minutes](https://www.typescriptlang.org/docs/handbook/typescript-in-5-minutes.html)\r
+* [Programming handbook](https://www.typescriptlang.org/docs/handbook/basic-types.html)\r
+* [Homepage](https://www.typescriptlang.org/)\r
+\r
+## Building\r
+\r
+In order to build the TypeScript compiler, ensure that you have [Git](https://git-scm.com/downloads) and [Node.js](https://nodejs.org/) installed.\r
+\r
+Clone a copy of the repo:\r
+\r
+```bash\r
+git clone https://github.com/microsoft/TypeScript.git\r
+```\r
+\r
+Change to the TypeScript directory:\r
+\r
+```bash\r
+cd TypeScript\r
+```\r
+\r
+Install [Gulp](https://gulpjs.com/) tools and dev dependencies:\r
+\r
+```bash\r
+npm install -g gulp\r
+npm ci\r
+```\r
+\r
+Use one of the following to build and test:\r
+\r
+```\r
+gulp local # Build the compiler into built/local.\r
+gulp clean # Delete the built compiler.\r
+gulp LKG # Replace the last known good with the built one.\r
+ # Bootstrapping step to be executed when the built compiler reaches a stable state.\r
+gulp tests # Build the test infrastructure using the built compiler.\r
+gulp runtests # Run tests using the built compiler and test infrastructure.\r
+ # You can override the specific suite runner used or specify a test for this command.\r
+ # Use --tests=<testPath> for a specific test and/or --runner=<runnerName> for a specific suite.\r
+ # Valid runners include conformance, compiler, fourslash, project, user, and docker\r
+ # The user and docker runners are extended test suite runners - the user runner\r
+ # works on disk in the tests/cases/user directory, while the docker runner works in containers.\r
+ # You'll need to have the docker executable in your system path for the docker runner to work.\r
+gulp runtests-parallel # Like runtests, but split across multiple threads. Uses a number of threads equal to the system\r
+ # core count by default. Use --workers=<number> to adjust this.\r
+gulp baseline-accept # This replaces the baseline test results with the results obtained from gulp runtests.\r
+gulp lint # Runs eslint on the TypeScript source.\r
+gulp help # List the above commands.\r
+```\r
+\r
+\r
+## Usage\r
+\r
+```bash\r
+node built/local/tsc.js hello.ts\r
+```\r
+\r
+\r
+## Roadmap\r
+\r
+For details on our planned features and future direction please refer to our [roadmap](https://github.com/microsoft/TypeScript/wiki/Roadmap).\r
projects / dotfiles / .git / blobdiff