script_globals library

Script Globals for VS Code Scripting API

This file provides global variable declarations for scripts. Import this file to get convenient access to VS Code API globals.

Usage

import 'package:tom_vscode_scripting_api/script_globals.dart';

void main() {
  // Now vscode, window, etc. are available
  vscode.window.showInformationMessage('Hello!');
}

Available Globals

Note

These globals require VSCode.initialize() to be called first.

Classes

ChatContext
Context for a chat request including conversation history
ChatErrorDetails
Error details for a failed chat request
ChatParticipant
A chat participant
ChatPromptReference
A reference in a chat prompt
ChatRequest
A chat request from the user
ChatResponseStream
A stream for sending responses back to the chat
ChatResult
Result of handling a chat request
Extension
Represents a VS Code extension
FileBatch
File batch processor
FileSystemWatcherOptions
File system watcher options
HelperLogging
Logging control for VsCodeHelper
InputBoxOptions
Input box options
LanguageModelChat
Represents a language model for chat requests
LanguageModelChatMessage
A message in a chat conversation
LanguageModelChatResponse
Response from a language model chat request
LanguageModelToolInformation
Information about a registered tool
LanguageModelToolResult
Tool result from language model
LazyVSCodeBridgeAdapter
A lazy-connecting adapter that auto-connects on first use.
MessageOptions
Message options
Position
Position in a text document
QuickPickItem
Quick pick item
Range
Range in a text document
Selection
Selection in a text editor
TerminalOptions
Terminal options
TextDocument
Text document representation
TextEditor
Text editor representation
VSCode
Main VS Code API wrapper class Provides unified access to all VS Code APIs through Dart
VSCodeAdapter
Abstract interface for sending requests to VS Code
VSCodeBridgeAdapter
Implementation of VSCodeAdapter using VSCodeBridgeClient.
VSCodeBridgeClient
Client for communicating with VS Code VS Code Bridge.
VSCodeBridgeResult
Result of a VS Code bridge command execution.
VSCodeChat
Chat API - Create and manage chat participants
VSCodeCommands
Wrapper for vscode.commands API Provides access to VS Code command system
VSCodeCommonCommands
Common VS Code commands
VSCodeExtensions
Wrapper for vscode.extensions API Provides access to VS Code extensions management
VsCodeHelper
Helper class for VS Code API operations in scripts
VSCodeLanguageModel
Language Model API - Access to GitHub Copilot and other language models
VSCodeUri
Represents a URI in VS Code
VSCodeWindow
Wrapper for vscode.window API Provides access to window-related functionality (UI, messages, editors, etc.)
VSCodeWorkspace
Wrapper for vscode.workspace API Provides access to workspace-related functionality
VsProgress
Progress indicator helper
WorkspaceFolder
Represents a workspace folder

Enums

DiagnosticSeverity
Diagnostic severity

Constants

defaultVSCodeBridgePort → const int
Default port for VS Code VS Code Bridge

Properties

chat → VSCodeChat
VS Code chat API.
no setter
commands → VSCodeCommands
VS Code commands API.
no setter
extensions → VSCodeExtensions
VS Code extensions API.
no setter
lm → VSCodeLanguageModel
VS Code language model API.
no setter
vscode → VSCode
Main VS Code API entry point.
no setter
window → VSCodeWindow
VS Code window API.
no setter
workspace → VSCodeWorkspace
VS Code workspace API.
no setter

Typedefs

ChatRequestHandler = Future<ChatResult?> Function(ChatRequest request, ChatContext context, ChatResponseStream stream)
Chat request handler callback