c610b98621
Moved all the badges below the Typescript Heading as its nice to keep all badges together. Earlier it gitter badge was below only.
100 lines
4.6 KiB
Markdown
100 lines
4.6 KiB
Markdown
|
|
# TypeScript
|
|
|
|
[](https://gitter.im/Microsoft/TypeScript?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
[](https://travis-ci.org/Microsoft/TypeScript)
|
|
[](https://dev.azure.com/typescript/TypeScript/_build/latest?definitionId=4&view=logs)
|
|
[](https://www.npmjs.com/package/typescript)
|
|
[](https://www.npmjs.com/package/typescript)
|
|
|
|
|
|
|
|
[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).
|
|
|
|
## Installing
|
|
|
|
For the latest stable version:
|
|
|
|
```bash
|
|
npm install -g typescript
|
|
```
|
|
|
|
For our nightly builds:
|
|
|
|
```bash
|
|
npm install -g typescript@next
|
|
```
|
|
|
|
## Contribute
|
|
|
|
There are many ways to [contribute](https://github.com/Microsoft/TypeScript/blob/master/CONTRIBUTING.md) to TypeScript.
|
|
* [Submit bugs](https://github.com/Microsoft/TypeScript/issues) and help us verify fixes as they are checked in.
|
|
* Review the [source code changes](https://github.com/Microsoft/TypeScript/pulls).
|
|
* Engage with other TypeScript users and developers on [StackOverflow](https://stackoverflow.com/questions/tagged/typescript).
|
|
* Join the [#typescript](https://twitter.com/search?q=%23TypeScript) discussion on Twitter.
|
|
* [Contribute bug fixes](https://github.com/Microsoft/TypeScript/blob/master/CONTRIBUTING.md).
|
|
* Read the language specification ([docx](https://github.com/Microsoft/TypeScript/blob/master/doc/TypeScript%20Language%20Specification.docx?raw=true),
|
|
[pdf](https://github.com/Microsoft/TypeScript/blob/master/doc/TypeScript%20Language%20Specification.pdf?raw=true), [md](https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md)).
|
|
|
|
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see
|
|
the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com)
|
|
with any additional questions or comments.
|
|
|
|
## Documentation
|
|
|
|
* [Quick tutorial](https://www.typescriptlang.org/docs/tutorial.html)
|
|
* [Programming handbook](https://www.typescriptlang.org/docs/handbook/basic-types.html)
|
|
* [Language specification](https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md)
|
|
* [Homepage](https://www.typescriptlang.org/)
|
|
|
|
## Building
|
|
|
|
In order to build the TypeScript compiler, ensure that you have [Git](https://git-scm.com/downloads) and [Node.js](https://nodejs.org/) installed.
|
|
|
|
Clone a copy of the repo:
|
|
|
|
```bash
|
|
git clone https://github.com/Microsoft/TypeScript.git
|
|
```
|
|
|
|
Change to the TypeScript directory:
|
|
|
|
```bash
|
|
cd TypeScript
|
|
```
|
|
|
|
Install [Gulp](https://gulpjs.com/) tools and dev dependencies:
|
|
|
|
```bash
|
|
npm install -g gulp
|
|
npm install
|
|
```
|
|
|
|
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 host or specify a test for this command.
|
|
# Use --host=<hostName> or --tests=<testPath>.
|
|
gulp baseline-accept # This replaces the baseline test results with the results obtained from gulp runtests.
|
|
gulp lint # Runs tslint on the TypeScript source.
|
|
gulp help # List the above commands.
|
|
```
|
|
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
node built/local/tsc.js hello.ts
|
|
```
|
|
|
|
|
|
## Roadmap
|
|
|
|
For details on our planned features and future direction please refer to our [roadmap](https://github.com/Microsoft/TypeScript/wiki/Roadmap).
|