@zzzen/pyright-internal 1.1.254

package/dist/languageServerBase.d.ts

@@ -0,0 +1,211 @@
+import './common/extensions';
+import { CallHierarchyIncomingCallsParams, CallHierarchyItem, CallHierarchyOutgoingCall, CallHierarchyOutgoingCallsParams, CallHierarchyPrepareParams, CancellationToken, CodeAction, CodeActionParams, Command, CompletionItem, CompletionList, CompletionParams, Connection, Declaration, DeclarationLink, Definition, DefinitionLink, DidChangeConfigurationParams, DidChangeTextDocumentParams, DidChangeWatchedFilesParams, DidCloseTextDocumentParams, DidOpenTextDocumentParams, DocumentHighlight, DocumentHighlightParams, DocumentSymbol, DocumentSymbolParams, ExecuteCommandParams, HoverParams, InitializeParams, InitializeResult, Location, MarkupKind, PrepareRenameParams, PublishDiagnosticsParams, ReferenceParams, RemoteWindow, RenameParams, SignatureHelp, SignatureHelpParams, SymbolInformation, TextDocumentPositionParams, WorkDoneProgressReporter, WorkspaceEdit, WorkspaceFolder, WorkspaceSymbol, WorkspaceSymbolParams } from 'vscode-languageserver';
+import { ResultProgressReporter } from 'vscode-languageserver/lib/common/progress';
+import { AnalysisResults } from './analyzer/analysis';
+import { BackgroundAnalysisProgram } from './analyzer/backgroundAnalysisProgram';
+import { ImportResolver } from './analyzer/importResolver';
+import { MaxAnalysisTime } from './analyzer/program';
+import { AnalyzerService } from './analyzer/service';
+import type { BackgroundAnalysisBase } from './backgroundAnalysisBase';
+import { CancellationProvider } from './common/cancellationUtils';
+import { DiagnosticSeverityOverrides, DiagnosticSeverityOverridesMap } from './common/commandLineOptions';
+import { ConfigOptions } from './common/configOptions';
+import { ConsoleInterface, LogLevel } from './common/console';
+import { Deferred } from './common/deferred';
+import { DiagnosticRule } from './common/diagnosticRules';
+import { FileDiagnostics } from './common/diagnosticSink';
+import { LanguageServiceExtension } from './common/extensibility';
+import { FileSystem, FileWatcherProvider } from './common/fileSystem';
+import { Host } from './common/host';
+import { ProgressReporter } from './common/progressReporter';
+import { DocumentRange, Position, Range } from './common/textRange';
+import { UriParser } from './common/uriParser';
+import { CompletionOptions, CompletionResultsList } from './languageService/completionProvider';
+import { DefinitionFilter } from './languageService/definitionProvider';
+import { WorkspaceMap } from './workspaceMap';
+export interface ServerSettings {
+    venvPath?: string | undefined;
+    pythonPath?: string | undefined;
+    typeshedPath?: string | undefined;
+    stubPath?: string | undefined;
+    openFilesOnly?: boolean | undefined;
+    typeCheckingMode?: string | undefined;
+    useLibraryCodeForTypes?: boolean | undefined;
+    disableLanguageServices?: boolean | undefined;
+    disableOrganizeImports?: boolean | undefined;
+    autoSearchPaths?: boolean | undefined;
+    extraPaths?: string[] | undefined;
+    watchForSourceChanges?: boolean | undefined;
+    watchForLibraryChanges?: boolean | undefined;
+    watchForConfigChanges?: boolean | undefined;
+    diagnosticSeverityOverrides?: DiagnosticSeverityOverridesMap | undefined;
+    logLevel?: LogLevel | undefined;
+    autoImportCompletions?: boolean | undefined;
+    indexing?: boolean | undefined;
+    logTypeEvaluationTime?: boolean | undefined;
+    typeEvaluationTimeThreshold?: number | undefined;
+}
+export interface WorkspaceServiceInstance {
+    workspaceName: string;
+    rootPath: string;
+    rootUri: string;
+    serviceInstance: AnalyzerService;
+    disableLanguageServices: boolean;
+    disableOrganizeImports: boolean;
+    disableWorkspaceSymbol?: boolean;
+    isInitialized: Deferred<boolean>;
+    searchPathsToWatch: string[];
+}
+export interface MessageAction {
+    title: string;
+    id: string;
+}
+export interface WindowInterface {
+    showErrorMessage(message: string): void;
+    showErrorMessage(message: string, ...actions: MessageAction[]): Promise<MessageAction | undefined>;
+    showWarningMessage(message: string): void;
+    showWarningMessage(message: string, ...actions: MessageAction[]): Promise<MessageAction | undefined>;
+    showInformationMessage(message: string): void;
+    showInformationMessage(message: string, ...actions: MessageAction[]): Promise<MessageAction | undefined>;
+}
+export interface LanguageServerInterface {
+    getWorkspaceForFile(filePath: string): Promise<WorkspaceServiceInstance>;
+    getSettings(workspace: WorkspaceServiceInstance): Promise<ServerSettings>;
+    createBackgroundAnalysis(): BackgroundAnalysisBase | undefined;
+    reanalyze(): void;
+    restart(): void;
+    decodeTextDocumentUri(uriString: string): string;
+    readonly rootPath: string;
+    readonly console: ConsoleInterface;
+    readonly window: WindowInterface;
+    readonly fs: FileSystem;
+    readonly supportAdvancedEdits: boolean;
+}
+export interface ServerOptions {
+    productName: string;
+    rootDirectory: string;
+    version: string;
+    workspaceMap: WorkspaceMap;
+    fileSystem: FileSystem;
+    fileWatcherProvider: FileWatcherProvider;
+    cancellationProvider: CancellationProvider;
+    extension?: LanguageServiceExtension;
+    maxAnalysisTimeInForeground?: MaxAnalysisTime;
+    disableChecker?: boolean;
+    supportedCommands?: string[];
+    supportedCodeActions?: string[];
+}
+interface ClientCapabilities {
+    hasConfigurationCapability: boolean;
+    hasVisualStudioExtensionsCapability: boolean;
+    hasWorkspaceFoldersCapability: boolean;
+    hasWatchFileCapability: boolean;
+    hasWatchFileRelativePathCapability: boolean;
+    hasActiveParameterCapability: boolean;
+    hasSignatureLabelOffsetCapability: boolean;
+    hasHierarchicalDocumentSymbolCapability: boolean;
+    hasWindowProgressCapability: boolean;
+    hasGoToDeclarationCapability: boolean;
+    hasDocumentChangeCapability: boolean;
+    hasDocumentAnnotationCapability: boolean;
+    hoverContentFormat: MarkupKind;
+    completionDocFormat: MarkupKind;
+    completionSupportsSnippet: boolean;
+    signatureDocFormat: MarkupKind;
+    supportsDeprecatedDiagnosticTag: boolean;
+    supportsUnnecessaryDiagnosticTag: boolean;
+    completionItemResolveSupportsAdditionalTextEdits: boolean;
+}
+export declare abstract class LanguageServerBase implements LanguageServerInterface {
+    protected _serverOptions: ServerOptions;
+    protected _connection: Connection;
+    readonly console: ConsoleInterface;
+    protected _defaultClientConfig: any;
+    protected _workspaceMap: WorkspaceMap;
+    protected _fileWatcherProvider: FileWatcherProvider;
+    private _pendingFindAllRefsCancellationSource;
+    private _pendingCommandCancellationSource;
+    private _progressReporter;
+    private _lastTriggerKind;
+    private _lastFileWatcherRegistration;
+    rootPath: string;
+    protected client: ClientCapabilities;
+    fs: FileSystem;
+    protected _uriParser: UriParser;
+    constructor(_serverOptions: ServerOptions, _connection: Connection, console: ConsoleInterface, uriParserFactory?: (fs: FileSystem) => UriParser);
+    decodeTextDocumentUri(uriString: string): string;
+    abstract createBackgroundAnalysis(): BackgroundAnalysisBase | undefined;
+    protected abstract executeCommand(params: ExecuteCommandParams, token: CancellationToken): Promise<any>;
+    protected abstract isLongRunningCommand(command: string): boolean;
+    protected abstract executeCodeAction(params: CodeActionParams, token: CancellationToken): Promise<(Command | CodeAction)[] | undefined | null>;
+    abstract getSettings(workspace: WorkspaceServiceInstance): Promise<ServerSettings>;
+    protected getConfiguration(scopeUri: string | undefined, section: string): Promise<any>;
+    protected isOpenFilesOnly(diagnosticMode: string): boolean;
+    protected get allowModuleRename(): boolean;
+    protected getSeverityOverrides(value: string): DiagnosticSeverityOverrides | undefined;
+    protected getDiagnosticRuleName(value: string): DiagnosticRule | undefined;
+    protected abstract createHost(): Host;
+    protected abstract createImportResolver(fs: FileSystem, options: ConfigOptions, host: Host): ImportResolver;
+    protected createBackgroundAnalysisProgram(console: ConsoleInterface, configOptions: ConfigOptions, importResolver: ImportResolver, extension?: LanguageServiceExtension, backgroundAnalysis?: BackgroundAnalysisBase, maxAnalysisTime?: MaxAnalysisTime): BackgroundAnalysisProgram;
+    protected setExtension(extension: any): void;
+    get window(): RemoteWindow;
+    get supportAdvancedEdits(): boolean;
+    createAnalyzerService(name: string): AnalyzerService;
+    getWorkspaceForFile(filePath: string): Promise<WorkspaceServiceInstance>;
+    reanalyze(): void;
+    restart(): void;
+    protected setupConnection(supportedCommands: string[], supportedCodeActions: string[]): void;
+    protected initialize(params: InitializeParams, supportedCommands: string[], supportedCodeActions: string[]): InitializeResult;
+    protected onInitialized(): void;
+    private _setupFileWatcher;
+    protected onDidChangeConfiguration(params: DidChangeConfigurationParams): void;
+    protected onDefinition(params: TextDocumentPositionParams, token: CancellationToken): Promise<Definition | DefinitionLink[] | undefined | null>;
+    protected onDeclaration(params: TextDocumentPositionParams, token: CancellationToken): Promise<Declaration | DeclarationLink[] | undefined | null>;
+    protected onTypeDefinition(params: TextDocumentPositionParams, token: CancellationToken): Promise<Definition | DefinitionLink[] | undefined | null>;
+    protected getDefinitions(params: TextDocumentPositionParams, token: CancellationToken, filter: DefinitionFilter, getDefinitionsFunc: (workspace: WorkspaceServiceInstance, filePath: string, position: Position, filter: DefinitionFilter, token: CancellationToken) => DocumentRange[] | undefined): Promise<Location[] | undefined>;
+    protected onReferences(params: ReferenceParams, token: CancellationToken, workDoneReporter: WorkDoneProgressReporter, resultReporter: ResultProgressReporter<Location[]> | undefined): Promise<Location[] | null | undefined>;
+    protected onDocumentSymbol(params: DocumentSymbolParams, token: CancellationToken): Promise<DocumentSymbol[] | SymbolInformation[] | null | undefined>;
+    protected onWorkspaceSymbol(params: WorkspaceSymbolParams, token: CancellationToken, resultReporter: ResultProgressReporter<SymbolInformation[]> | undefined): Promise<SymbolInformation[] | WorkspaceSymbol[] | null | undefined>;
+    protected onHover(params: HoverParams, token: CancellationToken): Promise<import("vscode-languageserver-types").Hover | undefined>;
+    protected onDocumentHighlight(params: DocumentHighlightParams, token: CancellationToken): Promise<DocumentHighlight[] | null | undefined>;
+    protected onSignatureHelp(params: SignatureHelpParams, token: CancellationToken): Promise<SignatureHelp | undefined | null>;
+    protected onCompletion(params: CompletionParams, token: CancellationToken): Promise<CompletionList | undefined>;
+    protected onCompletionResolve(params: CompletionItem, token: CancellationToken): Promise<CompletionItem>;
+    protected onPrepareRenameRequest(params: PrepareRenameParams, token: CancellationToken): Promise<Range | {
+        range: Range;
+        placeholder: string;
+    } | null>;
+    protected onRenameRequest(params: RenameParams, token: CancellationToken): Promise<WorkspaceEdit | null | undefined>;
+    protected onPrepare(params: CallHierarchyPrepareParams, token: CancellationToken): Promise<CallHierarchyItem[] | null>;
+    protected onIncomingCalls(params: CallHierarchyIncomingCallsParams, token: CancellationToken): Promise<import("vscode-languageserver-types").CallHierarchyIncomingCall[] | null>;
+    protected onOutgoingCalls(params: CallHierarchyOutgoingCallsParams, token: CancellationToken): Promise<CallHierarchyOutgoingCall[] | null>;
+    protected onDidOpenTextDocument(params: DidOpenTextDocumentParams, ipythonMode?: boolean): Promise<void>;
+    protected onDidChangeTextDocument(params: DidChangeTextDocumentParams, ipythonMode?: boolean): Promise<void>;
+    protected onDidCloseTextDocument(params: DidCloseTextDocumentParams): Promise<void>;
+    protected onDidChangeWatchedFiles(params: DidChangeWatchedFilesParams): void;
+    protected onExecuteCommand(params: ExecuteCommandParams, token: CancellationToken, reporter: WorkDoneProgressReporter): Promise<any>;
+    protected resolveWorkspaceCompletionItem(workspace: WorkspaceServiceInstance, filePath: string, item: CompletionItem, token: CancellationToken): void;
+    protected getWorkspaceCompletionsForPosition(workspace: WorkspaceServiceInstance, filePath: string, position: Position, workspacePath: string, options: CompletionOptions, token: CancellationToken): Promise<CompletionResultsList | undefined>;
+    updateSettingsForAllWorkspaces(): void;
+    protected getCompletionOptions(params?: CompletionParams): {
+        format: MarkupKind;
+        snippet: boolean;
+        lazyEdit: boolean;
+        autoImport: boolean;
+    };
+    protected createWorkspaceServiceInstance(workspace: WorkspaceFolder | undefined, rootPath: string): WorkspaceServiceInstance;
+    protected convertDiagnostics(fileDiagnostics: FileDiagnostics): PublishDiagnosticsParams[];
+    protected onAnalysisCompletedHandler(results: AnalysisResults): void;
+    updateSettingsForWorkspace(workspace: WorkspaceServiceInstance, serverSettings?: ServerSettings): Promise<void>;
+    updateOptionsAndRestartService(workspace: WorkspaceServiceInstance, serverSettings: ServerSettings, typeStubTargetImportName?: string): void;
+    protected convertLogLevel(logLevelValue?: string): LogLevel;
+    private _sendDiagnostics;
+    private _getCompatibleMarkupKind;
+    private _getProgressReporter;
+    private _convertDiagnostics;
+    protected recordUserInteractionTime(): void;
+    protected getDocumentationUrlForDiagnosticRule(rule: string): string | undefined;
+    protected abstract createProgressReporter(): ProgressReporter;
+    protected expandPathVariables(rootPath: string, value: string): string;
+}
+export {};