VTSLS

https://github.com/yioneko/vtsls
Admin
VTSLS is an LSP wrapper around TypeScript extension bundled with VSCode that provides TypeScript...
Tokens:37,977
Snippets:473
Trust Score:8.6
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### vtsls Usage Examples

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/endpoints.md

Common commands for starting the server and inspecting configuration.

```bash
# Start server with stdio (default)
vtsls --stdio

# Print configuration schema
vtsls --print-config-schema | jq .

# Get version
vtsls --version
```

--------------------------------

### Binary entry point example

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/server-entry.md

Example of calling the main function.

```typescript
// Binary entry point
main();
```

--------------------------------

### CLI version command example

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/server-entry.md

Example usage of the version flag.

```bash
$ vtsls --version
0.3.0
```

--------------------------------

### CLI print-config-schema command example

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/server-entry.md

Example usage of the print-config-schema flag.

```bash
$ vtsls --print-config-schema | jq .properties.typescript
{
  "tsdk": {
    "type": "string",
    "markdownDescription": "..."
  },
  ...
}
```

--------------------------------

### Install vtsls

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/README.md

Install the language server globally via npm and verify the version.

```bash
npm install -g @vtsls/language-server
vtsls --version  # 0.3.0
```

--------------------------------

### CLI help output

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/server-entry.md

Example output displayed when running the help command.

```text
vtsls v0.3.0

Usage: vtsls [options]

Language Server Options:
  --stdio                 Use stdio for communication (default)
  --node-ipc              Use node-ipc for communication
  --socket=<number>       Use socket for communication

Other Options:
  --help, -h              Show this help message
  --version, -V           Print version information
  --print-config-schema   Print the configuration schema as JSON
```

--------------------------------

### Initialize the LSP server

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/server-entry.md

Starts the server instance and begins listening for client connections.

```typescript
function createLanguageServer(): void
```

```typescript
// CLI entry point
createLanguageServer();  // Server starts listening for connections
```

--------------------------------

### Install and Run vtsls

Source: https://github.com/yioneko/vtsls/blob/main/README.md

Install the vtsls language server globally using npm and run it with standard input/output. Requires Node.js version 16 or higher.

```bash
npm install -g @vtsls/language-server
vtsls --stdio
```

--------------------------------

### Start vtsls Server

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/README.md

Commands to start the server using different transport protocols or to retrieve configuration information.

```bash
# Default: stdio
vtsls --stdio

# Or:
vtsls --node-ipc
vtsls --socket=12345

# Get help
vtsls --help

# Get config schema
vtsls --print-config-schema | jq .
```

--------------------------------

### Install vtsls Globally

Source: https://github.com/yioneko/vtsls/blob/main/README.md

Install the built vtsls server globally to make the `vtsls` command available in your PATH. This is useful for testing the server independently.

```sh
cd packages/server && sudo npm install -g .
```

--------------------------------

### Configuration Hierarchy Example

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/README.md

Example of the hierarchical JSON structure used for TypeScript configuration.

```json
{
  "typescript": {
    "tsdk": "./node_modules/typescript/lib",
    "preferences": {
      "quotePreference": "single"
    }
  }
}
```

--------------------------------

### createLanguageServer

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/server-entry.md

Creates and starts an LSP server instance by establishing a connection and registering event handlers.

```APIDOC
## createLanguageServer

### Description
Creates and starts an LSP server instance. It establishes a connection using VSCode's LSP library, registers event handlers, and begins listening for client connections.

### Signature
`function createLanguageServer(): void`
```

--------------------------------

### Build vtsls packages

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/README.md

Commands to install dependencies and build all packages, with an option for watch mode.

```bash
pnpm install
pnpm build          # Build all packages
pnpm build:watch    # Watch mode
```

--------------------------------

### Integrate vtsls with LSP Client

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/README.md

Example of initializing the language service, subscribing to events, opening documents, and making LSP requests.

```typescript
import {
  createTSLanguageService,
  TSLanguageService
} from '@vtsls/language-service';
import * as lsp from 'vscode-languageserver-protocol';

// 1. Create service
const service = createTSLanguageService({
  clientCapabilities: {} as lsp.ClientCapabilities,
  locale: 'en'
});

// 2. Subscribe to events
service.onDiagnostics(({ uri, diagnostics }) => {
  console.log(`Diagnostics for ${uri}:`, diagnostics);
});

service.onLogMessage(({ type, message }) => {
  console.log(`[${type}] ${message}`);
});

// 3. Initialize with config
await service.initialize({
  typescript: {
    tsdk: './node_modules/typescript/lib',
    preferences: { quotePreference: 'single' }
  }
});

// 4. Open a document
service.openTextDocument({
  textDocument: {
    uri: 'file:///workspace/main.ts',
    languageId: 'typescript',
    version: 1,
    text: 'const x: string = 42;'  // Type error
  }
});

// 5. Make requests
const diagnostics = await new Promise(resolve => {
  service.onDiagnostics(({ uri, diagnostics }) => {
    resolve(diagnostics);
  });
});

const hover = await service.hover({
  textDocument: { uri: 'file:///workspace/main.ts' },
  position: { line: 0, character: 6 }
});

const completion = await service.completion({
  textDocument: { uri: 'file:///workspace/main.ts' },
  position: { line: 0, character: 6 }
}, lsp.CancellationToken.None);

// 6. Cleanup
service.dispose();
```

--------------------------------

### Build vtsls Server

Source: https://github.com/yioneko/vtsls/blob/main/README.md

Instructions for building the vtsls server from source. This involves updating submodules, installing dependencies, and running the build script.

```sh
git submodule update --init
pnpm install
pnpm build # or pnpm build:watch
```

--------------------------------

### Configure vtsls.tsserver.globalPlugins

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/configuration.md

Configuration for loading global TypeScript plugins, including structure and example usage.

