findPrecedingToken: default includeJsDocComment to true (microsoft#25262)

Andy · web-flow · commit 1cb691f52dda · 2018-06-27T12:14:41.000-07:00
* findPrecedingToken: default includeJsDocComment to true

* Add exception for smartIndenter
diff --git a/src/services/completions.ts b/src/services/completions.ts
@@ -871,7 +871,7 @@ namespace ts.Completions {
         }
 
         start = timestamp();
-        const previousToken = findPrecedingToken(position, sourceFile, /*startNode*/ undefined, insideJsDocTagTypeExpression)!; // TODO: GH#18217
+        const previousToken = findPrecedingToken(position, sourceFile, /*startNode*/ undefined)!; // TODO: GH#18217
         log("getCompletionData: Get previous token 1: " + (timestamp() - start));
 
         // The decision to provide completion depends on the contextToken, which is determined through the previousToken.
@@ -882,7 +882,7 @@ namespace ts.Completions {
         // Skip this partial identifier and adjust the contextToken to the token that precedes it.
         if (contextToken && position <= contextToken.end && (isIdentifier(contextToken) || isKeyword(contextToken.kind))) {
             const start = timestamp();
-            contextToken = findPrecedingToken(contextToken.getFullStart(), sourceFile, /*startNode*/ undefined, insideJsDocTagTypeExpression)!; // TODO: GH#18217
+            contextToken = findPrecedingToken(contextToken.getFullStart(), sourceFile, /*startNode*/ undefined)!; // TODO: GH#18217
             log("getCompletionData: Get previous token 2: " + (timestamp() - start));
         }
 
diff --git a/src/services/formatting/smartIndenter.ts b/src/services/formatting/smartIndenter.ts
@@ -32,7 +32,7 @@ namespace ts.formatting {
                 return 0;
             }
 
-            const precedingToken = findPrecedingToken(position, sourceFile);
+            const precedingToken = findPrecedingToken(position, sourceFile, /*startNode*/ undefined, /*excludeJsdoc*/ true);
 
             const enclosingCommentRange = getRangeOfEnclosingComment(sourceFile, position, /*onlyMultiLine*/ true, precedingToken || null); // tslint:disable-line:no-null-keyword
             if (enclosingCommentRange) {
diff --git a/src/services/utilities.ts b/src/services/utilities.ts
@@ -751,7 +751,7 @@ namespace ts {
      * Finds the rightmost token satisfying `token.end <= position`,
      * excluding `JsxText` tokens containing only whitespace.
      */
-    export function findPrecedingToken(position: number, sourceFile: SourceFile, startNode?: Node, includeJsDoc?: boolean): Node | undefined {
+    export function findPrecedingToken(position: number, sourceFile: SourceFile, startNode?: Node, excludeJsdoc?: boolean): Node | undefined {
         const result = find(startNode || sourceFile);
         Debug.assert(!(result && isWhiteSpaceOnlyJsxText(result)));
         return result;
@@ -770,7 +770,7 @@ namespace ts {
                 // we need to find the last token in a previous child.
                 // 2) `position` is within the same span: we recurse on `child`.
                 if (position < child.end) {
-                    const start = child.getStart(sourceFile, includeJsDoc);
+                    const start = child.getStart(sourceFile, /*includeJsDoc*/ !excludeJsdoc);
                     const lookInPreviousChild =
                         (start >= position) || // cursor in the leading trivia
                         !nodeHasTokens(child, sourceFile) ||
diff --git a/tests/baselines/reference/api/tsserverlibrary.d.ts b/tests/baselines/reference/api/tsserverlibrary.d.ts
@@ -10759,7 +10759,7 @@ declare namespace ts {
      * Finds the rightmost token satisfying `token.end <= position`,
      * excluding `JsxText` tokens containing only whitespace.
      */
-    function findPrecedingToken(position: number, sourceFile: SourceFile, startNode?: Node, includeJsDoc?: boolean): Node | undefined;
+    function findPrecedingToken(position: number, sourceFile: SourceFile, startNode?: Node, excludeJsdoc?: boolean): Node | undefined;
     function isInString(sourceFile: SourceFile, position: number, previousToken?: Node | undefined): boolean;
     /**
      * returns true if the position is in between the open and close elements of an JSX expression.

Original file line number	Diff line number	Diff line change
`@@ -871,7 +871,7 @@ namespace ts.Completions {`
`871`	`871`	`}`
`872`	`872`
`873`	`873`	`start = timestamp();`
`874`		`- const previousToken = findPrecedingToken(position, sourceFile, /startNode/ undefined, insideJsDocTagTypeExpression)!; // TODO: GH#18217`
	`874`	`+ const previousToken = findPrecedingToken(position, sourceFile, /startNode/ undefined)!; // TODO: GH#18217`
`875`	`875`	`log("getCompletionData: Get previous token 1: " + (timestamp() - start));`
`876`	`876`
`877`	`877`	`// The decision to provide completion depends on the contextToken, which is determined through the previousToken.`
`@@ -882,7 +882,7 @@ namespace ts.Completions {`
`882`	`882`	`// Skip this partial identifier and adjust the contextToken to the token that precedes it.`
`883`	`883`	`if (contextToken && position <= contextToken.end && (isIdentifier(contextToken) \|\| isKeyword(contextToken.kind))) {`
`884`	`884`	`const start = timestamp();`
`885`		`- contextToken = findPrecedingToken(contextToken.getFullStart(), sourceFile, /startNode/ undefined, insideJsDocTagTypeExpression)!; // TODO: GH#18217`
	`885`	`+ contextToken = findPrecedingToken(contextToken.getFullStart(), sourceFile, /startNode/ undefined)!; // TODO: GH#18217`
`886`	`886`	`log("getCompletionData: Get previous token 2: " + (timestamp() - start));`
`887`	`887`	`}`
`888`	`888`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ namespace ts.formatting {`
`32`	`32`	`return 0;`
`33`	`33`	`}`
`34`	`34`
`35`		`- const precedingToken = findPrecedingToken(position, sourceFile);`
	`35`	`+ const precedingToken = findPrecedingToken(position, sourceFile, /startNode/ undefined, /excludeJsdoc/ true);`
`36`	`36`
`37`	`37`	`const enclosingCommentRange = getRangeOfEnclosingComment(sourceFile, position, /onlyMultiLine/ true, precedingToken \|\| null); // tslint:disable-line:no-null-keyword`
`38`	`38`	`if (enclosingCommentRange) {`