Change name to getJsxClosingTagAtPosition and return an object

Andy Hanson · Andy Hanson · commit 4d18f93861b4 · 2018-06-01T09:46:06.000-07:00
diff --git a/src/harness/fourslash.ts b/src/harness/fourslash.ts
@@ -2743,10 +2743,10 @@ Actual: ${stringify(fullActual)}`);
             }
         }
 
-        public verifyAutoCloseTag(map: { [markerName: string]: string | undefined }): void {
+        public verifyJsxClosingTag(map: { [markerName: string]: ts.JsxClosingTagInfo | undefined }): void {
             for (const markerName in map) {
                 this.goToMarker(markerName);
-                const actual = this.languageService.getAutoCloseTagAtPosition(this.activeFile.fileName, this.currentCaretPosition);
+                const actual = this.languageService.getJsxClosingTagAtPosition(this.activeFile.fileName, this.currentCaretPosition);
                 assert.equal(actual, map[markerName]);
             }
         }
@@ -4087,8 +4087,8 @@ namespace FourSlashInterface {
             this.state.verifyBraceCompletionAtPosition(this.negative, openingBrace);
         }
 
-        public autoCloseTag(map: { [markerName: string]: string | undefined }): void {
-            this.state.verifyAutoCloseTag(map);
+        public jsxClosingTag(map: { [markerName: string]: ts.JsxClosingTagInfo | undefined }): void {
+            this.state.verifyJsxClosingTag(map);
         }
 
         public isInCommentAtPosition(onlyMultiLineDiverges?: boolean) {
diff --git a/src/harness/harnessLanguageService.ts b/src/harness/harnessLanguageService.ts
@@ -509,7 +509,7 @@ namespace Harness.LanguageService {
         isValidBraceCompletionAtPosition(fileName: string, position: number, openingBrace: number): boolean {
             return unwrapJSONCallResult(this.shim.isValidBraceCompletionAtPosition(fileName, position, openingBrace));
         }
-        getAutoCloseTagAtPosition(): string | undefined {
+        getJsxClosingTagAtPosition(): never {
             throw new Error("Not supported on the shim.");
         }
         getSpanOfEnclosingComment(fileName: string, position: number, onlyMultiLine: boolean): ts.TextSpan {
diff --git a/src/harness/unittests/session.ts b/src/harness/unittests/session.ts
@@ -188,7 +188,6 @@ namespace ts.server {
 
         describe("onMessage", () => {
             const allCommandNames: CommandNames[] = [
-                CommandNames.AutoCloseTag,
                 CommandNames.Brace,
                 CommandNames.BraceFull,
                 CommandNames.BraceCompletion,
@@ -225,6 +224,7 @@ namespace ts.server {
                 CommandNames.Occurrences,
                 CommandNames.DocumentHighlights,
                 CommandNames.DocumentHighlightsFull,
+                CommandNames.JsxClosingTag,
                 CommandNames.Open,
                 CommandNames.Quickinfo,
                 CommandNames.QuickinfoFull,
diff --git a/src/server/client.ts b/src/server/client.ts
@@ -552,7 +552,7 @@ namespace ts.server {
             return notImplemented();
         }
 
-        getAutoCloseTagAtPosition(_fileName: string, _position: number): string | undefined {
+        getJsxClosingTagAtPosition(_fileName: string, _position: number): never {
             return notImplemented();
         }
 
diff --git a/src/server/protocol.ts b/src/server/protocol.ts
@@ -6,7 +6,7 @@
 namespace ts.server.protocol {
     // NOTE: If updating this, be sure to also update `allCommandNames` in `harness/unittests/session.ts`.
     export const enum CommandTypes {
-        AutoCloseTag = "autoCloseTag",
+        JsxClosingTag = "jsxClosingTag",
         Brace = "brace",
         /* @internal */
         BraceFull = "brace-full",
@@ -891,14 +891,14 @@ namespace ts.server.protocol {
         openingBrace: string;
     }
 
-    export interface AutoCloseTagRequest extends FileLocationRequest {
-        readonly command: CommandTypes.AutoCloseTag;
-        readonly arguments: AutoCloseTagRequestArgs;
+    export interface JsxClosingTagRequest extends FileLocationRequest {
+        readonly command: CommandTypes.JsxClosingTag;
+        readonly arguments: JsxClosingTagRequestArgs;
     }
 
-    export interface AutoCloseTagRequestArgs extends FileLocationRequestArgs {}
+    export interface JsxClosingTagRequestArgs extends FileLocationRequestArgs {}
 
-    export interface AutoCloseTagResponse extends Response {
+    export interface JsxClosingTagResponse extends Response {
         readonly body: TextInsertion;
     }
 
diff --git a/src/server/session.ts b/src/server/session.ts
@@ -818,11 +818,11 @@ namespace ts.server {
             return this.getDiagnosticsWorker(args, /*isSemantic*/ true, (project, file) => project.getLanguageService().getSuggestionDiagnostics(file), !!args.includeLinePosition);
         }
 
-        private getAutoCloseTag(args: protocol.AutoCloseTagRequestArgs): TextInsertion | undefined {
+        private getJsxClosingTag(args: protocol.JsxClosingTagRequestArgs): TextInsertion | undefined {
             const { file, project } = this.getFileAndProject(args);
             const position = this.getPositionInFile(args, file);
-            const tag = project.getLanguageService().getAutoCloseTagAtPosition(file, position);
-            return tag === undefined ? undefined : { newText: tag, caretOffset: 0 };
+            const tag = project.getLanguageService().getJsxClosingTagAtPosition(file, position);
+            return tag === undefined ? undefined : { newText: tag.newText, caretOffset: 0 };
         }
 
         private getDocumentHighlights(args: protocol.DocumentHighlightsRequestArgs, simplifiedResult: boolean): ReadonlyArray<protocol.DocumentHighlightsItem> | ReadonlyArray<DocumentHighlights> {
@@ -2137,8 +2137,8 @@ namespace ts.server {
                 this.projectService.reloadProjects();
                 return this.notRequired();
             },
-            [CommandNames.AutoCloseTag]: (request: protocol.AutoCloseTagRequest) => {
-                return this.requiredResponse(this.getAutoCloseTag(request.arguments));
+            [CommandNames.JsxClosingTag]: (request: protocol.JsxClosingTagRequest) => {
+                return this.requiredResponse(this.getJsxClosingTag(request.arguments));
             },
             [CommandNames.GetCodeFixes]: (request: protocol.CodeFixRequest) => {
                 return this.requiredResponse(this.getCodeFixes(request.arguments, /*simplifiedResult*/ true));
diff --git a/src/services/services.ts b/src/services/services.ts
@@ -2051,15 +2051,14 @@ namespace ts {
             return true;
         }
 
-        function getAutoCloseTagAtPosition(fileName: string, position: number): string | undefined {
+        function getJsxClosingTagAtPosition(fileName: string, position: number): JsxClosingTagInfo | undefined {
             const sourceFile = syntaxTreeCache.getCurrentSourceFile(fileName);
             const token = findPrecedingToken(position, sourceFile);
             if (!token) return undefined;
-            const element = token.kind === SyntaxKind.GreaterThanToken
-                ? isJsxOpeningElement(token.parent) ? token.parent.parent : undefined
+            const element = token.kind === SyntaxKind.GreaterThanToken && isJsxOpeningElement(token.parent) ? token.parent.parent
                 : isJsxText(token) ? token.parent : undefined;
             if (element && !tagNamesAreEquivalent(element.openingElement.tagName, element.closingElement.tagName)) {
-                return `</${element.openingElement.tagName.getText(sourceFile)}>`;
+                return { newText: `</${element.openingElement.tagName.getText(sourceFile)}>` };
             }
         }
 
@@ -2295,7 +2294,7 @@ namespace ts {
             getFormattingEditsAfterKeystroke,
             getDocCommentTemplateAtPosition,
             isValidBraceCompletionAtPosition,
-            getAutoCloseTagAtPosition,
+            getJsxClosingTagAtPosition,
             getSpanOfEnclosingComment,
             getCodeFixesAtPosition,
             getCombinedCodeFix,
diff --git a/src/services/types.ts b/src/services/types.ts
@@ -323,7 +323,11 @@ namespace ts {
         getDocCommentTemplateAtPosition(fileName: string, position: number): TextInsertion | undefined;
 
         isValidBraceCompletionAtPosition(fileName: string, position: number, openingBrace: number): boolean;
-        getAutoCloseTagAtPosition(fileName: string, position: number): string | undefined;
+        /**
+         * This will return a defined result if the position is after the `>` of the opening tag, or somewhere in the text, of a JSXElement with no closing tag.
+         * Editors should call this after `>` is typed.
+         */
+        getJsxClosingTagAtPosition(fileName: string, position: number): JsxClosingTagInfo | undefined;
 
         getSpanOfEnclosingComment(fileName: string, position: number, onlyMultiLine: boolean): TextSpan | undefined;
 
@@ -360,6 +364,10 @@ namespace ts {
         dispose(): void;
     }
 
+    export interface JsxClosingTagInfo {
+        readonly newText: string;
+    }
+
     export interface CombinedCodeFixScope { type: "file"; fileName: string; }
 
     export type OrganizeImportsScope = CombinedCodeFixScope;
diff --git a/tests/baselines/reference/api/tsserverlibrary.d.ts b/tests/baselines/reference/api/tsserverlibrary.d.ts
@@ -4556,7 +4556,11 @@ declare namespace ts {
         getFormattingEditsAfterKeystroke(fileName: string, position: number, key: string, options: FormatCodeOptions | FormatCodeSettings): TextChange[];
         getDocCommentTemplateAtPosition(fileName: string, position: number): TextInsertion | undefined;
         isValidBraceCompletionAtPosition(fileName: string, position: number, openingBrace: number): boolean;
-        getAutoCloseTagAtPosition(fileName: string, position: number): string | undefined;
+        /**
+         * This will return a defined result if the position is after the `>` of the opening tag, or somewhere in the text, of a JSXElement with no closing tag.
+         * Editors should call this after `>` is typed.
+         */
+        getJsxClosingTagAtPosition(fileName: string, position: number): JsxClosingTagInfo | undefined;
         getSpanOfEnclosingComment(fileName: string, position: number, onlyMultiLine: boolean): TextSpan | undefined;
         toLineColumnOffset?(fileName: string, position: number): LineAndCharacter;
         getCodeFixesAtPosition(fileName: string, start: number, end: number, errorCodes: ReadonlyArray<number>, formatOptions: FormatCodeSettings, preferences: UserPreferences): ReadonlyArray<CodeFixAction>;
@@ -4578,6 +4582,9 @@ declare namespace ts {
         getProgram(): Program | undefined;
         dispose(): void;
     }
+    interface JsxClosingTagInfo {
+        readonly newText: string;
+    }
     interface CombinedCodeFixScope {
         type: "file";
         fileName: string;
@@ -5507,7 +5514,7 @@ declare namespace ts.server {
  */
 declare namespace ts.server.protocol {
     enum CommandTypes {
-        AutoCloseTag = "autoCloseTag",
+        JsxClosingTag = "jsxClosingTag",
         Brace = "brace",
         BraceCompletion = "braceCompletion",
         GetSpanOfEnclosingComment = "getSpanOfEnclosingComment",
@@ -6177,13 +6184,13 @@ declare namespace ts.server.protocol {
          */
         openingBrace: string;
     }
-    interface AutoCloseTagRequest extends FileLocationRequest {
-        readonly command: CommandTypes.AutoCloseTag;
-        readonly arguments: AutoCloseTagRequestArgs;
+    interface JsxClosingTagRequest extends FileLocationRequest {
+        readonly command: CommandTypes.JsxClosingTag;
+        readonly arguments: JsxClosingTagRequestArgs;
     }
-    interface AutoCloseTagRequestArgs extends FileLocationRequestArgs {
+    interface JsxClosingTagRequestArgs extends FileLocationRequestArgs {
     }
-    interface AutoCloseTagResponse extends Response {
+    interface JsxClosingTagResponse extends Response {
         readonly body: TextInsertion;
     }
     /**
@@ -8474,7 +8481,7 @@ declare namespace ts.server {
         private getSyntacticDiagnosticsSync;
         private getSemanticDiagnosticsSync;
         private getSuggestionDiagnosticsSync;
-        private getAutoCloseTag;
+        private getJsxClosingTag;
         private getDocumentHighlights;
         private setCompilerOptionsForInferredProjects;
         private getProjectInfo;
diff --git a/tests/baselines/reference/api/typescript.d.ts b/tests/baselines/reference/api/typescript.d.ts
@@ -4556,7 +4556,11 @@ declare namespace ts {
         getFormattingEditsAfterKeystroke(fileName: string, position: number, key: string, options: FormatCodeOptions | FormatCodeSettings): TextChange[];
         getDocCommentTemplateAtPosition(fileName: string, position: number): TextInsertion | undefined;
         isValidBraceCompletionAtPosition(fileName: string, position: number, openingBrace: number): boolean;
-        getAutoCloseTagAtPosition(fileName: string, position: number): string | undefined;
+        /**
+         * This will return a defined result if the position is after the `>` of the opening tag, or somewhere in the text, of a JSXElement with no closing tag.
+         * Editors should call this after `>` is typed.
+         */
+        getJsxClosingTagAtPosition(fileName: string, position: number): JsxClosingTagInfo | undefined;
         getSpanOfEnclosingComment(fileName: string, position: number, onlyMultiLine: boolean): TextSpan | undefined;
         toLineColumnOffset?(fileName: string, position: number): LineAndCharacter;
         getCodeFixesAtPosition(fileName: string, start: number, end: number, errorCodes: ReadonlyArray<number>, formatOptions: FormatCodeSettings, preferences: UserPreferences): ReadonlyArray<CodeFixAction>;
@@ -4578,6 +4582,9 @@ declare namespace ts {
         getProgram(): Program | undefined;
         dispose(): void;
     }
+    interface JsxClosingTagInfo {
+        readonly newText: string;
+    }
     interface CombinedCodeFixScope {
         type: "file";
         fileName: string;
diff --git a/tests/cases/fourslash/autoCloseTag.ts b/tests/cases/fourslash/autoCloseTag.ts
@@ -11,10 +11,10 @@
 ////</p>;
 ////const x = <div> text /*5*/;
 
-verify.autoCloseTag({
-    0: "</div>",
+verify.jsxClosingTag({
+    0: { newText: "</div>" },
     1: undefined,
     2: undefined,
     3: undefined,
-    4: "</p>",
+    4: { newText: "</p>" },
 });
diff --git a/tests/cases/fourslash/fourslash.ts b/tests/cases/fourslash/fourslash.ts
@@ -174,7 +174,7 @@ declare namespace FourSlashInterface {
         typeDefinitionCountIs(expectedCount: number): void;
         implementationListIsEmpty(): void;
         isValidBraceCompletionAtPosition(openingBrace?: string): void;
-        autoCloseTag(map: { [markerName: string]: string | undefined }): void;
+        jsxClosingTag(map: { [markerName: string]: { readonly newText: string } | undefined }): void;
         isInCommentAtPosition(onlyMultiLineDiverges?: boolean): void;
         codeFix(options: {
             description: string,

Original file line number	Diff line number	Diff line change
@@ -2743,10 +2743,10 @@ Actual: ${stringify(fullActual)}`);
`2743`	`2743`	`}`
`2744`	`2744`	`}`
`2745`	`2745`
`2746`		`- public verifyAutoCloseTag(map: { [markerName: string]: string \| undefined }): void {`
	`2746`	`+ public verifyJsxClosingTag(map: { [markerName: string]: ts.JsxClosingTagInfo \| undefined }): void {`