```typescript
{
  name: string;              // Plugin package name (e.g., "@styled/typescript-styled-plugin")
  location: string;          // Directory containing the plugin (e.g., "/usr/local/lib/node_modules")
  enableForWorkspaceTypeScriptVersions?: boolean;  // Use for workspace TS versions too
}
```

```json
{
  "vtsls": {
    "tsserver": {
      "globalPlugins": [
        {
          "name": "@styled/typescript-styled-plugin",
          "location": "/usr/local/lib/node_modules",
          "enableForWorkspaceTypeScriptVersions": true
        }
      ]
    }
  }
}
```

--------------------------------

### Start Connection Listener

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/server-entry.md

Starts the connection listener, which blocks execution until the process exits or the connection is closed.

```typescript
conn.listen()
```

--------------------------------

### conn.listen

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/server-entry.md

Starts the LSP connection listener, blocking the process until the connection is closed or the process exits.

```APIDOC
## conn.listen

### Description
Starts listening for client connections. This method blocks until the process exits or the connection closes.

### Signature
`conn.listen()`
```

--------------------------------

### Handle DocumentNotOpenedError

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/errors.md

Example demonstrating the failure when accessing an unopened document and the correct sequence to open it.

```typescript
// This will fail:
await service.hover({
  textDocument: { uri: 'file:///unopened.ts' },
  position: { line: 0, character: 0 }
});
// → DocumentNotOpenedError

// Correct sequence:
service.openTextDocument({
  textDocument: {
    uri: 'file:///foo.ts',
    languageId: 'typescript',
    version: 1,
    text: 'const x = 1;'
  }
});

// Now requests work:
const hover = await service.hover({
  textDocument: { uri: 'file:///foo.ts' },
  position: { line: 0, character: 0 }
});
```

--------------------------------

### Initialize service handlers

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/server-entry.md

Example usage of bindServiceHandlers to connect the language service to the connection and register diagnostic listeners.

```typescript
bindServiceHandlers(conn, service, clientCapabilities);

// Now all handlers are connected:
conn.onCompletion(service.completion);
service.onDiagnostics(({ uri, diagnostics }) => {
  conn.sendDiagnostics({ uri, diagnostics });
});
```

--------------------------------

### TypeScript TSServer Commands

Source: https://github.com/yioneko/vtsls/blob/main/README.md

Examples of various TypeScript TSServer commands available through the vtsls server. Refer to CommandTypes for a full list.

```typescript
typescript.openTsServerLog
```

```typescript
typescript.restartTsServer
```

```typescript
typescript.reloadProjects
```

```typescript
javascript.reloadProjects
```

```typescript
typescript.selectTypeScriptVersion
```

```typescript
typescript.goToSourceDefinition: [DocumentUri, Position] => Location[]
```

```typescript
typescript.findAllFileReferences: [DocumentUri] => Location[]
```

```typescript
typescript.goToProjectConfig: [DocumentUri] => null
```

```typescript
javascript.goToProjectConfig: [DocumentUri] => null
```

```typescript
_typescript.configurePlugin: [pluginName: string, config: any] => any
```

```typescript
typescript.tsserverRequest: [RequestType, args: any, config: any] => any
```

```typescript
typescript.organizeImports: [filePath: string] => any
```

```typescript
typescript.sortImports: [filePath: string] => any
```

```typescript
javascript.sortImports: [filePath: string] => any
```

```typescript
typescript.removeUnusedImports: [filePath: string] => any
```

```typescript
javascript.removeUnusedImports: [filePath: string] => any
```

--------------------------------

### Get Default LSP Capabilities

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/server-entry.md

Retrieves the full set of supported LSP server capabilities.

```typescript
const capabilities = getTsLspDefaultCapabilities();
// {
//   textDocumentSync: { ... },
//   completionProvider: { ... },
//   hoverProvider: true,
//   ...
// }
```

--------------------------------

### Use WorkDoneProgressReporter

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/types.md

Example usage of the reporter to track progress of a long-running operation.

```typescript
const reporter = await service.onWorkDoneProgress();
reporter.begin('Analyzing TypeScript files', 0, 'Initializing');
reporter.report(25);
reporter.report('Found 100 files');
reporter.report(50, 'Analyzing exports');
reporter.done();
```

--------------------------------

### Configure Global TypeScript Plugins

Source: https://github.com/yioneko/vtsls/blob/main/README.md

Specify global TypeScript plugins, such as for styled-components, by providing their name and location. This allows testing plugins without local installation or tsconfig modification.

```json
[
  {
    "name": "@styled/typescript-styled-plugin",
    "location": "/usr/local/lib/node_modules",
    "enableForWorkspaceTypeScriptVersions": true,
  }
]
```

--------------------------------

### Complete Server Flow

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/server-entry.md

Demonstrates the full lifecycle from launch and initialization to request handling and shutdown.

```typescript
// 1. Client launches: vtsls --stdio
main();

// 2. Server creates connection
const conn = createConnection(ProposedFeatures.all);
conn.listen();

// 3. Client sends: initialize request
// Server handler:
const { capabilities } = onServerInitialize(conn, {
  capabilities: { ... },
  rootUri: 'file:///workspace'
});
// Server responds with capabilities

// 4. Client processes capabilities and sends: initialized notification
conn.onInitialized(() => {
  bindServiceHandlers(conn, service, ...);
  await initializeService();  // Fetch config and initialize
});

// 5. Client and server exchange requests/notifications
conn.onCompletion(safeRun(service.completion, null));
service.onDiagnostics(({ uri, diagnostics }) => {
  conn.sendDiagnostics({ uri, diagnostics });
});

// 6. Client closes connection
conn.onExit(() => service.dispose());
```

--------------------------------

### Initialize and Use TSLanguageService

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/language-service.md

Demonstrates creating a service instance, configuring it via initialize, and registering a diagnostic handler.

