feat: linkedEditing support

closes #423

Author: fannheyward

package.json

@@ -1172,11 +1172,11 @@
     "coc.nvim": "^0.0.83-next.11",
     "esbuild": "^0.15.13",
     "semver": "^7.3.7",
-    "vscode-languageserver-protocol": "^3.17.2",
     "strip-ansi": "^7.0.1",
+    "vscode-languageserver-protocol": "^3.17.2",
     "which": "^2.0.2"
   },
   "dependencies": {
-    "typescript": "^4.9.3"
+    "typescript": "^5.1.3"
   }
 }

src/server/features/linkedEditing.ts

@@ -0,0 +1,32 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { CancellationToken, LinkedEditingRangeProvider, LinkedEditingRanges, Position, TextDocument } from 'coc.nvim';
+import { ITypeScriptServiceClient } from '../typescriptService';
+import API from '../utils/api';
+import * as typeConverters from '../utils/typeConverters';
+
+export default class TypeScriptLinkedEditingRangeProvider implements LinkedEditingRangeProvider {
+
+	public static readonly minVersion = API.v510;
+
+	public constructor(private readonly client: ITypeScriptServiceClient) {}
+
+	async provideLinkedEditingRanges(document: TextDocument, position: Position, token: CancellationToken): Promise<LinkedEditingRanges | undefined> {
+		const filepath = this.client.toOpenedFilePath(document.uri);
+		if (!filepath) {
+			return undefined;
+		}
+
+		const args = typeConverters.Position.toFileLocationRequestArgs(filepath, position);
+		const response = await this.client.execute('linkedEditingRange', args, token);
+		if (response.type !== 'response' || !response.body) {
+			return undefined;
+		}
+
+		const ranges = response.body.ranges.map(range => typeConverters.Range.fromTextSpan(range));
+		return { ranges, wordPattern: response.body.wordPattern }
+	}
+}

src/server/languageProvider.ts

@@ -22,6 +22,7 @@ import ImportfixProvider from './features/importFix'
 import TypeScriptInlayHintsProvider from './features/inlayHints'
 import { JsDocCompletionProvider } from './features/jsDocCompletion'
 import InstallModuleProvider from './features/moduleInstall'
+import LinkedEditingRangeProvider from './features/linkedEditing'
 import QuickfixProvider from './features/quickfix'
 import RefactorProvider from './features/refactor'
 import ReferenceProvider from './features/references'
@@ -230,6 +231,10 @@ export default class LanguageProvider {
         this.client.logger.error(`languages.registerInlayHintsProvider is not a function, inlay hints won't work`)
       }
     }
+    if (this.client.apiVersion.gte(API.v510)) {
+      const provider = new LinkedEditingRangeProvider(this.client)
+      this._register(languages.registerLinkedEditingRangeProvider(documentSelector.semantic, provider))
+    }
   }
 
   public handles(resource: string, doc: TextDocument): boolean {

src/server/protocol.d.ts

@@ -1,2 +1,27 @@
-import * as Proto from 'typescript/lib/protocol';
-export = Proto;
+import ts from 'typescript/lib/tsserverlibrary';
+export = ts.server.protocol;
+
+declare enum ServerType {
+  Syntax = 'syntax',
+  Semantic = 'semantic',
+}
+
+declare module 'typescript/lib/tsserverlibrary' {
+  namespace server.protocol {
+    type TextInsertion = ts.TextInsertion;
+    type ScriptElementKind = ts.ScriptElementKind;
+
+    interface Response {
+      readonly _serverType?: ServerType;
+    }
+
+    interface LinkedEditingRangesBody {
+      ranges: TextSpan[];
+      wordPattern?: string;
+    }
+
+    interface LinkedEditingRangeResponse extends Response {
+      readonly body: LinkedEditingRangesBody;
+    }
+  }
+}

src/server/typescriptService.ts

@@ -57,6 +57,7 @@ interface StandardTsServerRequests {
   'getSupportedCodeFixes': [null, Proto.GetSupportedCodeFixesResponse]
   'implementation': [Proto.FileLocationRequestArgs, Proto.ImplementationResponse]
   'jsxClosingTag': [Proto.JsxClosingTagRequestArgs, Proto.JsxClosingTagResponse]
+  'linkedEditingRange': [Proto.FileLocationRequestArgs, Proto.LinkedEditingRangeResponse];
   'navto': [Proto.NavtoRequestArgs, Proto.NavtoResponse]
   'navtree': [Proto.FileRequestArgs, Proto.NavTreeResponse]
   'organizeImports': [Proto.OrganizeImportsRequestArgs, Proto.OrganizeImportsResponse]

src/server/utils/api.ts

@@ -48,7 +48,7 @@ export default class API {
   public static readonly v460 = API.fromSimpleString('4.6.0');
   public static readonly v480 = API.fromSimpleString('4.8.0');
   public static readonly v490 = API.fromSimpleString('4.9.0');
-
+  public static readonly v510 = API.fromSimpleString('5.1.0');
 
   public static fromVersionString(versionString: string): API {
     let version = semver.valid(versionString)

yarn.lock

@@ -181,10 +181,10 @@ strip-ansi@^7.0.1:
   dependencies:
     ansi-regex "^6.0.1"
 
-typescript@^4.9.3:
-  version "4.9.3"
-  resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.9.3.tgz#3aea307c1746b8c384435d8ac36b8a2e580d85db"
-  integrity sha512-CIfGzTelbKNEnLpLdGFgdyKhG23CKdKgQPOBc+OUNrkJ2vr+KSzsSV5kq5iWhEQbok+quxgGzrAtGWCyU7tHnA==
+typescript@^5.1.3:
+  version "5.1.3"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.1.3.tgz#8d84219244a6b40b6fb2b33cc1c062f715b9e826"
+  integrity sha512-XH627E9vkeqhlZFQuL+UsyAXEnibT0kWR2FWONlr4sTjvxyJYnyefgrkyECLzM5NenmKzRAy2rR/OlYLA1HkZw==
 
 [email protected]:
   version "8.0.2"