typescript-language-server 5.1.0 → 5.1.2

package/CHANGELOG.md

@@ -1,6 +1,20 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [5.1.2](https://github.com/typescript-language-server/typescript-language-server/compare/v5.1.1...v5.1.2) (2025-11-18)
+
+
+### Refactors
+
+* cache file formatting configuration requests ([#1048](https://github.com/typescript-language-server/typescript-language-server/issues/1048)) ([9a366df](https://github.com/typescript-language-server/typescript-language-server/commit/9a366dfc7a989829f4b9e53017c298b565a307fd))
+
+## [5.1.1](https://github.com/typescript-language-server/typescript-language-server/compare/v5.1.0...v5.1.1) (2025-11-05)
+
+
+### Bug Fixes
+
+* don't override formatting options with undefined values ([#1041](https://github.com/typescript-language-server/typescript-language-server/issues/1041)) ([4645124](https://github.com/typescript-language-server/typescript-language-server/commit/464512454a1f68bb6f1e270cf5c0c2be13cdaa54))
+
 ## [5.1.0](https://github.com/typescript-language-server/typescript-language-server/compare/v5.0.1...v5.1.0) (2025-10-31)
 
 

package/README.md

@@ -156,7 +156,7 @@ Request:
 {
     command: '_typescript.organizeImports'
     arguments: [
-        string,  // file URI
+        string,  // file path
         // Optional options:
         {
             // @deprecated - use "mode". Supported from Typescript 4.4+.
@@ -305,7 +305,7 @@ The `$/typescriptVersion` notification params include two properties:
 
 ### Workspace Configuration request for formatting settings
 
-Server asks the client for file-specific configuration options (`tabSize` and `insertSpaces`) that are required by `tsserver` to properly format the file edits when for example using "Organize imports" or performing other file modifications. Those options have to be dynamically provided by the client/editor since the values can differ for each file. For this reason server sends a `workspace/configuration` request with `scopeUri` equal to file's URI and `section` equal to `formattingOptions`. The client is expected to return a configuration that includes the following properties:
+Server asks the client (provided client supports `workspace/configuration` capability) for file-specific configuration options (`tabSize` and `insertSpaces`) that are required by `tsserver` to properly format file edits when for example using "Organize imports" or performing other file modifications. Those options have to be dynamically provided by the client/editor since the values can differ for each file. For this reason server sends a `workspace/configuration` request with `scopeUri` equal to file's URI and `section` equal to `formattingOptions`. The client is expected to return a configuration that includes the following properties:
 
 ```js
 {

package/lib/cli.mjs

@@ -21442,17 +21442,32 @@ function areFileConfigurationsEqual(a, b) {
 }
 
 class FileConfigurationManager {
-  constructor(client, lspClient, onCaseInsensitiveFileSystem) {
+  constructor(client, lspClient, features, onCaseInsensitiveFileSystem) {
     this.client = client;
     this.lspClient = lspClient;
+    this.features = features;
     this.tsPreferences = deepmerge({}, DEFAULT_TSSERVER_PREFERENCES);
     this.workspaceConfiguration = deepmerge({}, DEFAULT_WORKSPACE_CONFIGURATION);
-    this.formatOptions = new ResourceMap(undefined, {
+    this.fileOptionsCache = new ResourceMap(undefined, {
       onCaseInsensitiveFileSystem: onCaseInsensitiveFileSystem
     });
+    this.formatOptionsCache = new ResourceMap(undefined, {
+      onCaseInsensitiveFileSystem: onCaseInsensitiveFileSystem
+    });
+    this.initialConfigurationRequestsMap = new ResourceMap(undefined, {
+      onCaseInsensitiveFileSystem: onCaseInsensitiveFileSystem
+    });
+  }
+  onDidOpenTextDocument(document) {
+    const cancellation = new lsp$1.CancellationTokenSource;
+    this.initialConfigurationRequestsMap.set(document.uri, cancellation);
+    this.ensureConfigurationForDocument(document, cancellation.token).then(() => {
+      this.initialConfigurationRequestsMap.delete(document.uri);
+    }).catch(() => {});
   }
   onDidCloseTextDocument(documentUri) {
-    this.formatOptions.delete(documentUri);
+    this.fileOptionsCache.delete(documentUri);
+    this.initialConfigurationRequestsMap.get(documentUri)?.cancel();
   }
   mergeTsPreferences(preferences) {
     this.tsPreferences = deepmerge(this.tsPreferences, preferences);
@@ -21493,15 +21508,24 @@ class FileConfigurationManager {
     return this.ensureConfigurationOptions(document, formattingOptions, token);
   }
   async getFormattingOptions(document) {
-    const formatConfiguration = await this.lspClient.getWorkspaceConfiguration(document.uri.toString(), 'formattingOptions') || {};
-    return {
-      tabSize: typeof formatConfiguration.tabSize === 'number' ? formatConfiguration.tabSize : undefined,
-      insertSpaces: typeof formatConfiguration.insertSpaces === 'boolean' ? formatConfiguration.insertSpaces : undefined
-    };
+    const formatOptionsCached = this.formatOptionsCache.get(document.uri);
+    if (formatOptionsCached) {
+      return formatOptionsCached;
+    }
+    const formatConfiguration = this.features.workspaceConfigurationSuppport ? await this.lspClient.getWorkspaceConfiguration(document.uri.toString(), 'formattingOptions') || {} : {};
+    const options = {};
+    if (typeof formatConfiguration.tabSize === 'number') {
+      options.tabSize = formatConfiguration.tabSize;
+    }
+    if (typeof formatConfiguration.insertSpaces === 'boolean') {
+      options.insertSpaces = formatConfiguration.insertSpaces;
+    }
+    this.formatOptionsCache.set(document.uri, options);
+    return options;
   }
   async ensureConfigurationOptions(document, options, token) {
     const currentOptions = this.getFileOptions(document, options);
-    const cachedOptions = this.formatOptions.get(document.uri);
+    const cachedOptions = this.fileOptionsCache.get(document.uri);
     if (cachedOptions) {
       const cachedOptionsValue = await cachedOptions;
       if (token?.isCancellationRequested) {
@@ -21522,7 +21546,7 @@ class FileConfigurationManager {
         return undefined;
       }
     })();
-    this.formatOptions.set(document.uri, task);
+    this.fileOptionsCache.set(document.uri, task);
     await task;
   }
   async setGlobalConfigurationFromDocument(document, token) {
@@ -21533,7 +21557,9 @@ class FileConfigurationManager {
     await this.client.execute(CommandTypes.Configure, args, token);
   }
   reset() {
-    this.formatOptions.clear();
+    this.fileOptionsCache.clear();
+    this.formatOptionsCache.clear();
+    this.initialConfigurationRequestsMap.clear();
   }
   getFileOptions(document, options) {
     return {
@@ -23169,7 +23195,7 @@ class LspServer {
     this.referencesCodeLensProvider = null;
     this.logger = new PrefixingLogger(options.logger, '[lspserver]');
     this.tsClient = new TsClient(onCaseInsensitiveFileSystem(), this.logger, options.lspClient);
-    this.fileConfigurationManager = new FileConfigurationManager(this.tsClient, this.options.lspClient, onCaseInsensitiveFileSystem());
+    this.fileConfigurationManager = new FileConfigurationManager(this.tsClient, this.options.lspClient, this.features, onCaseInsensitiveFileSystem());
     this.commandManager = new CommandManager;
     this.diagnosticsManager = new DiagnosticsManager(diagnostics => this.options.lspClient.publishDiagnostics(diagnostics), this.tsClient, this.features, this.logger);
     this.codeActionsManager = new CodeActionManager(this.tsClient, this.fileConfigurationManager, this.commandManager, this.diagnosticsManager, this.features);
@@ -23207,7 +23233,7 @@ class LspServer {
     this.fileConfigurationManager.mergeTsPreferences(userInitializationOptions.preferences || {});
     this.features.completionDisableFilterText = userInitializationOptions.completionDisableFilterText ?? false;
     this.features.moveToFileCodeActionSupport = userInitializationOptions.supportsMoveToFileCodeAction && typescriptVersion.version?.gte(API.v520);
-    const {textDocument: textDocument} = clientCapabilities;
+    const {textDocument: textDocument, workspace: workspace} = clientCapabilities;
     if (textDocument) {
       const {codeAction: codeAction, completion: completion, definition: definition, publishDiagnostics: publishDiagnostics} = textDocument;
       if (codeAction) {
@@ -23230,6 +23256,9 @@ class LspServer {
       this.features.diagnosticsSupport = Boolean(publishDiagnostics);
       this.features.diagnosticsTagSupport = Boolean(publishDiagnostics?.tagSupport);
     }
+    if (workspace?.configuration) {
+      this.features.workspaceConfigurationSuppport = true;
+    }
     this.fileConfigurationManager.mergeTsPreferences({
       useLabelDetailsInCompletionEntries: this.features.completionLabelDetails
     });
@@ -23405,13 +23434,18 @@ class LspServer {
     this.tsClient.interruptGetErr(() => this.diagnosticsManager.updateIgnoredDiagnosticCodes(ignoredDiagnosticCodes));
   }
   didOpenTextDocument(params) {
-    if (this.tsClient.toOpenDocument(params.textDocument.uri, {
+    const {uri: uri, languageId: languageId} = params.textDocument;
+    if (this.tsClient.toOpenDocument(uri, {
       suppressAlertOnFailure: true
     })) {
-      throw new Error(`Can't open already open document: ${params.textDocument.uri}`);
+      throw new Error(`Can't open already open document: ${uri}`);
     }
     if (!this.tsClient.openTextDocument(params.textDocument)) {
-      throw new Error(`Cannot open document '${params.textDocument.uri}' (languageId: ${params.textDocument.languageId}).`);
+      throw new Error(`Cannot open document '${uri}' (languageId: ${languageId}).`);
+    }
+    const document = this.tsClient.toOpenDocument(uri);
+    if (document) {
+      this.fileConfigurationManager.onDidOpenTextDocument(document);
     }
   }
   didCloseTextDocument(params) {
@@ -23580,7 +23614,6 @@ class LspServer {
         const uri = this.tsClient.toResourceUri(cachedData.file);
         document = this.tsClient.toOpenDocument(uri);
         if (document) {
-          await this.fileConfigurationManager.ensureConfigurationForDocument(document, token);
           const response = await this.tsClient.interruptGetErr(() => this.tsClient.execute(CommandTypes.CompletionDetails, cachedData, token));
           if (response.type !== 'response' || !response.body?.length) {
             return item;