```typescript
import { createTSLanguageService } from '@vtsls/language-service';
import { ClientCapabilities } from 'vscode-languageserver-protocol';

const service = createTSLanguageService({
  clientCapabilities: {} as ClientCapabilities,
  locale: 'en',
  workspaceFolders: [
    { name: 'root', uri: 'file:///workspace' }
  ]
});

// Initialize the service with configuration
await service.initialize({
  typescript: {
    tsdk: './node_modules/typescript/lib',
    preferences: {
      quotePreference: 'single'
    }
  }
});

// Use handlers to respond to language requests
service.onDiagnostics(({ uri, diagnostics }) => {
  console.log(`Diagnostics for ${uri}:`, diagnostics);
});
```

--------------------------------

### onServerInitialize

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/server-entry.md

Handles the LSP initialize request from the client to configure the language service.

```APIDOC
## onServerInitialize

### Description
Handles the LSP initialize request from the client. It extracts workspace information, initializes the TSLanguageService, and returns the server capabilities.

### Signature
`function onServerInitialize(conn: Connection, params: InitializeParams): InitializeResult`

### Parameters
- **conn** (Connection) - Required - LSP connection to the client
- **params.capabilities** (ClientCapabilities) - Required - LSP features the client supports
- **params.rootUri** (string) - Required - Root workspace URI
- **params.rootPath** (string) - Optional - Root workspace path
- **params.workspaceFolders** (WorkspaceFolder[]) - Optional - Initial workspace folders
- **params.locale** (string) - Optional - Locale for error messages
- **params.initializationOptions** (object) - Optional - Custom initialization options

### Return Type
- **capabilities** (ServerCapabilities) - Supported protocol methods and options
- **serverInfo** (object) - Server name and version
```

--------------------------------

### Handle ProviderNotFoundError

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/types.md

Example of catching and identifying a ProviderNotFoundError during service operations.

```typescript
try {
  await service.prepareRename(params);
} catch (e) {
  if (e instanceof ProviderNotFoundError) {
    console.log(`Feature ${e.message} not available in this TypeScript version`);
  }
}
```

--------------------------------

### Catch and handle ResponseError

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/errors.md

Example of catching a ResponseError during a service command execution.

```typescript
try {
  await service.executeCommand({
    command: 'typescript.unknownCommand',
    arguments: []
  });
} catch (e) {
  if (e instanceof ResponseError) {
    console.log(`Error ${e.code}: ${e.message}`);
  }
}
```

--------------------------------

### initialize

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/language-service.md

Initializes the service with configuration. Must be called before any requests are processed.

```APIDOC
## initialize(config: TSLanguageServiceConfig)

### Description
Initializes the service with configuration. Must be called before any requests are processed. Can be called multiple times; subsequent calls update the configuration.

### Parameters
- **config** (TSLanguageServiceConfig) - Required - Configuration object with dotted keys for settings.
```

--------------------------------

### service.initialize

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/README.md

Configures and initializes the language service with TypeScript settings.

```APIDOC
## service.initialize

### Description
Initializes the service with TypeScript configuration, including the path to the TSDK and user preferences.

### Parameters
- **typescript** (object) - Required - Configuration object containing 'tsdk' path and 'preferences'.
```

--------------------------------

### Project File Manifest

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/INDEX.md

Displays the directory structure of the documentation output.

```text
output/
├── README.md                      # Project overview & quick start
├── INDEX.md                       # This file
├── types.md                       # Type definitions
├── configuration.md               # Configuration reference
├── endpoints.md                   # LSP endpoints & capabilities
├── errors.md                      # Error types & troubleshooting
└── api-reference/
    ├── language-service.md        # Main TSLanguageService API
    ├── server-entry.md            # LSP server implementation
    └── converter.md               # VSCode ↔ LSP converter
```

--------------------------------

### Apply configuration settings in TypeScript

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/errors.md

Demonstrates how invalid configuration paths are handled by the service.

```typescript
service.changeConfiguration({
  settings: {
    'typescript.tsdk': '/path/that/does/not/exist'
    // → Silently ignored; bundled TypeScript is used
  }
});
```

--------------------------------

### vtsls Command Line Options

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/endpoints.md

List of available command-line arguments for configuring the vtsls server.

```bash
vtsls [options]

Language Server Options:
  --stdio                 Use stdio for communication (default)
  --node-ipc              Use node-ipc for communication
  --socket=<number>       Use socket for communication

Other Options:
  --help, -h              Show this help message
  --version, -V           Print version information
  --print-config-schema   Print the configuration schema as JSON
```

--------------------------------

### Handle server initialization

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/server-entry.md

Defines the signature and return structure for the LSP initialize request handler.

```typescript
function onServerInitialize(
  conn: Connection,
  params: InitializeParams
): InitializeResult
```

```typescript
{
  capabilities: ServerCapabilities,
  serverInfo: { name: "vtsls", version: string }
}
```

```typescript
const result = onServerInitialize(conn, {
  capabilities: {},
  rootUri: 'file:///workspace',
  locale: 'en'
});

console.log(result.capabilities.completionProvider); // true
```

--------------------------------

### Enable Experimental Features

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/README.md

Configures experimental completion settings during service initialization.

```typescript
await service.initialize({
  vtsls: {
    experimental: {
      completion: {
        enableServerSideFuzzyMatch: true,
        entriesLimit: 500
      }
    }
  }
});
```

--------------------------------

### conn.onInitialize

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/server-entry.md

Registers a handler for the LSP initialize request, which is the first request sent by the client.

```APIDOC
## conn.onInitialize

### Description
Handles the LSP `initialize` request, which is the first request sent from the client to the server.

### Signature
`conn.onInitialize((params: InitializeParams) => { ... });`
```

--------------------------------

### createConnection

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/server-entry.md

