@singapore-editor/lsp-plugin 0.1.1

package/dist/plugin.d.ts

@@ -0,0 +1,100 @@
+import type { LanguageServerDocumentPluginOptions } from './types';
+import type { EditorCommandId } from '@singapore-editor/core/editor';
+import type { EditorCapabilityToken, EditorDisposable } from '@singapore-editor/core/extensions';
+import type { LspClient, LspNotificationHandler, LspServerRequestHandler } from '@singapore-editor/lsp';
+import type * as lsp from 'vscode-languageserver-protocol';
+import { type LanguageServerCompletionEditFeature } from './completion';
+import { type CompletionKeyCommand, type SignatureHelpKeyCommand } from './keyCommands';
+import { type LanguageServerSemanticTokensOptions } from './semanticTokens';
+import type { LspConnectionProvider, LspConnectionTransportFactory } from './lspConnection';
+import type { DiagnosticMarkerDirection, LanguageServerNavigationCommand } from './pluginTypes';
+import type { LanguageServerConnectionContext, LanguageServerDefinitionTarget, LanguageServerDiagnosticActions, LanguageServerDiagnosticMarkerClaim, LanguageServerDiagnosticMarkerEvent, LanguageServerDiagnosticSummary, LanguageServerDocumentSyncOptions, LanguageServerNavigationOptions, LanguageServerPlugin, LanguageServerLaneHostOptions, LanguageServerPluginOptions, LanguageServerRenamePrompt, LanguageServerSetPluginOptions, LanguageServerReferencesResult, LanguageServerStatus } from './types';
+export type { LanguageServerConnectionContext } from './types';
+export type { LanguageServerResolvedOptions } from './pluginTypes';
+export type LanguageServerCommandTarget = {
+    goToDefinitionFromSelection(): boolean;
+    runNavigationCommand(command: LanguageServerNavigationCommand): boolean;
+    moveDiagnosticMarker(direction: DiagnosticMarkerDirection): boolean;
+    formatDocument(): boolean;
+    renameSymbol(): boolean;
+    applyAutoFix(): boolean;
+    completionCommand(command: CompletionKeyCommand): boolean;
+    signatureHelpCommand(command: SignatureHelpKeyCommand): boolean;
+};
+export type LanguageServerCommandSpec = {
+    readonly id: EditorCommandId;
+    run(target: LanguageServerCommandTarget): boolean;
+};
+export type LanguageServerAdapterPluginOptions = LanguageServerLaneHostOptions & {
+    readonly name: string;
+    /**
+     * Asks the host for a new symbol name. Supply this to use the application's own dialog; without
+     * it the editor shows its own small input at the symbol.
+     */
+    readonly onRequestRenameName?: (prompt: LanguageServerRenamePrompt) => Promise<string | null>;
+    readonly rootUri?: lsp.DocumentUri | null;
+    readonly initializationOptions?: unknown;
+    readonly timeoutMs?: number;
+    /** See LanguageServerPluginOptions.capabilities. */
+    readonly capabilities?: lsp.ClientCapabilities;
+    /** See LanguageServerPluginOptions.clientInfo. */
+    readonly clientInfo?: lsp.InitializeParams['clientInfo'];
+    /** See LanguageServerPluginOptions.notificationHandlers. Merged, never replacing. */
+    readonly notificationHandlers?: Readonly<Record<string, LspNotificationHandler<LspClient>>>;
+    /** See LanguageServerPluginOptions.serverRequestHandlers. */
+    readonly serverRequestHandlers?: Readonly<Record<string, LspServerRequestHandler<LspClient>>>;
+    createTransport(): ReturnType<LspConnectionTransportFactory>;
+    /** Borrows the connection instead of constructing one per view. See LspConnectionProvider. */
+    readonly connectionProvider?: LspConnectionProvider;
+    readonly documentSync?: LanguageServerDocumentSyncOptions;
+    readonly diagnostics?: {
+        readonly minimapSourceId?: string;
+        readonly highlightNameNamespace?: string;
+        readonly markerTimingNamePrefix?: string;
+    };
+    readonly completion?: {
+        readonly editFeature?: EditorCapabilityToken<LanguageServerCompletionEditFeature>;
+        readonly acceptTimingName?: string;
+        readonly widgetClassNamespace?: string;
+        /**
+         * Accepts the focused suggestion when one of the characters the item declares as committing it is
+         * typed, inserting that character too. Off by default: a server whose sets are wrong turns
+         * ordinary typing into unwanted completions, which is worse than no shortcut at all.
+         */
+        readonly acceptOnCommitCharacter?: boolean;
+    };
+    /**
+     * Corrects the caret's row as a block-closing delimiter is typed. On by default: without it every
+     * closed block is left a level too deep, and the correction is the language's own indentation
+     * rules applied to one row, not a formatter deciding how the file should look.
+     */
+    readonly formatOnType?: boolean;
+    readonly hoverDefinition?: {
+        readonly linkHighlightNameNamespace?: string;
+        readonly tooltipClassNamespace?: string;
+        readonly navigationTimingNamePrefix?: string;
+    };
+    readonly commands?: readonly LanguageServerCommandSpec[];
+    /**
+     * Turns on the semantic token layer. Supplying nothing here creates no layer and fires no demand
+     * signal, so a host that paints no semantic colour pays nothing for the feature existing.
+     */
+    readonly semanticTokens?: LanguageServerSemanticTokensOptions;
+    onConnectionCreated?(context: LanguageServerConnectionContext): EditorDisposable | void;
+    onConnected?(context: LanguageServerConnectionContext): void;
+    readonly onStatusChange?: (status: LanguageServerStatus) => void;
+    readonly onDiagnostics?: (summary: LanguageServerDiagnosticSummary) => void;
+    readonly getDiagnosticActions?: LanguageServerDiagnosticActions;
+    readonly onDidNavigateDiagnostic?: (event: LanguageServerDiagnosticMarkerEvent) => LanguageServerDiagnosticMarkerClaim;
+    readonly onInteractiveReady?: () => void;
+    readonly onRequestError?: (serverId: string, method: string, error: unknown) => void;
+    readonly onDefinitionLinkHover?: (target: LanguageServerDefinitionTarget) => void;
+    readonly onOpenDefinition?: (target: LanguageServerDefinitionTarget, options?: LanguageServerNavigationOptions) => void | boolean;
+    readonly onOpenReferences?: (result: LanguageServerReferencesResult) => void | boolean;
+    readonly onError?: (error: unknown) => void;
+};
+export declare function createLanguageServerPlugin(options: LanguageServerPluginOptions): LanguageServerPlugin;
+export declare function createLanguageServerPlugin(options: LanguageServerDocumentPluginOptions): LanguageServerPlugin;
+export declare function createLanguageServerSetPlugin(options: LanguageServerSetPluginOptions): LanguageServerPlugin;
+export declare function createLanguageServerAdapterPlugin(options: LanguageServerAdapterPluginOptions): LanguageServerPlugin;
+//# sourceMappingURL=plugin.d.ts.map

