Simplfied Return Values

Arthur Ozga · Arthur Ozga · commit e6809c30f175 · 2015-07-24T15:27:28.000-07:00
diff --git a/src/harness/typeWriter.ts b/src/harness/typeWriter.ts
@@ -71,4 +71,4 @@ class TypeWriterWalker {
             symbol: symbolString
         });
     }
-}
+}
diff --git a/src/services/services.ts b/src/services/services.ts
@@ -6764,14 +6764,23 @@ namespace ts {
 
         /**
          * Checks if position points to a valid position to add JSDoc comments, and if so,
-         * returns the appropriate scaffolding. Otherwise returns a default string.
-         * @param fileName The file in which to perofrm the check
+         * returns the appropriate scaffolding. Otherwise returns an empty string.
+         * Valid positions are
+         * * outside of comments, statements, and expressions, and
+         * * preceding a function declaration.
+         * 
+         * In VS, we additionally check that:
+         * * The line is all whitespace up to 'position' before performing the insertion.
+         * * If the keystroke sequence "/\*\*" induced the call, we also check that the next
+         * non-whitespace character is '*', which (approximately) indicates whether we added 
+         * the second '*' to complete an existing (JSDoc) comment.
+         * @param fileName The file in which to perform the check.
          * @param position The (character-indexed) position in the file where the check should
          * be performed.
          */
         function getDocCommentScaffoldingAtPosition(fileName: string, position: number): TextInsertion {
-            const nullResult      = { newText: "/**",    cursorOffset: 3 };
-            const emptyCompletion = { newText: "/** */", cursorOffset: 3 };
+            // Indicates the position is not appropriate to insert a comment (eg: a string or a regex).
+            const nullResult: TextInsertion = { newText: "", cursorOffset: 0 };
             let start = new Date().getTime();
             let sourceFile = syntaxTreeCache.getCurrentSourceFile(fileName);
             log("getDocCommentScaffoldingAtPosition: getCurrentSourceFile: " + (new Date().getTime() - start));
@@ -6782,10 +6791,15 @@ namespace ts {
             }
 
             let nodeAtPos = getTokenAtPosition(sourceFile, position);
+
+            if (!nodeAtPos || nodeAtPos.getStart() < position) {
+                return nullResult;
+            }
+
             let containingFunction = <FunctionDeclaration>getAncestor(nodeAtPos, SyntaxKind.FunctionDeclaration);
 
             if (hasDocComment(sourceFile, position) || !containingFunction || containingFunction.getStart() < position) {
-                return emptyCompletion;
+                return nullResult;
             }
 
             let parameters = containingFunction.parameters;

Original file line number	Diff line number	Diff line change
`@@ -71,4 +71,4 @@ class TypeWriterWalker {`
`71`	`71`	`symbol: symbolString`
`72`	`72`	`});`
`73`	`73`	`}`
`74`		`-}`
	`74`	`+}`