Creates an LSP connection instance using the vscode-languageserver/node library, automatically determining transport based on CLI arguments.

```APIDOC
## createConnection

### Description
Creates an LSP connection from the `vscode-languageserver/node` library. It determines the transport mechanism based on CLI arguments, defaulting to stdio.

### Signature
`const conn = createConnection(ProposedFeatures.all);`
```

--------------------------------

### Manage TS language service lifecycle

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/errors.md

Demonstrates the correct pattern for disposing of an existing service before creating a new one to avoid initialization errors.

```typescript
// Wrong:
const service1 = createTSLanguageService(options);
const service2 = createTSLanguageService(options); // → Error

// Correct:
const service1 = createTSLanguageService(options);
// ... use service1 ...
service1.dispose();
const service2 = createTSLanguageService(options); // OK
```

--------------------------------

### workspace/executeCommand

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/endpoints.md

Executes a registered command, such as organizing imports or restarting the server.

```text
Method: POST workspace/executeCommand
Request: ExecuteCommandParams {
  command: string,
  arguments?: any[]
}
Response: any  // Varies by command

Common commands:
- typescript.organizeImports: [filePath: string] => any
- typescript.removeUnusedImports: [filePath: string] => any
- typescript.sortImports: [filePath: string] => any
- typescript.goToSourceDefinition: [DocumentUri, Position] => Location[]
- typescript.findAllFileReferences: [DocumentUri] => Location[]
- typescript.goToProjectConfig: [DocumentUri] => null
- typescript.selectTypeScriptVersion: [] => void
- typescript.reloadProjects: [] => void
- typescript.openTsServerLog: [] => void
- typescript.restartTsServer: [] => void
- typescript.tsserverRequest: [RequestType, args: any] => any
- _typescript.configurePlugin: [pluginName: string, config: any] => any
- _typescript.applyCodeActionCommand: [...] => any
- _typescript.moveToFileRefactoring: [action, uri, range, targetFile?] => void
```

--------------------------------

### inlayHint

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/language-service.md

Returns inline type hints and parameter name hints.

```APIDOC
## inlayHint(params: InlayHintParams, token: CancellationToken)

### Description
Returns inline type hints and parameter name hints.

### Parameters
- **params** (InlayHintParams) - Required - The parameters for the inlay hint request.
- **token** (CancellationToken) - Required - A token to cancel the request.
```

--------------------------------

### Define vtsls.experimental.maxInlayHintLength

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/configuration.md

Configuration key to limit the length of inlay hint labels.

```text
Key: vtsls.experimental.maxInlayHintLength
Type: number or null
Default: null
```

--------------------------------

### CLI main function

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/server-entry.md

Signature for the main entry point function.

```typescript
function main(): void
```

--------------------------------

### Configure TypeScript Version

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/README.md

Initializes the service using either the workspace version or a specific TSDK path.

```typescript
// Use workspace version
await service.initialize({
  vtsls: {
    autoUseWorkspaceTsdk: true
  }
});

// Or specify a path
await service.initialize({
  typescript: {
    tsdk: '/opt/typescript/lib'
  }
});
```

--------------------------------

### Enable Verbose Server Logging

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/errors.md

Configure logging and manual execution steps to diagnose server crashes.

```bash
# Enable logging
"typescript.tsserver.log": "verbose"

# Run server manually
vtsls --stdio

# Check tsserver logs
typescript.openTsServerLog
```

--------------------------------

### Configure Implicit Project Experimental Decorators

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/configuration.md

Enables support for experimental decorators in loose files.

```text
Key: js/ts.implicitProjectConfig.experimentalDecorators
Type: boolean
Default: false
```

--------------------------------

### Create LSP Connection

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/server-entry.md

Initializes an LSP connection using the vscode-languageserver library, automatically determining transport based on CLI arguments.

```typescript
const conn = createConnection(ProposedFeatures.all);
```

--------------------------------

### Run unit tests for vtsls

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/README.md

Commands to execute unit tests within the service package, either once or in watch mode.

```bash
cd packages/service
pnpm test          # Run once
pnpm test:watch    # Watch mode
```

--------------------------------

### Define vtsls.enableMoveToFileCodeAction

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/configuration.md

Configuration key to enable the move to file refactoring code action.

```text
Key: vtsls.enableMoveToFileCodeAction
Type: boolean
Default: false
```

--------------------------------

### Move to File Refactoring - Initial Command

Source: https://github.com/yioneko/vtsls/blob/main/README.md

Initial command arguments for the 'moveToFileRefactoring' command, used when the 'vtsls.enableMoveToFileCodeAction' setting is true. Requires client-side handling.

```typescript
[action: any, uri: DocumentUri, range: Range]
```

--------------------------------

### Enable Trace Logging Configuration

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/errors.md

Configure the tsserver log level to verbose to enable detailed trace logging.

```json
{
  "typescript": {
    "tsserver": {
      "log": "verbose"
    }
  }
}
```

--------------------------------

### callHierarchy/prepare

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/endpoints.md

Prepares a call hierarchy at a specific document position.

```text
Method: POST callHierarchy/prepare
Request: CallHierarchyPrepareParams {
  textDocument: { uri: string },
  position: Position
}
Response: CallHierarchyItem[] | null

CallHierarchyItem {
  name: string,
  kind: SymbolKind,
  tags?: SymbolTag[],
  detail?: string,
  uri: string,
  range: Range,
  selectionRange: Range,
  data?: any
}
```

--------------------------------

### CLI Interface

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/server-entry.md

Functions for printing CLI help, version information, and configuration schemas.

```APIDOC
## printHelp()

### Description
Prints usage information and available command-line options for the vtsls server.

## printVersion()

### Description
Prints the current vtsls version string to stdout.

## printConfigSchema()

### Description
Prints the configuration schema as JSON to stdout.

## main()

### Description
The primary entry point that parses CLI arguments and initializes the server. Supported arguments include `--help`, `--version`, `--print-config-schema`, `--stdio`, `--node-ipc`, and `--socket=<port>`.
```

