typescript-language-server 0.6.5 → 0.8.1

package/CHANGELOG.md

@@ -1,6 +1,90 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.8.0] - 2021-11-21
+
+ - **feat**: implement semantic tokens support (#290)
+
+ - **feat**: add support for snippet completions for methods/functions (#303)
+
+ - **feat**: ability to ignore diagnostics by code (#272)
+   Adds new `diagnostics.ignoredCodes` workspace setting to ignore specific diagnostics.
+
+ - **feat**: add `npmLocation` option to specify NPM location (#293)
+
+ - **fix**: don't announce support for codeActionKinds (#289)
+
+ - **fix**: mark import completions as snippets (#291)
+
+ - **fix**: specify minimum node version to be v12 (#301)
+
+ - **fix**: ensure that the `tsserver` subprocess uses forked node instance (#292)
+   Potentially **BREAKING**. The lookup of `tsserver` was refactored to never use `spawn` logic but instead always `fork` the current node instance. See more info in the PR.
+
+ - **fix**: exit the server if tsserver process crashes (#305)
+
+ - **fix**: respect "includeDeclaration" for references request (#306)
+
+## [0.7.1] - 2021-11-10
+
+ - fix: add missing `semver` dependency (#288)
+
+## [0.7.0] - 2021-11-09
+
+### Breaking
+
+Changes to default options sent to tsserver could affect behavior (hopefully for the better). Read changes below for more details.
+
+### Changes
+
+- **feat**: include import specifier for import completions (#281)
+   For completions that import from another package, the completions will include a "detail" field with the name of the module.
+
+   Also aligned some other logic with the typescript language services used in VSCode:
+    * annotate the completions with the local name of the import when completing a path in import foo from '...'
+    * update completion "sortText" regardless if the completion "isRecommended"
+
+- **feat**: allow skip destructive actions on running OrganizeImports (#228)
+   Add support for the new skipDestructiveCodeActions argument to TypeScript's organize imports feature - [1] to support [2].
+
+   Support is added in two places:
+     * Automatically inferring the proper value based on diagnostics for the file when returning code actions.
+     * Supporting sending it when manually executing the organize imports action.
+
+   Also added documentation to the readme about the supported commands that can be manually executed.
+
+   [1] https://github.com/microsoft/TypeScript/issues/43051
+   [2] https://github.com/apexskier/nova-typescript/issues/273
+
+- **feat**: support running server on files without root workspace (#286)
+   The tsserver seems to be good at inferring the project configuration when opening single files without a workspace so don't crash on missing `rootPath`.
+
+- **feat**: add `disableAutomaticTypingAcquisition` option to disable automatic type acquisition (#285)
+- **feat**: update default tsserver options (#284)
+  Set the following additional options by default:
+    ```
+    allowRenameOfImportPath: true,
+    displayPartsForJSDoc: true,
+    generateReturnInDocTemplate: true,
+    includeAutomaticOptionalChainCompletions: true,
+    includeCompletionsForImportStatements: true,
+    includeCompletionsWithSnippetText: true,
+    ```
+    This aligns more with the default options of the typescript language services in VSCode.
+- **feat**: announce support for "source.organizeImports.ts-ls" action (#283)
+    Announcing support for that code action allows editors that support
+    running code actions on save to automatically run the code action if
+    the user has configured the editor with settings like
+
+    ```js
+      "codeActionsOnSave": {
+        "source.organizeImports": true,
+        // or
+        "source.organizeImports.ts-ls": true,
+      },
+    ```
+ - **chore**: change default log level from "warn" to "info" (#287)
+
 ## [0.6.5] - 2021-11-03
 
  - fix: normalize client and tsserver paths (#275)

package/README.md

@@ -11,13 +11,13 @@ 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
 
-# Installing
+## Installing
 
 ```sh
 npm install -g typescript-language-server
 ```
 
-# Running the language server
+## Running the language server
 
 ```
 typescript-language-server --stdio
@@ -32,14 +32,16 @@ typescript-language-server --stdio
   Options:
 
     -V, --version                          output the version number
-    --stdio                                use stdio (the only supported and required option)
-    --log-level <log-level>                A number indicating the log level (4 = log, 3 = info, 2 = warn, 1 = error). Defaults to `2`.
+    --stdio                                use stdio (required option)
+    --log-level <log-level>                A number indicating the log level (4 = log, 3 = info, 2 = warn, 1 = error). Defaults to `3`.
     --tsserver-log-file <tsServerLogFile>  Specify a tsserver log file. example: --tsserver-log-file=ts-logs.txt
     --tsserver-log-verbosity <verbosity>   Specify tsserver log verbosity (off, terse, normal, verbose). Defaults to `normal`. example: --tsserver-log-verbosity=verbose
-    --tsserver-path <path>                 Specify path to tsserver. example: --tsserver-path=tsserver
+    --tsserver-path <path>                 Specify path to tsserver directory. example: --tsserver-path=/Users/me/typescript/lib/
     -h, --help                             output usage information
 ```
 
+> Note: The path passed to `--tsserver-path` should ideally be a path to the `/.../typescript/lib/` directory and not to the shell script `/.../node_modules/.bin/tsserver` or `tsserver`. Though for backward-compatibility reasons, the server will try to do the right thing even when passed a path to the shell script.
+
 ## initializationOptions
 
 The language server accepts various settings through the `initializationOptions` object passed through the `initialize` request. Refer to your LSP client's documentation on how to set these. Here is the list of supported options:
@@ -47,8 +49,10 @@ The language server accepts various settings through the `initializationOptions`
 | Setting           | Type     | Description                                                                                                                                                                                                                                                          |
 |:------------------|:---------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | hostInfo          | string   | Information about the host, for example `"Emacs 24.4"` or `"Sublime Text v3075"`. **Default**: `undefined`                                                                                                                                                           |
+| disableAutomaticTypingAcquisition | boolean | Disables tsserver from automatically fetching missing type definitions (`@types` packages) for external modules. |
 | logVerbosity      | string   | The verbosity level of the information printed in the log by `tsserver`. Accepts values: `"off"`, `"terse"`, `"normal"`, `"requesttime"`, `"verbose"`. **Default**: `undefined` (`"off"`).                                                                                         |
 | maxTsServerMemory | number   | The maximum size of the V8's old memory section in megabytes (for example `4096` means 4GB). The default value is dynamically configured by Node so can differ per system. Increase for very big projects that exceed allowed memory usage. **Default**: `undefined` |
+| npmLocation       | string   | Specifies the path to the NPM executable used for Automatic Type Acquisition. |
 | plugins           | object[] | An array of `{ name: string, location: string }` objects for registering a Typescript plugins. **Default**: []                                                                                                                                                         |
 | preferences       | object   | Preferences passed to the Typescript (`tsserver`) process. See below for more info.                                                                                                                              |
 
@@ -83,6 +87,10 @@ interface UserPreferences {
      * values, with insertion text to replace preceding `.` tokens with `?.`.
      */
     includeAutomaticOptionalChainCompletions: boolean;
+    /**
+     * Allows import module names to be resolved in the initial completions request.
+     * @default false
+     */
     allowIncompleteCompletions: boolean;
     importModuleSpecifierPreference: "shortest" | "project-relative" | "relative" | "non-relative";
     /** Determines whether we import `foo/index.ts` as "foo", "foo/index", or "foo/index.js" */
@@ -102,8 +110,16 @@ From the `preferences` options listed above, this server explicilty sets the fol
 
 ```js
 {
-  includeCompletionsForModuleExports: true,
-  includeCompletionsWithInsertText: true,
+    allowIncompleteCompletions: true,
+    allowRenameOfImportPath: true,
+    allowTextChangesInNewFiles: true,
+    displayPartsForJSDoc: true,
+    generateReturnInDocTemplate: true,
+    includeAutomaticOptionalChainCompletions: true,
+    includeCompletionsForImportStatements: true,
+    includeCompletionsForModuleExports: true,
+    includeCompletionsWithInsertText: true,
+    includeCompletionsWithSnippetText: true,
 }
 ```
 
@@ -146,31 +162,64 @@ Some of the preferences can be controlled through the `workspace/didChangeConfig
 [language].inlayHints.includeInlayParameterNameHintsWhenArgumentMatchesName: boolean;
 [language].inlayHints.includeInlayPropertyDeclarationTypeHints: boolean;
 [language].inlayHints.includeInlayVariableTypeHints: boolean;
+/**
+ * Complete functions with their parameter signature.
+ * @default false
+ */
+completions.completeFunctionCalls: boolean;
+// Diagnostics code to be omitted when reporting diagnostics.
+// See https://github.com/microsoft/TypeScript/blob/master/src/compiler/diagnosticMessages.json for a full list of valid codes.
+diagnostics.ignoredCodes: number[];
+
 ```
 
-# Supported Protocol features
+## Code actions on save
 
-- [x] textDocument/didChange (incremental)
-- [x] textDocument/didClose
-- [x] textDocument/didOpen
-- [x] textDocument/didSave
+Server announces support for the `source.organizeImports.ts-ls` code action which allows editors that support running code actions on save to automatically organize imports on saving. The user can enable it with a setting similar to (can vary per-editor):
 
-- [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/references
-- [x] textDocument/signatureHelp
-- [x] workspace/symbol
-- [x] workspace/didChangeConfiguration
+```js
+"codeActionsOnSave": {
+    "source.organizeImports": true,
+    // or
+    "source.organizeImports.ts-ls": true,
+}
+```
+
+## Workspace commands (`workspace/executeCommand`)
+
+See [LSP specification](https://microsoft.github.io/language-server-protocol/specifications/specification-3-17/#workspace_executeCommand).
 
-## `typescript/inlayHints` (experimental, supported from Typescript v4.4.2)
+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, `tsp` refers to the typescript server protocol.
+
+* `_typescript.applyWorkspaceEdit`
+    ```ts
+    type Arguments = [lsp.WorkspaceEdit]
+    ```
+* `_typescript.applyCodeAction`
+    ```ts
+    type Arguments = [tsp.CodeAction]
+    ```
+* `_typescript.applyRefactoring`
+    ```ts
+    type Arguments = [tsp.GetEditsForRefactorRequestArgs]
+    ```
+* `_typescript.organizeImports`
+    ```ts
+    // The "skipDestructiveCodeActions" argument is supported from Typescript 4.4+
+    type Arguments = [string] | [string, { skipDestructiveCodeActions?: boolean }]
+    ```
+* `_typescript.applyRenameFile`
+    ```ts
+    type Arguments = [{ sourceUri: string; targetUri: string; }]
+    ```
+
+## Inlay hints (`typescript/inlayHints`) (experimental)
+
+Supports experimental inline hints.
 
 ```ts
 type Request = {
@@ -206,7 +255,9 @@ export interface InlayHintsOptions extends UserPreferences {
 }
 ```
 
-## `textDocument/calls` (experimental)
+## Callers and callees (`textDocument/calls`) (experimental)
+
+Supports showing callers and calles for a given symbol. If the editor has support for appropriate UI, it can generate a tree of callers and calles for a document.
 
 ```ts
 type Request = {
@@ -288,7 +339,31 @@ interface DefinitionSymbol {
 }
 ```
 
-# Development
+## Supported Protocol features
+
+- [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/references
+- [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
+
+## Development
 
 ### Build
 
@@ -296,7 +371,7 @@ interface DefinitionSymbol {
 yarn
 ```
 
-## Test
+### Test
 
 ```sh
 yarn test

package/lib/cli.js

@@ -27,9 +27,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
-const utils_1 = require("./utils");
 const lsp_connection_1 = require("./lsp-connection");
 const lsp = __importStar(require("vscode-languageserver/node"));
+const DEFAULT_LOG_LEVEL = lsp.MessageType.Info;
 const program = new commander_1.Command('typescript-language-server')
     // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires
     .version(require('../package.json').version)
@@ -38,18 +38,18 @@ const program = new commander_1.Command('typescript-language-server')
     .option('--tsserver-log-file <tsserverLogFile>', 'Specify a tsserver log file. example: --tsserver-log-file ts-logs.txt')
     .option('--tsserver-log-verbosity <tsserverLogVerbosity>', 'Specify a tsserver log verbosity (terse, normal, verbose). Defaults to `normal`.' +
     ' example: --tsserver-log-verbosity verbose')
-    .option('--tsserver-path <path>', `Specify path to tsserver. example: --tsserver-path=${(0, utils_1.getTsserverExecutable)()}`)
+    .option('--tsserver-path <path>', 'Specify path to tsserver directory. example: --tsserver-path=/Users/me/typescript/lib/')
     .parse(process.argv);
 const options = program.opts();
 if (options.tsserverLogFile && !options.tsserverLogVerbosity) {
     options.tsserverLogVerbosity = 'normal';
 }
-let logLevel = lsp.MessageType.Warning;
+let logLevel = DEFAULT_LOG_LEVEL;
 if (options.logLevel) {
     logLevel = parseInt(options.logLevel, 10);
     if (logLevel && (logLevel < 1 || logLevel > 4)) {
         console.error(`Invalid '--log-level ${logLevel}'. Falling back to 'info' level.`);
-        logLevel = lsp.MessageType.Warning;
+        logLevel = DEFAULT_LOG_LEVEL;
     }
 }
 (0, lsp_connection_1.createLspConnection)({

package/lib/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;AACA;;;;;GAKG;;;;;;;;;;;;;;;;;;;;;AAEH,yCAAoC;AACpC,mCAAgD;AAChD,qDAAuD;AACvD,gEAAkD;AAElD,MAAM,OAAO,GAAG,IAAI,mBAAO,CAAC,4BAA4B,CAAC;IACrD,qGAAqG;KACpG,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC;KAC3C,cAAc,CAAC,SAAS,EAAE,WAAW,CAAC;KACtC,MAAM,CAAC,wBAAwB,EAAE,8FAA8F,CAAC;KAChI,MAAM,CAAC,uCAAuC,EAAE,uEAAuE,CAAC;KACxH,MAAM,CAAC,iDAAiD,EAAE,kFAAkF;IAC3I,4CAA4C,CAAC;KAC9C,MAAM,CAAC,wBAAwB,EAAE,sDAAsD,IAAA,6BAAqB,GAAE,EAAE,CAAC;KACjH,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAEzB,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;AAE/B,IAAI,OAAO,CAAC,eAAe,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE;IAC1D,OAAO,CAAC,oBAAoB,GAAG,QAAQ,CAAC;CAC3C;AAED,IAAI,QAAQ,GAAG,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC;AACvC,IAAI,OAAO,CAAC,QAAQ,EAAE;IAClB,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAC1C,IAAI,QAAQ,IAAI,CAAC,QAAQ,GAAG,CAAC,IAAI,QAAQ,GAAG,CAAC,CAAC,EAAE;QAC5C,OAAO,CAAC,KAAK,CAAC,wBAAwB,QAAQ,kCAAkC,CAAC,CAAC;QAClF,QAAQ,GAAG,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC;KACtC;CACJ;AAED,IAAA,oCAAmB,EAAC;IAChB,YAAY,EAAE,OAAO,CAAC,YAAsB;IAC5C,eAAe,EAAE,OAAO,CAAC,eAAyB;IAClD,oBAAoB,EAAE,OAAO,CAAC,oBAA8B;IAC5D,gBAAgB,EAAE,QAA2B;CAChD,CAAC,CAAC,MAAM,EAAE,CAAC"}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;AACA;;;;;GAKG;;;;;;;;;;;;;;;;;;;;;AAEH,yCAAoC;AACpC,qDAAuD;AACvD,gEAAkD;AAElD,MAAM,iBAAiB,GAAG,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC;AAE/C,MAAM,OAAO,GAAG,IAAI,mBAAO,CAAC,4BAA4B,CAAC;IACrD,qGAAqG;KACpG,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC;KAC3C,cAAc,CAAC,SAAS,EAAE,WAAW,CAAC;KACtC,MAAM,CAAC,wBAAwB,EAAE,8FAA8F,CAAC;KAChI,MAAM,CAAC,uCAAuC,EAAE,uEAAuE,CAAC;KACxH,MAAM,CAAC,iDAAiD,EAAE,kFAAkF;IAC3I,4CAA4C,CAAC;KAC9C,MAAM,CAAC,wBAAwB,EAAE,wFAAwF,CAAC;KAC1H,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAEzB,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;AAE/B,IAAI,OAAO,CAAC,eAAe,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE;IAC1D,OAAO,CAAC,oBAAoB,GAAG,QAAQ,CAAC;CAC3C;AAED,IAAI,QAAQ,GAAG,iBAAiB,CAAC;AACjC,IAAI,OAAO,CAAC,QAAQ,EAAE;IAClB,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAC1C,IAAI,QAAQ,IAAI,CAAC,QAAQ,GAAG,CAAC,IAAI,QAAQ,GAAG,CAAC,CAAC,EAAE;QAC5C,OAAO,CAAC,KAAK,CAAC,wBAAwB,QAAQ,kCAAkC,CAAC,CAAC;QAClF,QAAQ,GAAG,iBAAiB,CAAC;KAChC;CACJ;AAED,IAAA,oCAAmB,EAAC;IAChB,YAAY,EAAE,OAAO,CAAC,YAAsB;IAC5C,eAAe,EAAE,OAAO,CAAC,eAAyB;IAClD,oBAAoB,EAAE,OAAO,CAAC,oBAA8B;IAC5D,gBAAgB,EAAE,QAA2B;CAChD,CAAC,CAAC,MAAM,EAAE,CAAC"}

package/lib/commands.d.ts

@@ -8,4 +8,7 @@ export declare const Commands: {
     /** Commands below should be implemented by the client */
     SELECT_REFACTORING: string;
 };
+export declare const CodeActions: {
+    SourceOrganizeImportsTsLs: string;
+};
 //# sourceMappingURL=commands.d.ts.map

package/lib/commands.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../src/commands.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,QAAQ;;;;;;;IAOjB,yDAAyD;;CAE5D,CAAC"}
+{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../src/commands.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,QAAQ;;;;;;;IAOjB,yDAAyD;;CAE5D,CAAC;AAEF,eAAO,MAAM,WAAW;;CAEvB,CAAC"}

package/lib/commands.js

@@ -6,7 +6,7 @@
  * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Commands = void 0;
+exports.CodeActions = exports.Commands = void 0;
 exports.Commands = {
     APPLY_WORKSPACE_EDIT: '_typescript.applyWorkspaceEdit',
     APPLY_CODE_ACTION: '_typescript.applyCodeAction',
@@ -17,4 +17,7 @@ exports.Commands = {
     /** Commands below should be implemented by the client */
     SELECT_REFACTORING: '_typescript.selectRefactoring'
 };
+exports.CodeActions = {
+    SourceOrganizeImportsTsLs: 'source.organizeImports.ts-ls'
+};
 //# sourceMappingURL=commands.js.map

package/lib/commands.js.map

@@ -1 +1 @@
-{"version":3,"file":"commands.js","sourceRoot":"","sources":["../src/commands.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,QAAQ,GAAG;IACpB,oBAAoB,EAAE,gCAAgC;IACtD,iBAAiB,EAAE,6BAA6B;IAChD,iBAAiB,EAAE,8BAA8B;IACjD,gBAAgB,EAAE,6BAA6B;IAC/C,iBAAiB,EAAE,6BAA6B;IAChD,4BAA4B,EAAE,uCAAuC;IACrE,yDAAyD;IACzD,kBAAkB,EAAE,+BAA+B;CACtD,CAAC"}
+{"version":3,"file":"commands.js","sourceRoot":"","sources":["../src/commands.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,QAAQ,GAAG;IACpB,oBAAoB,EAAE,gCAAgC;IACtD,iBAAiB,EAAE,6BAA6B;IAChD,iBAAiB,EAAE,8BAA8B;IACjD,gBAAgB,EAAE,6BAA6B;IAC/C,iBAAiB,EAAE,6BAA6B;IAChD,4BAA4B,EAAE,uCAAuC;IACrE,yDAAyD;IACzD,kBAAkB,EAAE,+BAA+B;CACtD,CAAC;AAEW,QAAA,WAAW,GAAG;IACvB,yBAAyB,EAAE,8BAA8B;CAC5D,CAAC"}

package/lib/completion.d.ts

@@ -1,10 +1,13 @@
 import * as lsp from 'vscode-languageserver/node';
 import type tsp from 'typescript/lib/protocol';
 import { LspDocument } from './document';
+import { TspClient } from './tsp-client';
+import { CompletionOptions } from './ts-protocol';
 interface TSCompletionItem extends lsp.CompletionItem {
     data: tsp.CompletionDetailsRequestArgs;
 }
 export declare function asCompletionItem(entry: tsp.CompletionEntry, file: string, position: lsp.Position, document: LspDocument): TSCompletionItem;
-export declare function asResolvedCompletionItem(item: lsp.CompletionItem, details: tsp.CompletionEntryDetails): lsp.CompletionItem;
+export declare function asResolvedCompletionItem(item: lsp.CompletionItem, details: tsp.CompletionEntryDetails, client: TspClient, options: CompletionOptions): Promise<lsp.CompletionItem>;
+export declare function isValidFunctionCompletionContext(filepath: string, position: lsp.Position, client: TspClient): Promise<boolean>;
 export {};
 //# sourceMappingURL=completion.d.ts.map

package/lib/completion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"completion.d.ts","sourceRoot":"","sources":["../src/completion.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,GAAG,MAAM,4BAA4B,CAAC;AAClD,OAAO,KAAK,GAAG,MAAM,yBAAyB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAKzC,UAAU,gBAAiB,SAAQ,GAAG,CAAC,cAAc;IACjD,IAAI,EAAE,GAAG,CAAC,4BAA4B,CAAC;CAC1C;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,GAAG,CAAC,eAAe,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,GAAG,gBAAgB,CA2D1I;AA6ED,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,GAAG,CAAC,cAAc,EAAE,OAAO,EAAE,GAAG,CAAC,sBAAsB,GAAG,GAAG,CAAC,cAAc,CAS1H"}
+{"version":3,"file":"completion.d.ts","sourceRoot":"","sources":["../src/completion.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,GAAG,MAAM,4BAA4B,CAAC;AAClD,OAAO,KAAK,GAAG,MAAM,yBAAyB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAIzC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,iBAAiB,EAAmB,MAAM,eAAe,CAAC;AAInE,UAAU,gBAAiB,SAAQ,GAAG,CAAC,cAAc;IACjD,IAAI,EAAE,GAAG,CAAC,4BAA4B,CAAC;CAC1C;AAOD,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,GAAG,CAAC,eAAe,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,GAAG,gBAAgB,CAoF1I;AA6ED,wBAAsB,wBAAwB,CAC1C,IAAI,EAAE,GAAG,CAAC,cAAc,EAAE,OAAO,EAAE,GAAG,CAAC,sBAAsB,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,iBAAiB,GAC7G,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAmB7B;AAED,wBAAsB,gCAAgC,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,CAuBpI"}

package/lib/completion.js

@@ -24,38 +24,57 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.asResolvedCompletionItem = exports.asCompletionItem = void 0;
+exports.isValidFunctionCompletionContext = exports.asResolvedCompletionItem = exports.asCompletionItem = void 0;
 const lsp = __importStar(require("vscode-languageserver/node"));
 const tsp_command_types_1 = require("./tsp-command-types");
 const protocol_translation_1 = require("./protocol-translation");
 const commands_1 = require("./commands");
+const ts_protocol_1 = require("./ts-protocol");
+const SnippetString_1 = __importDefault(require("./utils/SnippetString"));
+const typeConverters = __importStar(require("./utils/typeConverters"));
 function asCompletionItem(entry, file, position, document) {
     const item = {
         label: entry.name,
         kind: asCompletionItemKind(entry.kind),
         sortText: entry.sortText,
         commitCharacters: asCommitCharacters(entry.kind),
+        preselect: entry.isRecommended,
         data: {
             file,
             line: position.line + 1,
             offset: position.character + 1,
             entryNames: [
-                entry.source ? { name: entry.name, source: entry.source } : entry.name
+                entry.source || entry.data ? {
+                    name: entry.name,
+                    source: entry.source,
+                    data: entry.data
+                } : entry.name
             ]
         }
     };
-    if (entry.isRecommended) {
-        // Make sure isRecommended property always comes first
-        // https://github.com/Microsoft/vscode/issues/40325
-        item.preselect = true;
-    }
-    else if (entry.source) {
+    if (entry.source && entry.hasAction) {
         // De-prioritze auto-imports
         // https://github.com/Microsoft/vscode/issues/40311
         item.sortText = '\uffff' + entry.sortText;
     }
-    if (item.kind === lsp.CompletionItemKind.Function || item.kind === lsp.CompletionItemKind.Method) {
+    const { sourceDisplay } = entry;
+    if (sourceDisplay) {
+        item.detail = (0, protocol_translation_1.asPlainText)(sourceDisplay);
+    }
+    if (entry.isImportStatementCompletion || item.kind === lsp.CompletionItemKind.Function || item.kind === lsp.CompletionItemKind.Method) {
         item.insertTextFormat = lsp.InsertTextFormat.Snippet;
     }
     let insertText = entry.insertText;
@@ -69,7 +88,7 @@ function asCompletionItem(entry, file, position, document) {
     }
     if (entry.kindModifiers) {
         const kindModifiers = new Set(entry.kindModifiers.split(/,|\s+/g));
-        if (kindModifiers.has('optional')) {
+        if (kindModifiers.has(tsp_command_types_1.KindModifiers.optional)) {
             if (!insertText) {
                 insertText = item.label;
             }
@@ -78,9 +97,25 @@ function asCompletionItem(entry, file, position, document) {
             }
             item.label += '?';
         }
-        if (kindModifiers.has('deprecated')) {
+        if (kindModifiers.has(tsp_command_types_1.KindModifiers.deprecated)) {
             item.tags = [lsp.CompletionItemTag.Deprecated];
         }
+        if (kindModifiers.has(tsp_command_types_1.KindModifiers.color)) {
+            item.kind = lsp.CompletionItemKind.Color;
+        }
+        if (entry.kind === tsp_command_types_1.ScriptElementKind.scriptElement) {
+            for (const extModifier of tsp_command_types_1.KindModifiers.fileExtensionKindModifiers) {
+                if (kindModifiers.has(extModifier)) {
+                    if (entry.name.toLowerCase().endsWith(extModifier)) {
+                        item.detail = entry.name;
+                    }
+                    else {
+                        item.detail = entry.name + extModifier;
+                    }
+                    break;
+                }
+            }
+        }
     }
     if (insertText && replacementRange) {
         item.textEdit = lsp.TextEdit.replace(replacementRange, insertText);
@@ -162,18 +197,135 @@ function asCommitCharacters(kind) {
     }
     return commitCharacters.length === 0 ? undefined : commitCharacters;
 }
-function asResolvedCompletionItem(item, details) {
+function asResolvedCompletionItem(item, details, client, options) {
     var _a;
-    item.detail = asDetail(details);
-    item.documentation = (0, protocol_translation_1.asDocumentation)(details);
-    if ((_a = details.codeActions) === null || _a === void 0 ? void 0 : _a.length) {
+    return __awaiter(this, void 0, void 0, function* () {
+        item.detail = asDetail(details);
+        item.documentation = (0, protocol_translation_1.asDocumentation)(details);
         const filepath = (0, protocol_translation_1.normalizePath)(item.data.file);
-        item.additionalTextEdits = asAdditionalTextEdits(details.codeActions, filepath);
-        item.command = asCommand(details.codeActions, item.data.file);
-    }
-    return item;
+        if ((_a = details.codeActions) === null || _a === void 0 ? void 0 : _a.length) {
+            item.additionalTextEdits = asAdditionalTextEdits(details.codeActions, filepath);
+            item.command = asCommand(details.codeActions, item.data.file);
+        }
+        if (options.completeFunctionCalls && item.insertTextFormat === lsp.InsertTextFormat.Snippet
+            && (item.kind === lsp.CompletionItemKind.Function || item.kind === lsp.CompletionItemKind.Method)) {
+            const { line, offset } = item.data;
+            const position = typeConverters.Position.fromLocation({ line, offset });
+            const shouldCompleteFunction = yield isValidFunctionCompletionContext(filepath, position, client);
+            if (shouldCompleteFunction) {
+                createSnippetOfFunctionCall(item, details);
+            }
+        }
+        return item;
+    });
 }
 exports.asResolvedCompletionItem = asResolvedCompletionItem;
+function isValidFunctionCompletionContext(filepath, position, client) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // Workaround for https://github.com/Microsoft/TypeScript/issues/12677
+        // Don't complete function calls inside of destructive assigments or imports
+        try {
+            const args = typeConverters.Position.toFileLocationRequestArgs(filepath, position);
+            const response = yield client.request("quickinfo" /* Quickinfo */, args);
+            if (response.type !== 'response') {
+                return true;
+            }
+            const { body } = response;
+            switch (body === null || body === void 0 ? void 0 : body.kind) {
+                case 'var':
+                case 'let':
+                case 'const':
+                case 'alias':
+                    return false;
+                default:
+                    return true;
+            }
+        }
+        catch (_a) {
+            return true;
+        }
+    });
+}
+exports.isValidFunctionCompletionContext = isValidFunctionCompletionContext;
+function createSnippetOfFunctionCall(item, detail) {
+    const { displayParts } = detail;
+    const parameterListParts = getParameterListParts(displayParts);
+    const snippet = new SnippetString_1.default();
+    snippet.appendText(`${item.insertText || item.label}(`);
+    appendJoinedPlaceholders(snippet, parameterListParts.parts, ', ');
+    if (parameterListParts.hasOptionalParameters) {
+        snippet.appendTabstop();
+    }
+    snippet.appendText(')');
+    snippet.appendTabstop(0);
+    item.insertText = snippet.value;
+}
+function getParameterListParts(displayParts) {
+    const parts = [];
+    let isInMethod = false;
+    let hasOptionalParameters = false;
+    let parenCount = 0;
+    let braceCount = 0;
+    outer: for (let i = 0; i < displayParts.length; ++i) {
+        const part = displayParts[i];
+        switch (part.kind) {
+            case ts_protocol_1.DisplayPartKind.methodName:
+            case ts_protocol_1.DisplayPartKind.functionName:
+            case ts_protocol_1.DisplayPartKind.text:
+            case ts_protocol_1.DisplayPartKind.propertyName:
+                if (parenCount === 0 && braceCount === 0) {
+                    isInMethod = true;
+                }
+                break;
+            case ts_protocol_1.DisplayPartKind.parameterName:
+                if (parenCount === 1 && braceCount === 0 && isInMethod) {
+                    // Only take top level paren names
+                    const next = displayParts[i + 1];
+                    // Skip optional parameters
+                    const nameIsFollowedByOptionalIndicator = next && next.text === '?';
+                    // Skip this parameter
+                    const nameIsThis = part.text === 'this';
+                    if (!nameIsFollowedByOptionalIndicator && !nameIsThis) {
+                        parts.push(part);
+                    }
+                    hasOptionalParameters = hasOptionalParameters || nameIsFollowedByOptionalIndicator;
+                }
+                break;
+            case ts_protocol_1.DisplayPartKind.punctuation:
+                if (part.text === '(') {
+                    ++parenCount;
+                }
+                else if (part.text === ')') {
+                    --parenCount;
+                    if (parenCount <= 0 && isInMethod) {
+                        break outer;
+                    }
+                }
+                else if (part.text === '...' && parenCount === 1) {
+                    // Found rest parmeter. Do not fill in any further arguments
+                    hasOptionalParameters = true;
+                    break outer;
+                }
+                else if (part.text === '{') {
+                    ++braceCount;
+                }
+                else if (part.text === '}') {
+                    --braceCount;
+                }
+                break;
+        }
+    }
+    return { hasOptionalParameters, parts };
+}
+function appendJoinedPlaceholders(snippet, parts, joiner) {
+    for (let i = 0; i < parts.length; ++i) {
+        const paramterPart = parts[i];
+        snippet.appendPlaceholder(paramterPart.text);
+        if (i !== parts.length - 1) {
+            snippet.appendText(joiner);
+        }
+    }
+}
 function asAdditionalTextEdits(codeActions, filepath) {
     // Try to extract out the additionalTextEdits for the current file.
     const additionalTextEdits = [];