typescript-language-server 0.11.1 → 1.1.0

package/CHANGELOG.md

@@ -1,6 +1,58 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [1.1.0](https://github.com/typescript-language-server/typescript-language-server/compare/v1.0.0...v1.1.0) (2022-08-21)
+
+
+### Features
+
+* add "Go To Source Definition" command ([#560](https://github.com/typescript-language-server/typescript-language-server/issues/560)) ([9bcdaf2](https://github.com/typescript-language-server/typescript-language-server/commit/9bcdaf2b0b09da9aa4d7e6ed79bdcd742b3cfc17))
+* support `textDocument/inlayHint` request from 3.17.0 spec ([#566](https://github.com/typescript-language-server/typescript-language-server/issues/566)) ([9a2fd4e](https://github.com/typescript-language-server/typescript-language-server/commit/9a2fd4e34b6c50c57b974f617018dcefdb469788))
+* support LocationLink[] for textDocument/definition response ([#563](https://github.com/typescript-language-server/typescript-language-server/issues/563)) ([196f328](https://github.com/typescript-language-server/typescript-language-server/commit/196f328cd9fd7a06998151d59bed0b945cc68b40))
+
+
+### Bug Fixes
+
+* don't trigger error on empty Source Definition response ([#568](https://github.com/typescript-language-server/typescript-language-server/issues/568)) ([146a6ba](https://github.com/typescript-language-server/typescript-language-server/commit/146a6ba97f0792701ff8afcc431d3a1dfdb978a6))
+* make wording in the typescript lookup error more generic ([585a05e](https://github.com/typescript-language-server/typescript-language-server/commit/585a05e43a0b530f10e488aed634fac0436109ae)), closes [#554](https://github.com/typescript-language-server/typescript-language-server/issues/554)
+* snippet completions returned to clients that don't support them ([#556](https://github.com/typescript-language-server/typescript-language-server/issues/556)) ([050d335](https://github.com/typescript-language-server/typescript-language-server/commit/050d3350e16fe78b7c60d7443ed3ad6d2cc4730d))
+* update signature help feature to v3.15.0 LSP spec ([#555](https://github.com/typescript-language-server/typescript-language-server/issues/555)) ([da074a6](https://github.com/typescript-language-server/typescript-language-server/commit/da074a618ca6c29819834a0344682094d6ff08f6))
+
+## [1.0.0](https://github.com/typescript-language-server/typescript-language-server/compare/v0.11.2...v1.0.0) (2022-08-06)
+
+
+### ⚠ BREAKING CHANGES
+
+* Ship as an ES module. Might be breaking for programmatic users of this server. Read more about consuming ES module packages at gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
+* **deps:** LSP libraries updated to match the 3.17 version of the LSP spec. Requires minimum Node 14.
+
+### Features
+
+* add support for CompletionItem.labelDetails ([#534](https://github.com/typescript-language-server/typescript-language-server/issues/534)) ([3c140d9](https://github.com/typescript-language-server/typescript-language-server/commit/3c140d958507300d7d186adb84f5b0baa549edb2))
+
+
+### Bug Fixes
+
+* declare quickfix/refactor CodeAction capabilities ([#553](https://github.com/typescript-language-server/typescript-language-server/issues/553)) ([e76fc64](https://github.com/typescript-language-server/typescript-language-server/commit/e76fc6493295649d6ada83c8a5f6d88abe2a6167))
+* handle shutdown lifecycle properly ([#536](https://github.com/typescript-language-server/typescript-language-server/issues/536)) ([ac8536b](https://github.com/typescript-language-server/typescript-language-server/commit/ac8536bf8eb805bfc28e484a8f4827b5375d6824))
+
+
+### Miscellaneous Chores
+
+* **deps:** update LSP libraries to match 3.17 spec ([#532](https://github.com/typescript-language-server/typescript-language-server/issues/532)) ([bdbdd83](https://github.com/typescript-language-server/typescript-language-server/commit/bdbdd8379815583aa28d2a770034253050ba24de))
+
+
+### Code Refactoring
+
+* ship as an ES module ([#547](https://github.com/typescript-language-server/typescript-language-server/issues/547)) ([0dfd411](https://github.com/typescript-language-server/typescript-language-server/commit/0dfd41125c04868b547a3893334bb0bb822e0517))
+
+## [0.11.2](https://github.com/typescript-language-server/typescript-language-server/compare/v0.11.1...v0.11.2) (2022-06-24)
+
+
+### Bug Fixes
+
+* apply refactoring returns -1 positions in ranges ([#502](https://github.com/typescript-language-server/typescript-language-server/issues/502)) ([5f52db0](https://github.com/typescript-language-server/typescript-language-server/commit/5f52db0383d6c326cd321c13fc969ab9d3958011))
+
 ## [0.11.1](https://github.com/typescript-language-server/typescript-language-server/compare/v0.11.0...v0.11.1) (2022-06-13)
 
 

package/README.md

@@ -11,6 +11,33 @@ Based on concepts and ideas from https://github.com/prabirshrestha/typescript-la
 
 Maintained by a [community of contributors](https://github.com/typescript-language-server/typescript-language-server/graphs/contributors) like you
 
+<!-- MarkdownTOC -->
+
+- [Installing](#installing)
+- [Running the language server](#running-the-language-server)
+- [CLI Options](#cli-options)
+- [initializationOptions](#initializationoptions)
+- [workspace/didChangeConfiguration](#workspacedidchangeconfiguration)
+- [Code actions on save](#code-actions-on-save)
+- [Workspace commands \(`workspace/executeCommand`\)](#workspace-commands-workspaceexecutecommand)
+    - [Go to Source Definition](#go-to-source-definition)
+    - [Apply Workspace Edits](#apply-workspace-edits)
+    - [Apply Code Action](#apply-code-action)
+    - [Apply Refactoring](#apply-refactoring)
+    - [Organize Imports](#organize-imports)
+    - [Rename File](#rename-file)
+- [Inlay hints \(`typescript/inlayHints`\) \(experimental\)](#inlay-hints-typescriptinlayhints-experimental)
+- [Callers and callees \(`textDocument/calls`\) \(experimental\)](#callers-and-callees-textdocumentcalls-experimental)
+- [Supported Protocol features](#supported-protocol-features)
+    - [Experimental](#experimental)
+- [Development](#development)
+    - [Build](#build)
+    - [Test](#test)
+    - [Watch](#watch)
+    - [Publishing](#publishing)
+
+<!-- /MarkdownTOC -->
+
 ## Installing
 
 ```sh
@@ -97,6 +124,24 @@ interface UserPreferences {
      * @default true
      */
     includeCompletionsWithClassMemberSnippets: boolean;
+    /**
+     * If enabled, object literal methods will have a method declaration completion entry in addition
+     * to the regular completion entry containing just the method name.
+     * E.g., `const objectLiteral: T = { f| }` could be completed to `const objectLiteral: T = { foo(): void {} }`,
+     * in addition to `const objectLiteral: T = { foo }`.
+     * @since 4.7.2
+     * @default true
+     */
+    includeCompletionsWithObjectLiteralMethodSnippets: boolean;
+    /**
+     * Indicates whether {@link CompletionEntry.labelDetails completion entry label details} are supported.
+     * If not, contents of `labelDetails` may be included in the {@link CompletionEntry.name} property.
+     * Only supported if the client supports `textDocument.completion.completionItem.labelDetailsSupport` capability
+     * and a compatible TypeScript version is used.
+     * @since 4.7.2
+     * @default true
+     */
+    useLabelDetailsInCompletionEntries: boolean;
     /**
      * Allows import module names to be resolved in the initial completions request.
      * @default false
@@ -122,6 +167,14 @@ interface UserPreferences {
     jsxAttributeCompletionStyle: "auto" | "braces" | "none";
     displayPartsForJSDoc: boolean;
     generateReturnInDocTemplate: boolean;
+
+    includeInlayParameterNameHints: "none" | "literals" | "all";
+    includeInlayParameterNameHintsWhenArgumentMatchesName: boolean;
+    includeInlayFunctionParameterTypeHints: boolean,
+    includeInlayVariableTypeHints: boolean;
+    includeInlayPropertyDeclarationTypeHints: boolean;
+    includeInlayFunctionLikeReturnTypeHints: boolean;
+    includeInlayEnumMemberValueHints: boolean;
 }
 ```
 
@@ -138,6 +191,7 @@ From the `preferences` options listed above, this server explicilty sets the fol
     includeCompletionsForImportStatements: true,
     includeCompletionsForModuleExports: true,
     includeCompletionsWithClassMemberSnippets: true,
+    includeCompletionsWithObjectLiteralMethodSnippets: true,
     includeCompletionsWithInsertText: true,
     includeCompletionsWithSnippetText: true,
     jsxAttributeCompletionStyle: "auto",
@@ -220,38 +274,114 @@ The user can enable it with a setting similar to (can vary per-editor):
 
 ## Workspace commands (`workspace/executeCommand`)
 
-See [LSP specification](https://microsoft.github.io/language-server-protocol/specifications/specification-3-17/#workspace_executeCommand).
+See [LSP specification](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#workspace_executeCommand).
 
 Most of the time, you'll execute commands with arguments retrieved from another request like `textDocument/codeAction`. There are some use cases for calling them manually.
 
-Supported commands:
+`lsp` refers to the language server protocol types, `tsp` refers to the typescript server protocol types.
+
+### 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
+    ```
+
+(This command is supported from Typescript 4.7.)
+
+### Apply Workspace Edits
+
+- Request:
+    ```ts
+    {
+        command: `_typescript.applyWorkspaceEdit`
+        arguments: [lsp.WorkspaceEdit]
+    }
+    ```
+- Response:
+    ```ts
+    lsp.ApplyWorkspaceEditResult
+    ```
+
+### Apply Code Action
+
+- Request:
+    ```ts
+    {
+        command: `_typescript.applyCodeAction`
+        arguments: [
+            tsp.CodeAction,  // TypeScript Code Action object
+        ]
+    }
+    ```
+- Response:
+    ```ts
+    void
+    ```
 
-`lsp` refers to the language server protocol, `tsp` refers to the typescript server protocol.
+### Apply Refactoring
 
-* `_typescript.applyWorkspaceEdit`
+- Request:
     ```ts
-    type Arguments = [lsp.WorkspaceEdit]
+    {
+        command: `_typescript.applyRefactoring`
+        arguments: [
+            tsp.GetEditsForRefactorRequestArgs,
+        ]
+    }
     ```
-* `_typescript.applyCodeAction`
+- Response:
+    ```ts
+    void
+    ```
+
+### Organize Imports
+
+- Request:
     ```ts
-    type Arguments = [tsp.CodeAction]
+    {
+        command: `_typescript.organizeImports`
+        arguments: [
+            // The "skipDestructiveCodeActions" argument is supported from Typescript 4.4+
+            [string] | [string, { skipDestructiveCodeActions?: boolean }],
+        ]
+    }
     ```
-* `_typescript.applyRefactoring`
+- Response:
     ```ts
-    type Arguments = [tsp.GetEditsForRefactorRequestArgs]
+    void
     ```
-* `_typescript.organizeImports`
+
+### Rename File
+
+- Request:
     ```ts
-    // The "skipDestructiveCodeActions" argument is supported from Typescript 4.4+
-    type Arguments = [string] | [string, { skipDestructiveCodeActions?: boolean }]
+    {
+        command: `_typescript.applyRenameFile`
+        arguments: [
+            { sourceUri: string; targetUri: string; },
+        ]
+    }
     ```
-* `_typescript.applyRenameFile`
+- Response:
     ```ts
-    type Arguments = [{ sourceUri: string; targetUri: string; }]
+    void
     ```
 
 ## Inlay hints (`typescript/inlayHints`) (experimental)
 
+> !!! This implementation is deprecated. Use the spec-compliant `textDocument/inlayHint` request instead. !!!
+
 Supports experimental inline hints.
 
 ```ts
@@ -374,28 +504,32 @@ interface DefinitionSymbol {
 
 ## Supported Protocol features
 
+- [x] textDocument/codeAction
+- [x] textDocument/completion (incl. `completion/resolve`)
+- [x] textDocument/definition
 - [x] textDocument/didChange (incremental)
 - [x] textDocument/didClose
 - [x] textDocument/didOpen
 - [x] textDocument/didSave
-- [x] textDocument/codeAction
-- [x] textDocument/completion (incl. completion/resolve)
-- [x] textDocument/definition
 - [x] textDocument/documentHighlight
 - [x] textDocument/documentSymbol
 - [x] textDocument/executeCommand
 - [x] textDocument/formatting
-- [x] textDocument/rangeFormatting
 - [x] textDocument/hover
-- [x] textDocument/rename
+- [x] textDocument/inlayHint (no support for `inlayHint/resolve` or `workspace/inlayHint/refresh`)
+- [x] textDocument/rangeFormatting
 - [x] textDocument/references
+- [x] textDocument/rename
 - [x] textDocument/signatureHelp
-- [x] textDocument/calls (experimental)
-- [x] typescript/inlayHints (experimental, supported from Typescript v4.4.2)
 - [x] workspace/symbol
 - [x] workspace/didChangeConfiguration
 - [x] workspace/executeCommand
 
+### Experimental
+
+- [x] textDocument/calls (experimental)
+- [x] typescript/inlayHints (experimental, supported from Typescript v4.4.2) DEPRECATED (use  `textDocument/inlayHint` instead)
+
 ## Development
 
 ### Build
@@ -406,9 +540,10 @@ yarn
 
 ### Test
 
-```sh
-yarn test
-```
+ - `yarn test` - run all tests
+ - `yarn test:watch` - run all tests and enable watch mode for developing
+
+By default only console logs of level `warn` and higher are printed to the console. You can override the `CONSOLE_LOG_LEVEL` level in `package.json` to either `log`, `info`, `warn` or `error` to log other levels.
 
 ### Watch
 
@@ -418,6 +553,4 @@ yarn watch
 
 ### Publishing
 
-```sh
-yarn publish
-```
+New version of the package is published automatically on pushing new tag to the upstream repo.

package/lib/calls.d.ts

@@ -1,7 +1,7 @@
-import * as lsp from 'vscode-languageserver/node';
-import * as lspcalls from './lsp-protocol.calls.proposed';
-import { TspClient } from './tsp-client';
+import * as lsp from 'vscode-languageserver';
 import { TextDocument } from 'vscode-languageserver-textdocument';
+import * as lspcalls from './lsp-protocol.calls.proposed.js';
+import { TspClient } from './tsp-client.js';
 export declare function computeCallers(tspClient: TspClient, args: lsp.TextDocumentPositionParams): Promise<lspcalls.CallsResult>;
 export declare type DocumentProvider = (file: string) => TextDocument | undefined;
 export declare function computeCallees(tspClient: TspClient, args: lsp.TextDocumentPositionParams, documentProvider: DocumentProvider): Promise<lspcalls.CallsResult>;

package/lib/calls.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"calls.d.ts","sourceRoot":"","sources":["../src/calls.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,GAAG,MAAM,4BAA4B,CAAC;AAClD,OAAO,KAAK,QAAQ,MAAM,+BAA+B,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAGzC,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAElE,wBAAsB,cAAc,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,CAAC,0BAA0B,GAAG,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAwB9H;AACD,oBAAY,gBAAgB,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,YAAY,GAAG,SAAS,CAAC;AAC1E,wBAAsB,cAAc,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,CAAC,0BAA0B,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CA6BlK"}
+{"version":3,"file":"calls.d.ts","sourceRoot":"","sources":["../src/calls.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,GAAG,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,KAAK,QAAQ,MAAM,kCAAkC,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAK5C,wBAAsB,cAAc,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,CAAC,0BAA0B,GAAG,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAwB9H;AACD,oBAAY,gBAAgB,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,YAAY,GAAG,SAAS,CAAC;AAC1E,wBAAsB,cAAc,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,CAAC,0BAA0B,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CA6BlK"}