--------------------------------

### Usage of safeRun in connection handlers

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/server-entry.md

Demonstrates applying safeRun to connection handlers with different fallback and error catching configurations.

```typescript
conn.onDefinition(safeRun(
  service.definition,
  null,  // Return null if feature not available
  false  // Don't catch ProviderNotFoundError for definition
));

conn.onPrepareCallHierarchy(safeRun(
  service.prepareCallHierarchy,
  null,
  true  // Catch ProviderNotFoundError; feature is optional in older TS
));
```

--------------------------------

### window/showMessage

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/endpoints.md

Requests the client to show a message dialog to the user.

```APIDOC
## POST window/showMessage

### Description
Shows a message dialog to the user (request with possible actions).

### Method
POST

### Endpoint
window/showMessage

### Parameters
#### Request Body
- **type** (MessageType) - Required - Message type.
- **message** (string) - Required - The message text.
- **actions** (MessageActionItem[]) - Optional - Available actions for the user.
```

--------------------------------

### Initialize TSLanguageService

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/language-service.md

Initializes the service with configuration. Must be called before any requests are processed.

```typescript
async initialize(config: TSLanguageServiceConfig): Promise<void>
```

--------------------------------

### textDocument/inlayHint

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/endpoints.md

Returns inline type hints and parameter name hints.

```APIDOC
## POST textDocument/inlayHint

### Description
Returns inline type hints and parameter name hints.

### Method
POST

### Request Body
- **textDocument** ({ uri: string }) - Required
- **range** (Range) - Required

### Response
- **InlayHint[] | null** - List of inlay hints.
```

--------------------------------

### Configure Completion Server-Side Filtering

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/errors.md

JSON configuration to enable experimental server-side fuzzy matching and limit entries to mitigate timeouts.

```json
{
  "vtsls": {
    "experimental": {
      "completion": {
        "enableServerSideFuzzyMatch": true,
        "entriesLimit": 1000
      }
    }
  }
}
```

--------------------------------

### workspace/executeCommand

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/endpoints.md

Executes a registered command.

```APIDOC
## POST workspace/executeCommand

### Description
Executes a registered command.

### Method
POST

### Endpoint
workspace/executeCommand

### Request Body
- **command** (string) - Required - The command identifier.
- **arguments** (any[]) - Optional - Arguments for the command.
```

--------------------------------

### textDocument/inlayHint

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/endpoints.md

Returns inline type hints and parameter name hints for the specified range.

```text
Method: POST textDocument/inlayHint
Request: InlayHintParams {
  textDocument: { uri: string },
  range: Range
}
Response: InlayHint[] | null

InlayHint {
  position: Position,
  label: string | InlayHintLabelPart[],
  kind?: InlayHintKind,  // 1=Type, 2=Parameter
  textEdits?: TextEdit[],
  tooltip?: string | MarkupContent,
  paddingLeft?: boolean,
  paddingRight?: boolean,
  data?: any
}

InlayHintLabelPart {
  value: string,
  tooltip?: string | MarkupContent,
  location?: Location,
  command?: Command
}
```

--------------------------------

### Handle Initialize Request

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/server-entry.md

Registers a handler for the initial LSP initialize request from the client.

```typescript
conn.onInitialize((params: InitializeParams) => {
  return onServerInitialize(conn, params);
});
```

--------------------------------

### Initialize Server Capabilities Configuration

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/endpoints.md

Defines the capabilities supported by the vtsls server, such as text document synchronization, various providers for code intelligence, and workspace file operations.

```typescript
{
  capabilities: {
    textDocumentSync: {
      openClose: true,
      change: TextDocumentSyncKind.Incremental
    },
    completionProvider: {
      triggerCharacters: [".", '"', "'", "`", "/", "@", "<", "#", " ", "*"],
      resolveProvider: true,
      completionItem: { labelDetailsSupport: true }
    },
    hoverProvider: true,
    signatureHelpProvider: {
      triggerCharacters: ["(", ",", "<"],
      retriggerCharacters: [")"]
    },
    definitionProvider: true,
    typeDefinitionProvider: true,
    implementationProvider: true,
    referencesProvider: true,
    documentHighlightProvider: true,
    documentSymbolProvider: { label: "typescript" },
    codeActionProvider: {
      codeActionKinds: ["source", "source.fixAll", "source.organizeImports", 
                        "quickfix", "refactor", "refactor.extract", "refactor.rewrite"],
      resolveProvider: true
    },
    codeLensProvider: { resolveProvider: true },
    workspaceSymbolProvider: { resolveProvider: false },
    documentFormattingProvider: true,
    documentRangeFormattingProvider: true,
    documentOnTypeFormattingProvider: {
      firstTriggerCharacter: ";",
      moreTriggerCharacter: ["}", "\n"]
    },
    renameProvider: { prepareProvider: true },
    foldingRangeProvider: true,
    selectionRangeProvider: true,
    executeCommandProvider: {
      commands: [/* all typescript/javascript commands */]
    },
    callHierarchyProvider: true,
    linkedEditingRangeProvider: true,
    semanticTokensProvider: {
      legend: { tokenTypes: [...], tokenModifiers: [...] },
      full: true,
      range: true
    },
    inlayHintProvider: true,
    workspace: {
      workspaceFolders: { supported: true, changeNotifications: true },
      fileOperations: {
        didRename: {
          filters: [
            { scheme: "file", pattern: { glob: "**/*.{ts,cts,mts,tsx,js,cjs,mjs,jsx}", matches: "file" } },
            { scheme: "file", pattern: { glob: "**/*", matches: "folder" } }
          ]
        }
      }
    }
  }
}
```

--------------------------------

### Show message dialog

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/endpoints.md

Requests the client to display a message dialog with optional actions.

```text
Method: POST window/showMessage (Request)
Params: ShowMessageRequestParams {
  type: MessageType,
  message: string,
  actions?: MessageActionItem[]
}