`2747`	`2747`	`for (const markerName in map) {`
`2748`	`2748`	`this.goToMarker(markerName);`
`2749`		`- const actual = this.languageService.getAutoCloseTagAtPosition(this.activeFile.fileName, this.currentCaretPosition);`
	`2749`	`+ const actual = this.languageService.getJsxClosingTagAtPosition(this.activeFile.fileName, this.currentCaretPosition);`
`2750`	`2750`	`assert.equal(actual, map[markerName]);`
`2751`	`2751`	`}`
`2752`	`2752`	`}`
`@@ -4087,8 +4087,8 @@ namespace FourSlashInterface {`
`4087`	`4087`	`this.state.verifyBraceCompletionAtPosition(this.negative, openingBrace);`
`4088`	`4088`	`}`
`4089`	`4089`
`4090`		`- public autoCloseTag(map: { [markerName: string]: string \| undefined }): void {`
`4091`		`- this.state.verifyAutoCloseTag(map);`
	`4090`	`+ public jsxClosingTag(map: { [markerName: string]: ts.JsxClosingTagInfo \| undefined }): void {`
	`4091`	`+ this.state.verifyJsxClosingTag(map);`
`4092`	`4092`	`}`
`4093`	`4093`
`4094`	`4094`	`public isInCommentAtPosition(onlyMultiLineDiverges?: boolean) {`
Original file line number	Diff line number	Diff line change
`@@ -509,7 +509,7 @@ namespace Harness.LanguageService {`
`509`	`509`	`isValidBraceCompletionAtPosition(fileName: string, position: number, openingBrace: number): boolean {`
`510`	`510`	`return unwrapJSONCallResult(this.shim.isValidBraceCompletionAtPosition(fileName, position, openingBrace));`
`511`	`511`	`}`
`512`		`- getAutoCloseTagAtPosition(): string \| undefined {`
	`512`	`+ getJsxClosingTagAtPosition(): never {`
`513`	`513`	`throw new Error("Not supported on the shim.");`
`514`	`514`	`}`
`515`	`515`	`getSpanOfEnclosingComment(fileName: string, position: number, onlyMultiLine: boolean): ts.TextSpan {`
Original file line number	Diff line number	Diff line change
`@@ -552,7 +552,7 @@ namespace ts.server {`
`552`	`552`	`return notImplemented();`
`553`	`553`	`}`
`554`	`554`
`555`		`- getAutoCloseTagAtPosition(_fileName: string, _position: number): string \| undefined {`
	`555`	`+ getJsxClosingTagAtPosition(_fileName: string, _position: number): never {`
`556`	`556`	`return notImplemented();`
`557`	`557`	`}`
`558`	`558`