No description
Find a file
Nathan Shively-Sanders 339a56fbf0
Avoid duplicates when finding jsdoc (#24086)
* Avoid duplicates when finding jsdoc

1. Add a cheap assert for detecting duplicates. getJSDocTags must find
either [1] 0 or 1 comments or [2] the first two comments must not be
identical. This does not always find duplicates for nodes with 3 or more
comments, but these nodes are exceptionally rare.

This assert fired for over 20 of the around 250 tests we have that
retrieve JSDoc at all. So I fixed the asserts in [2] and [3].

2. There were overlapping cases from calls to getSourceOfAssignment and
getSpecialPropertyAssignment. getSpecialPropertyAssignment is too
restrictive, but was in the correct location (parent vs parent.parent),
so I removed the getSourceOfAssignment call and replaced the
getSpecialPropertyAssignment calls with a less restrictive check.

3. When a node's parent is a PropertyDeclaration,
getJSDocCOmmentsAndTags would check the parent for jsdoc. But when the
*node* is a PropertyDeclaration, getJSDocCommentsAndTags would use the
jsdoc from the initializer. This second case is useful to make sure that
property declarations get all their jsdoc, but results in duplicates for
their initializers. I couldn't think of a better fix than tracking the
previous node in the recursive lookup of getJSDocCommentsAndTags, which
is a little clunky.

* Fix lint; remove new context parameter

* Update importJsNodeModule3 with fix
2018-05-15 15:12:29 -07:00
.github Move templates (#23874) 2018-05-03 13:41:41 -07:00
.vscode Migrate tscWatchMode to vfs 2017-11-21 19:47:13 -08:00
bin
doc Fix typo in Array Type Literals section of spec 2018-03-27 23:42:01 -04:00
lib Update LKG (#23844) 2018-05-03 08:02:41 -07:00
scripts Alter basic auth strategy 2018-05-14 10:27:13 -07:00
src Avoid duplicates when finding jsdoc (#24086) 2018-05-15 15:12:29 -07:00
tests Avoid duplicates when finding jsdoc (#24086) 2018-05-15 15:12:29 -07:00
.editorconfig
.gitattributes
.gitignore VSTS prefers to pass secrets as command line params (#24041) 2018-05-10 15:37:44 -07:00
.gitmodules Add prettier user test and fix associated crash (#23715) 2018-04-26 14:03:18 -07:00
.mailmap Update authors for release-2.8 2018-03-24 11:51:41 -07:00
.npmignore Move templates (#23874) 2018-05-03 13:41:41 -07:00
.travis.yml Add release-2.9 to covered branches 2018-05-10 13:06:17 -07:00
AUTHORS.md Update authors for release-2.8 2018-03-24 11:51:41 -07:00
CONTRIBUTING.md Update CONTRIBUTING.md 2018-01-08 08:04:46 -08:00
CopyrightNotice.txt
Gulpfile.js Merge pull request #24003 from Microsoft/useEdgeForBrowserTests 2018-05-09 20:07:56 -07:00
Jakefile.js Merge pull request #24003 from Microsoft/useEdgeForBrowserTests 2018-05-09 20:07:56 -07:00
LICENSE.txt
package-lock.json Add script for automatically creating PRs for user test updates (#24036) 2018-05-10 15:02:35 -07:00
package.json Add script for automatically creating PRs for user test updates (#24036) 2018-05-10 15:02:35 -07:00
README.md Add VSTS Build status badge to README (#23789) 2018-05-01 17:41:11 -07:00
ThirdPartyNoticeText.txt
tslint.json Apply 'no-unnecessary-initializer' lint rule (#22014) 2018-03-06 07:30:40 -08:00

Build Status VSTS Build Status npm version Downloads

TypeScript

Join the chat at https://gitter.im/Microsoft/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.

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 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 runtests-browser # Runs the tests using the built run.js file. Syntax is gulp runtests. Optional
                        parameters 'host=', 'tests=[regex], reporter=[list|spec|json|<more>]'.
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

node built/local/tsc.js hello.ts

Roadmap

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