MessageActionItem {
  title: string
}

Response: MessageActionItem | null  // Selected action or null if cancelled
```

--------------------------------

### Configure experimental VSCode watcher

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/configuration.md

Toggles the use of the VSCode file watcher instead of the native tsserver watcher.

```text
Key: typescript.tsserver.experimental.useVsCodeWatcher
Type: boolean
Default: false
```

--------------------------------

### Initialize and Use VTSLS Language Service

Source: https://github.com/yioneko/vtsls/blob/main/packages/service/README.md

This snippet shows how to create, initialize, open a document, and request document symbols from the VTSLS language service. Ensure the service is disposed after use.

```typescript
import { createTSLanguageService } from "@vtsls/language-service";
const service = createTSLanguageService({
  clientCapabilities: {},
});

// initialize with configuration
await service.initialize({
  typescript: { tsserver: { log: "verbose" } },
});

const uri = "file:///path/to/file.ts";
// fill file content here
const fileContent = "";

// file needs to be opened before requesting features
service.openTextDocument({
  textDocument: {
    uri,
    languageId: "typescript",
    version: 0,
    text: fileContent,
  },
});

// see LSP document for the format of params and response
const response = await service.documentSymbol({ textDocument: { uri } })
console.log(response);

// close the service
service.dispose();
```

--------------------------------

### textDocument/implementation

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/endpoints.md

Returns all implementations of an interface or abstract method.

```APIDOC
## POST textDocument/implementation

### Description
Returns all implementations of an interface or abstract method.

### Method
POST

### Endpoint
textDocument/implementation

### Request Body
- **textDocument** (object) - Required - { uri: string }
- **position** (object) - Required - { line: number, character: number }

### Response
- **Success Response** - Location | Location[] | null
```

--------------------------------

### Export VTSLS Configuration Schema

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/configuration.md

Command to output the full configuration schema as JSON for client-side validation and auto-completion.

```bash
vtsls --print-config-schema
```

--------------------------------

### Initialize TSLspConverter

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/converter.md

Instantiate the converter using the client's LSP capabilities.

```typescript
const converter = new TSLspConverter(clientCapabilities);
```

--------------------------------

### Optimize Completion Performance

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/errors.md

Adjust experimental completion settings to improve performance with large candidate sets.

```json
{
  "vtsls": {
    "experimental": {
      "completion": {
        "enableServerSideFuzzyMatch": true,
        "entriesLimit": 500
      }
    }
  }
}
```

--------------------------------

### Configure import module specifier preference

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/configuration.md

Determines the format used for generated import paths.

```text
Key: typescript.preferences.importModuleSpecifierPreference
Type: string
Enum: ["shortest", "project-relative", "relative"]
Default: "shortest"
```

--------------------------------

### Define vtsls.experimental.completion.entriesLimit

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/configuration.md

Configuration key to set the maximum number of completion items returned.

```text
Key: vtsls.experimental.completion.entriesLimit
Type: number or null
Default: null
```

--------------------------------

### TSLspConverter Constructor

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/converter.md

Initializes a new instance of the TSLspConverter with the provided LSP client capabilities.

```APIDOC
## TSLspConverter(clientCapabilities: lsp.ClientCapabilities)

### Description
Creates a new converter instance. The clientCapabilities are used to determine supported features during type conversion.

### Parameters
- **clientCapabilities** (lsp.ClientCapabilities) - Required - LSP capabilities to determine supported features.
```

--------------------------------

### changeConfiguration

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/language-service.md

Updates the service configuration. If the service is uninitialized, this method initializes it.

```APIDOC
## changeConfiguration

### Description
Updates service configuration. If the service is uninitialized, this initializes it.

### Parameters
- **params.settings** (Configuration object) - Required - Configuration object (same structure as initialize)
```

--------------------------------

### Configure Implicit Project Strict Mode

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/configuration.md

Settings for enabling strict type checking, null checks, and function type checks in loose files.

```text
Key: js/ts.implicitProjectConfig.strict
Type: boolean
Default: true

Key: js/ts.implicitProjectConfig.strictNullChecks
Type: boolean
Default: true

Key: js/ts.implicitProjectConfig.strictFunctionTypes
Type: boolean
Default: true
```

--------------------------------

### Define vtsls.experimental.completion.enableServerSideFuzzyMatch

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/configuration.md

Configuration key to enable server-side fuzzy matching for completion items.

```text
Key: vtsls.experimental.completion.enableServerSideFuzzyMatch
Type: boolean
Default: false
```

--------------------------------

### Code Lens Command

Source: https://github.com/yioneko/vtsls/blob/main/README.md

The `editor.action.showReferences` command is used to display references for code lenses. It requires specific arguments to be passed from the client.

```APIDOC
## Code Lens Command

### Description
This command is executed by the client to display references for code lenses.

### Command
`editor.action.showReferences`

### Arguments
`[uri: DocumentUri, codeLensStart: Position, locations: Location[]]`
```

--------------------------------

### window/showDocument

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/endpoints.md

Requests the client to open a specific document in the editor.

```APIDOC
## POST window/showDocument

### Description
Requests to open a document in the editor.

### Method
POST

### Endpoint
window/showDocument

### Parameters
#### Request Body
- **uri** (string) - Required - The document URI.
- **external** (boolean) - Optional - Open in external app if true.
- **takeFocus** (boolean) - Optional - Whether to take focus.
```

--------------------------------

### createTSLanguageService

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/language-service.md

Creates and returns a TypeScript language service instance configured with the provided options.

```APIDOC
## createTSLanguageService

### Description
Creates and returns a TypeScript language service instance. This service manages lifecycle methods and language feature handlers.