package/dist/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mCAAmC,EAAE,MAAM,SAAS,CAAA;AAClE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AACpE,OAAO,KAAK,EAEV,qBAAqB,EAErB,gBAAgB,EAOjB,MAAM,mCAAmC,CAAA;AAC1C,OAAO,KAAK,EACV,SAAS,EACT,sBAAsB,EACtB,uBAAuB,EACxB,MAAM,uBAAuB,CAAA;AAC9B,OAAO,KAAK,KAAK,GAAG,MAAM,gCAAgC,CAAA;AAE1D,OAAO,EAGL,KAAK,mCAAmC,EACzC,MAAM,cAAc,CAAA;AAUrB,OAAO,EAGL,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC7B,MAAM,eAAe,CAAA;AAgBtB,OAAO,EAGL,KAAK,mCAAmC,EAEzC,MAAM,kBAAkB,CAAA;AAWzB,OAAO,KAAK,EAAE,qBAAqB,EAAE,6BAA6B,EAAE,MAAM,iBAAiB,CAAA;AAS3F,OAAO,KAAK,EAEV,yBAAyB,EACzB,+BAA+B,EAChC,MAAM,eAAe,CAAA;AAGtB,OAAO,KAAK,EACV,+BAA+B,EAC/B,8BAA8B,EAC9B,+BAA+B,EAC/B,mCAAmC,EACnC,mCAAmC,EACnC,+BAA+B,EAC/B,iCAAiC,EACjC,+BAA+B,EAC/B,oBAAoB,EAEpB,6BAA6B,EAC7B,2BAA2B,EAC3B,0BAA0B,EAC1B,8BAA8B,EAC9B,8BAA8B,EAC9B,oBAAoB,EAErB,MAAM,SAAS,CAAA;AAIhB,YAAY,EAAE,+BAA+B,EAAE,MAAM,SAAS,CAAA;AAE9D,YAAY,EAAE,6BAA6B,EAAE,MAAM,eAAe,CAAA;AAQlE,MAAM,MAAM,2BAA2B,GAAG;IACxC,2BAA2B,IAAI,OAAO,CAAA;IACtC,oBAAoB,CAAC,OAAO,EAAE,+BAA+B,GAAG,OAAO,CAAA;IACvE,oBAAoB,CAAC,SAAS,EAAE,yBAAyB,GAAG,OAAO,CAAA;IACnE,cAAc,IAAI,OAAO,CAAA;IACzB,YAAY,IAAI,OAAO,CAAA;IACvB,YAAY,IAAI,OAAO,CAAA;IACvB,iBAAiB,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAA;IACzD,oBAAoB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAA;CAChE,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,QAAQ,CAAC,EAAE,EAAE,eAAe,CAAA;IAC5B,GAAG,CAAC,MAAM,EAAE,2BAA2B,GAAG,OAAO,CAAA;CAClD,CAAA;AAED,MAAM,MAAM,kCAAkC,GAAG,6BAA6B,GAAG;IAC/E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAAC,MAAM,EAAE,0BAA0B,KAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA;IAC7F,QAAQ,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,WAAW,GAAG,IAAI,CAAA;IACzC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAA;IACxC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;IAC3B,oDAAoD;IACpD,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,kBAAkB,CAAA;IAC9C,kDAAkD;IAClD,QAAQ,CAAC,UAAU,CAAC,EAAE,GAAG,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAA;IACxD,qFAAqF;IACrF,QAAQ,CAAC,oBAAoB,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;IAC3F,6DAA6D;IAC7D,QAAQ,CAAC,qBAAqB,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;IAC7F,eAAe,IAAI,UAAU,CAAC,6BAA6B,CAAC,CAAA;IAC5D,8FAA8F;IAC9F,QAAQ,CAAC,kBAAkB,CAAC,EAAE,qBAAqB,CAAA;IACnD,QAAQ,CAAC,YAAY,CAAC,EAAE,iCAAiC,CAAA;IACzD,QAAQ,CAAC,WAAW,CAAC,EAAE;QACrB,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAA;QACjC,QAAQ,CAAC,sBAAsB,CAAC,EAAE,MAAM,CAAA;QACxC,QAAQ,CAAC,sBAAsB,CAAC,EAAE,MAAM,CAAA;KACzC,CAAA;IACD,QAAQ,CAAC,UAAU,CAAC,EAAE;QACpB,QAAQ,CAAC,WAAW,CAAC,EAAE,qBAAqB,CAAC,mCAAmC,CAAC,CAAA;QACjF,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;QAClC,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAA;QACtC;;;;WAIG;QACH,QAAQ,CAAC,uBAAuB,CAAC,EAAE,OAAO,CAAA;KAC3C,CAAA;IACD;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAA;IAC/B,QAAQ,CAAC,eAAe,CAAC,EAAE;QACzB,QAAQ,CAAC,0BAA0B,CAAC,EAAE,MAAM,CAAA;QAC5C,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,CAAA;QACvC,QAAQ,CAAC,0BAA0B,CAAC,EAAE,MAAM,CAAA;KAC7C,CAAA;IACD,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,yBAAyB,EAAE,CAAA;IACxD;;;OAGG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,mCAAmC,CAAA;IAC7D,mBAAmB,CAAC,CAAC,OAAO,EAAE,+BAA+B,GAAG,gBAAgB,GAAG,IAAI,CAAA;IACvF,WAAW,CAAC,CAAC,OAAO,EAAE,+BAA+B,GAAG,IAAI,CAAA;IAC5D,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,IAAI,CAAA;IAChE,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC,OAAO,EAAE,+BAA+B,KAAK,IAAI,CAAA;IAC3E,QAAQ,CAAC,oBAAoB,CAAC,EAAE,+BAA+B,CAAA;IAC/D,QAAQ,CAAC,uBAAuB,CAAC,EAAE,CACjC,KAAK,EAAE,mCAAmC,KACvC,mCAAmC,CAAA;IACxC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,IAAI,CAAA;IACxC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,CAAA;IACpF,QAAQ,CAAC,qBAAqB,CAAC,EAAE,CAAC,MAAM,EAAE,8BAA8B,KAAK,IAAI,CAAA;IACjF,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAC1B,MAAM,EAAE,8BAA8B,EACtC,OAAO,CAAC,EAAE,+BAA+B,KACtC,IAAI,GAAG,OAAO,CAAA;IACnB,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC,MAAM,EAAE,8BAA8B,KAAK,IAAI,GAAG,OAAO,CAAA;IACtF,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAA;CAC5C,CAAA;AA4CD,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,2BAA2B,GACnC,oBAAoB,CAAA;AACvB,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,mCAAmC,GAC3C,oBAAoB,CAAA;AAqBvB,wBAAgB,6BAA6B,CAC3C,OAAO,EAAE,8BAA8B,GACtC,oBAAoB,CAEtB;AAED,wBAAgB,iCAAiC,CAC/C,OAAO,EAAE,kCAAkC,GAC1C,oBAAoB,CAEtB"}