typescript-language-server 5.0.1 → 5.1.0

package/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [5.1.0](https://github.com/typescript-language-server/typescript-language-server/compare/v5.0.1...v5.1.0) (2025-10-31)
+
+
+### Features
+
+* request file-specific formatting options ([#1034](https://github.com/typescript-language-server/typescript-language-server/issues/1034)) ([de89dd3](https://github.com/typescript-language-server/typescript-language-server/commit/de89dd34b27d9dd65b9c3823ad2ddae06eb73c47))
+* support passing "mode" to organize imports command ([#1036](https://github.com/typescript-language-server/typescript-language-server/issues/1036)) ([a7c24b8](https://github.com/typescript-language-server/typescript-language-server/commit/a7c24b85a4503f320aa78fb12ea6cb3f81186b28))
+
 ## [5.0.1](https://github.com/typescript-language-server/typescript-language-server/compare/v5.0.0...v5.0.1) (2025-10-07)
 
 

package/README.md

@@ -23,6 +23,7 @@
     - [Code Lenses \(`textDocument/codeLens`\)](#code-lenses-textdocumentcodelens)
     - [Inlay hints \(`textDocument/inlayHint`\)](#inlay-hints-textdocumentinlayhint)
     - [TypeScript Version Notification](#typescript-version-notification)
+    - [Workspace Configuration request for formatting settings](#workspace-configuration-request-for-formatting-settings)
 - [Development](#development)
     - [Build](#build)
     - [Dev](#dev)
@@ -108,89 +109,112 @@ Most of the time, you'll execute commands with arguments retrieved from another
 
 #### Go to Source Definition
 
-- Request:
-    ```ts
-    {
-        command: `_typescript.goToSourceDefinition`
-        arguments: [
-            lsp.DocumentUri,  // String URI of the document
-            lsp.Position,     // Line and character position (zero-based)
-        ]
-    }
-    ```
-- Response:
-    ```ts
-    lsp.Location[] | null
-    ```
+Request:
+
+```ts
+{
+    command: '_typescript.goToSourceDefinition'
+    arguments: [
+        lsp.DocumentUri,  // String URI of the document
+        lsp.Position,     // Line and character position (zero-based)
+    ]
+}
+```
+
+Response:
+
+```ts
+lsp.Location[] | null
+```
 
 (This command is supported from Typescript 4.7.)
 
 #### Apply Refactoring
 
-- Request:
-    ```ts
-    {
-        command: `_typescript.applyRefactoring`
-        arguments: [
-            tsp.GetEditsForRefactorRequestArgs,
-        ]
-    }
-    ```
-- Response:
-    ```ts
-    void
-    ```
+Request:
+
+```ts
+{
+    command: '_typescript.applyRefactoring'
+    arguments: [
+        tsp.GetEditsForRefactorRequestArgs,
+    ]
+}
+```
+
+Response:
+
+```ts
+void
+```
 
 #### Organize Imports
 
-- Request:
-    ```ts
-    {
-        command: `_typescript.organizeImports`
-        arguments: [
-            // The "skipDestructiveCodeActions" argument is supported from Typescript 4.4+
-            [string] | [string, { skipDestructiveCodeActions?: boolean }],
-        ]
-    }
-    ```
-- Response:
-    ```ts
-    void
-    ```
+Request:
+
+```ts
+{
+    command: '_typescript.organizeImports'
+    arguments: [
+        string,  // file URI
+        // Optional options:
+        {
+            // @deprecated - use "mode". Supported from Typescript 4.4+.
+            skipDestructiveCodeActions?: boolean
+            // 'All' - organizes imports including destructive actions (removing unused imports)
+            // 'SortAndCombine' - Doesn't perform destructive actions.
+            // 'RemoveUnused' - Only removes unused imports.
+            mode?: 'All' | 'SortAndCombine' | 'RemoveUnused'
+        },
+    ]
+}
+```
+
+Response:
+
+```ts
+void
+```
 
 #### Rename File
 
-- Request:
-    ```ts
-    {
-        command: `_typescript.applyRenameFile`
-        arguments: [
-            { sourceUri: string; targetUri: string; },
-        ]
-    }
-    ```
-- Response:
-    ```ts
-    void
-    ```
+Request:
+
+```ts
+{
+    command: '_typescript.applyRenameFile'
+    arguments: [
+        { sourceUri: string; targetUri: string; },
+    ]
+}
+```
+
+Response:
+
+```ts
+void
+```
 
 #### Send Tsserver Command
 
-- Request:
-    ```ts
-    {
-        command: `typescript.tsserverRequest`
-        arguments: [
-            string,       // command
-            any,          // command arguments in a format that the command expects
-            ExecuteInfo,  // configuration object used for the tsserver request (see below)
-        ]
-    }
-    ```
-- Response:
-    ```ts
-    any
-    ```
+Request:
+
+```ts
+{
+    command: 'typescript.tsserverRequest'
+    arguments: [
+        string,       // command
+        any,          // command arguments in a format that the command expects
+        ExecuteInfo,  // configuration object used for the tsserver request (see below)
+    ]
+}
+```
+
+Response:
+
+```ts
+any
+```
 
 The `ExecuteInfo` object is defined as follows:
 
@@ -205,17 +229,20 @@ type ExecuteInfo = {
 
 #### Configure plugin
 
-- Request:
-    ```ts
-    {
-        command: `_typescript.configurePlugin`
-        arguments: [pluginName: string, configuration: any]
-    }
-    ```
-- Response:
-    ```ts
-    void
-    ```
+Request:
+
+```ts
+{
+    command: '_typescript.configurePlugin'
+    arguments: [pluginName: string, configuration: any]
+}
+```
+
+Response:
+
+```ts
+void
+```
 
 ### Code Lenses (`textDocument/codeLens`)
 
@@ -275,6 +302,18 @@ The `$/typescriptVersion` notification params include two properties:
  - `version` - a semantic version (for example `4.8.4`)
  - `source` - a string specifying whether used TypeScript version comes from the local workspace (`workspace`), is explicitly specified through a `initializationOptions.tsserver.path` setting (`user-setting`) or was bundled with the server (`bundled`)
 
+
+### 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:
+
+```js
+{
+    "tabSize": number
+    "insertSpaces": boolean
+}
+```
+
 ## Development
 
 ### Build