### Signature
`function createTSLanguageService(initOptions: TSLanguageServiceOptions): TSLanguageService`

### Parameters
- **initOptions** (TSLanguageServiceOptions) - Required - Configuration for the language service
- **initOptions.locale** (string) - Optional - Language locale for error messages
- **initOptions.workspaceFolders** (WorkspaceFolder[]) - Optional - Initial workspace folders to analyze
- **initOptions.clientCapabilities** (ClientCapabilities) - Required - LSP client capabilities to determine supported features
- **initOptions.hostInfo** (string) - Optional - Information about the host environment
- **initOptions.tsExtLogPath** (string) - Optional - Path to log TypeScript extension debug information

### Return Type
Returns a `TSLanguageService` object.

### Throws
- **Error** if a service instance already exists and has not been disposed
```

--------------------------------

### executeCommand

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/language-service.md

Executes a registered command within the language service.

```APIDOC
## executeCommand

### Description
Executes a registered command (e.g., typescript.organizeImports, typescript.goToSourceDefinition).

### Parameters
- **params.command** (string) - Required - Command name
- **params.arguments** (any[]) - Optional - Command-specific arguments

### Return Type
Promise<any>
```

--------------------------------

### convertSignatureInfoToLsp

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/converter.md

Converts VSCode signature information to LSP format.

```APIDOC
## convertSignatureInfoToLsp

### Description
Converts VSCode signature information to LSP format.

### Signature
`convertSignatureInfoToLsp(sig: vscode.SignatureInformation): lsp.SignatureInformation`

### Parameters
- **sig** (vscode.SignatureInformation) - Required - The VSCode signature information to convert.
```

--------------------------------

### convertHover

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/converter.md

Converts VSCode hover information into the LSP format, including content and optional range data.

```APIDOC
## convertHover

### Description
Converts VSCode hover information to LSP format.

### Signature
`convertHover(hover: vscode.Hover): lsp.Hover`

### Parameters
- **hover.contents** (string | MarkupContent | MarkedString[]) - Hover content.
- **hover.range** (Range) - Optional range being hovered.

### Example
```typescript
const vscHover = {
  contents: new types.MarkdownString('**Type**: `number`\n\nA counter value')
};

const lspHover = converter.convertHover(vscHover);
```
```

--------------------------------

### convertDefinition

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/converter.md

Converts single or multiple VSCode definitions into the LSP definition format.

```APIDOC
## convertDefinition(definition: vscode.Definition)

### Description
Converts single or multiple definitions to LSP format.

### Parameters
- **definition** (vscode.Definition) - Required - The VSCode definition or array of definitions to convert.

### Returns
- **lsp.Definition** - The converted LSP definition(s).
```

--------------------------------

### Retrieve inlay hints

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/language-service.md

Returns inline type hints and parameter name hints.

```typescript
inlayHint(
  params: InlayHintParams,
  token: CancellationToken
): Promise<InlayHint[] | null>
```

```typescript
{
  position: Position,
  label: string | InlayHintLabelPart[],
  kind?: InlayHintKind,  // "type" | "parameter"
  textEdits?: TextEdit[],
  tooltip?: string | MarkupContent,
  paddingLeft?: boolean,
  paddingRight?: boolean,
  data?: any
}[]
```

--------------------------------

### Configure typescript.tsdk

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/configuration.md

Override the bundled TypeScript version by specifying a path to a directory containing lib*.d.ts files and the tsserver executable.

```json
{
  "typescript": {
    "tsdk": "./node_modules/typescript/lib"
  }
}
```

--------------------------------

### Configure Implicit Project Module System

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/configuration.md

Defines the module system used for files outside of defined projects.

```text
Key: js/ts.implicitProjectConfig.module
Type: string
Enum: ["CommonJS", "AMD", "System", "UMD", "ES6", "ES2015", "ES2020", "ES2022", "ESNext", "Node12", "NodeNext", "None"]
Default: "ESNext"
```

--------------------------------

### workspace/didChangeConfiguration

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/endpoints.md

Notifies the server that configuration has changed.

```APIDOC
## POST workspace/didChangeConfiguration

### Description
Tells the server that configuration has changed. If sent before initialization, initializes the service.

### Request Body
- **settings** (TSLanguageServiceConfig) - Required - Hierarchical configuration object.
```

--------------------------------

### Configure tsserver watch options

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/configuration.md

Defines file monitoring configuration for the tsserver process.

```text
Key: typescript.tsserver.watchOptions
Type: object
Default: {}
```

--------------------------------

### conn.onInitialized

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/server-entry.md

Registers a handler for the LSP initialized notification, triggered after the client processes server capabilities.

```APIDOC
## conn.onInitialized

### Description
Handles the LSP `initialized` notification, sent after the client processes capabilities. At this point, all handlers are registered.

### Signature
`conn.onInitialized(() => { ... });`
```

--------------------------------

### getTsLspDefaultCapabilities

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/server-entry.md

Retrieves the default LSP capabilities supported by the vtsls language service.

```APIDOC
## getTsLspDefaultCapabilities

### Description
Returns the full server capabilities including all supported LSP features.

### Signature
`getTsLspDefaultCapabilities(): ServerCapabilities`

### Example
```typescript
const capabilities = getTsLspDefaultCapabilities();
```
```

--------------------------------

### Create TSLanguageService Instance

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/language-service.md

Defines the signature for initializing a new TypeScript language service instance.

```typescript
function createTSLanguageService(
  initOptions: TSLanguageServiceOptions
): TSLanguageService
```

--------------------------------

### textDocument/formatting

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/endpoints.md

Formats the entire document.

```APIDOC
## POST textDocument/formatting

### Description
Formats the entire document.

### Method
POST

### Endpoint
textDocument/formatting

### Request Body
- **textDocument** (object) - Required - { uri: string }
- **options** (FormattingOptions) - Required - Formatting options including tabSize and insertSpaces.
```

--------------------------------

### Move to File Refactoring - Client-Side Command Execution

Source: https://github.com/yioneko/vtsls/blob/main/README.md

Modified command arguments for 'moveToFileRefactoring' after the client prompts the user for a target file. The client sends this to the server.

```typescript
[action: any, uri: DocumentUri, range: Range, targetFile: string]
```

--------------------------------

### workspace/applyEdit

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/endpoints.md

Requests the client to apply a workspace edit.

```APIDOC
## POST workspace/applyEdit

### Description
Requests to apply a workspace edit.

### Method
POST

### Endpoint
workspace/applyEdit

### Parameters
#### Request Body
- **label** (string) - Optional - Edit label.
- **edit** (WorkspaceEdit) - Required - The workspace edit to apply.
```

--------------------------------

### convertSignatureInfoFromLsp

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/converter.md

Converts LSP signature information back to VSCode format.

```APIDOC
## convertSignatureInfoFromLsp

### Description
Converts LSP signature information back to VSCode format (for context passing).

### Signature
`convertSignatureInfoFromLsp(sig: lsp.SignatureInformation): vscode.SignatureInformation`

### Parameters
- **sig** (lsp.SignatureInformation) - Required - The LSP signature information to convert.
```

--------------------------------

### CLI printHelp function

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/server-entry.md

Signature for the printHelp function.

```typescript
function printHelp(): void
```

--------------------------------

### Register Global TypeScript Plugins

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/README.md

Define global plugins by specifying their name and file system location.

```json
{
  "vtsls": {
    "tsserver": {
      "globalPlugins": [
        {
          "name": "@styled/typescript-styled-plugin",
          "location": "/path/to/plugin"
        }
      ]
    }
  }
}
```

--------------------------------

### TypeScript Commands

Source: https://github.com/yioneko/vtsls/blob/main/README.md

A collection of commands for interacting with the TypeScript language server, including logging, restarting, and project reloads.

```APIDOC
## TypeScript Commands

### Description
Provides various commands for managing and interacting with the TypeScript language server.

### Commands
- `typescript.openTsServerLog`
- `typescript.restartTsServer`
- `typescript.reloadProjects`
- `javascript.reloadProjects`
- `typescript.selectTypeScriptVersion`
- `typescript.goToSourceDefinition`: `[DocumentUri, Position] => Location[]`
- `typescript.findAllFileReferences`: `[DocumentUri] => Location[]`
- `typescript.goToProjectConfig`: `[DocumentUri] => null`
- `javascript.goToProjectConfig`: `[DocumentUri] => null`
- `_typescript.configurePlugin`: `[pluginName: string, config: any] => any`
- `typescript.tsserverRequest`: `[RequestType, args: any, config: any] => any`
- `typescript.organizeImports`: `[filePath: string] => any`
- `typescript.sortImports`: `[filePath: string] => any`
- `javascript.sortImports`: `[filePath: string] => any`
- `typescript.removeUnusedImports`: `[filePath: string] => any`
- `javascript.removeUnusedImports`: `[filePath: string] => any`
```

--------------------------------

### Convert Request Context

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/converter.md

Maps LSP completion context properties to the corresponding VSCode provider structure.

```typescript
const lspContext = params.context;
const vscContext = {
  triggerCharacter: lspContext.triggerCharacter || '',
  triggerKind: lspContext.triggerKind
};
```

--------------------------------

### textDocument/codeLens

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/endpoints.md

Returns code lens items for displaying clickable inline information.

```text
Method: POST textDocument/codeLens
Request: CodeLensParams {
  textDocument: { uri: string }
}
Response: CodeLens[] | null

CodeLens {
  range: Range,
  command?: Command,
  data?: any
}
```

--------------------------------

### workspace/symbol

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/endpoints.md

Searches for symbols by name across all files in the workspace.

```text
Method: POST workspace/symbol
Request: WorkspaceSymbolParams {
  query: string
}
Response: SymbolInformation[] | null

SymbolInformation {
  name: string,
  kind: SymbolKind,
  deprecated?: boolean,
  location: Location,
  containerName?: string
}
```

--------------------------------

### codeLens

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/language-service.md

Returns code lens items (clickable inline information).

```APIDOC
## codeLens(params: CodeLensParams, token: CancellationToken)

### Description
Returns code lens items (clickable inline information like "5 references").

### Parameters
- **params** (CodeLensParams) - Required - The parameters for the code lens request.
- **token** (CancellationToken) - Required - A token to cancel the request.
```

--------------------------------

### Manage workspace folders

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/language-service.md

Adds or removes workspace folders at runtime.

```typescript
changeWorkspaceFolders(params: DidChangeWorkspaceFoldersParams): void
```

--------------------------------

### convertTypeDefinition and convertImplementation

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/api-reference/converter.md

Converts VSCode definitions into LSP format specifically for type definitions and implementations.

```APIDOC
## convertTypeDefinition(definition: vscode.Definition)
## convertImplementation(implementation: vscode.Definition)

### Description
Similar to convertDefinition but for type definitions and implementations.

### Parameters
- **definition/implementation** (vscode.Definition) - Required - The VSCode definition object to convert.

### Returns
- **lsp.Definition** - The converted LSP definition.
```

--------------------------------

### Handle Request Handler Exceptions

Source: https://github.com/yioneko/vtsls/blob/main/_autodocs/errors.md

Demonstrates the pattern for catching specific provider and document errors within request handlers.

```typescript
try {
  const refs = await service.references({...}); // May throw
} catch (e) {
  if (e instanceof ProviderNotFoundError) {
    // Feature not available
  } else if (e instanceof DocumentNotOpenedError) {
    // Document not open
  } else {
    // Unexpected error - server will close connection
    throw e;
  }
}
```
Tokens:
Raw