@singapore-editor/lsp-plugin 0.1.1

package/dist/completion.d.ts

@@ -0,0 +1,124 @@
+import type { SelectionAffinity, TextEdit } from '@singapore-editor/core/document';
+import type { EditorContributionChange, EditorEditContributionContext, EditorSelectionRange } from '@singapore-editor/core/extensions';
+import { type LspTextDocumentSnapshot } from '@singapore-editor/lsp';
+import type * as lsp from 'vscode-languageserver-protocol';
+export declare const LANGUAGE_SERVER_COMPLETION_EDIT_FEATURE_ID = "editor.lsp-plugin.completion-edit";
+export declare const COMPLETION_REQUEST_DEBOUNCE_MS = 80;
+export type LanguageServerCompletionEditFeature = {
+    applyCompletion(application: LanguageServerCompletionApplication): boolean;
+};
+export declare const LANGUAGE_SERVER_COMPLETION_EDIT_FEATURE: import("@singapore-editor/core").EditorCapabilityToken<LanguageServerCompletionEditFeature>;
+export type LanguageServerSnippetMirror = {
+    readonly start: number;
+    readonly end: number;
+    /** Renders this copy from the stop's text; without one the copy holds that text verbatim. */
+    readonly transform?: (value: string) => string;
+};
+export type LanguageServerSnippetStop = {
+    readonly start: number;
+    readonly end: number;
+    readonly mirrors?: readonly LanguageServerSnippetMirror[];
+};
+export type LanguageServerCompletionApplication = {
+    readonly edits: readonly TextEdit[];
+    readonly selection: EditorSelectionRange;
+    /**
+     * Tab stops to cycle with Tab, each with the copies of it the snippet writes elsewhere, when the
+     * accepted item was a snippet the host has something to track.
+     */
+    readonly snippetStops?: readonly LanguageServerSnippetStop[];
+};
+/** `3` is the kind reserved for asking a server again about a list it marked incomplete. */
+export type LanguageServerCompletionTrigger = {
+    readonly triggerKind: 1 | 2 | 3;
+    readonly triggerCharacter?: string;
+};
+export type CompletionWidgetShowOptions = {
+    readonly anchor: DOMRect;
+    readonly items: readonly lsp.CompletionItem[];
+    readonly selectedIndex?: number;
+};
+export type CompletionWidgetController = {
+    show(options: CompletionWidgetShowOptions): void;
+    /** Moves a list already on screen to a new anchor, without rebuilding its rows. */
+    reanchor(anchor: DOMRect): void;
+    hide(): void;
+    isVisible(): boolean;
+    containsTarget(target: EventTarget | null): boolean;
+    moveSelection(delta: number): void;
+    selectedItem(): lsp.CompletionItem | null;
+    dispose(): void;
+};
+export type CompletionWidgetOptions = {
+    readonly document: Document;
+    readonly themeSource: HTMLElement;
+    readonly classNamespace?: string;
+    onSelect(index: number): void;
+};
+export declare function createCompletionWidgetController(options: CompletionWidgetOptions): CompletionWidgetController;
+/**
+ * A server's answer, with the one flag on it that outlives the request.
+ *
+ * `isIncomplete` is the server saying it truncated its answer for the word it was asked about — the
+ * large member sets and auto-import lists are always sent this way — so a list that stays on screen
+ * while the user keeps typing has to be asked again rather than narrowed.
+ */
+export type CompletionListResult = {
+    readonly items: readonly lsp.CompletionItem[];
+    readonly isIncomplete: boolean;
+};
+export declare function completionListResult(result: lsp.CompletionList | readonly lsp.CompletionItem[] | null): CompletionListResult;
+export declare function completionTriggerFromChange(change: EditorContributionChange | null): LanguageServerCompletionTrigger | null;
+/** The text a request went out with, which is the frame every range on an item is read in. */
+export type CompletionApplicationDocument = {
+    readonly document: LspTextDocumentSnapshot;
+    readonly offset: number;
+};
+/**
+ * The document an accepted item is applied against.
+ *
+ * `document` and `offset` are what the request went out with, and the item's ranges are positions
+ * in that text. `caretOffset` and `caretAffinity` are where the caret has reached since — rarely the
+ * same position, because the widget stays up while the user keeps typing.
+ */
+export type CompletionApplicationRequest = CompletionApplicationDocument & {
+    readonly caretOffset: number;
+    readonly caretAffinity: SelectionAffinity;
+};
+export declare function completionApplication(request: CompletionApplicationRequest, item: lsp.CompletionItem): LanguageServerCompletionApplication | null;
+/**
+ * Whether an item could be applied at all against the text it was answered for.
+ *
+ * The ranges an item carries are positions in that text, and one that spans lines or that the caret
+ * was never inside describes a document this client did not ask about. Nothing downstream can rescue
+ * such an item, so a row for it would be one the reader can press Enter on and get nothing for.
+ */
+export declare function completionItemApplies(request: CompletionApplicationDocument, item: lsp.CompletionItem): boolean;
+export declare function completionAnchorRange(length: number, offset: number): {
+    readonly start: number;
+    readonly end: number;
+};
+export declare function createCompletionEditFeature(context: EditorEditContributionContext, timingName: string): LanguageServerCompletionEditFeature;
+/**
+ * Whether an accepted item still needs a `completionItem/resolve` round-trip.
+ *
+ * Servers routinely send a list whose items carry only a label, deferring documentation and — the
+ * one that matters — the import edit until resolve. Applying such an item directly is what silently
+ * drops auto-imports.
+ */
+export declare function completionNeedsResolve(item: lsp.CompletionItem, serverCapabilities: lsp.ServerCapabilities | null | undefined): boolean;
+/**
+ * Word being typed at `offset`, which is what the list should be filtered against. The server's
+ * answer is for the moment the request was sent; the user has usually typed more since.
+ */
+export declare function completionPrefix(text: string, offset: number): string;
+/**
+ * Filters and orders a completion list against what has been typed.
+ *
+ * An item earns its place by where the typed characters landed in it, so a word start, a camel-case
+ * hump and the far side of a separator all outrank the same letters found in the middle of a word.
+ * Ties fall back to the server's own `sortText`, which is how a server expresses relevance it knows
+ * and the client does not.
+ */
+export declare function rankCompletionItems(items: readonly lsp.CompletionItem[], prefix: string): readonly lsp.CompletionItem[];
+//# sourceMappingURL=completion.d.ts.map

package/dist/completion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"completion.d.ts","sourceRoot":"","sources":["../src/completion.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAA;AAClF,OAAO,KAAK,EACV,wBAAwB,EACxB,6BAA6B,EAC7B,oBAAoB,EACrB,MAAM,mCAAmC,CAAA;AAE1C,OAAO,EAAiC,KAAK,uBAAuB,EAAE,MAAM,uBAAuB,CAAA;AACnG,OAAO,KAAK,KAAK,GAAG,MAAM,gCAAgC,CAAA;AAY1D,eAAO,MAAM,0CAA0C,sCAAsC,CAAA;AAE7F,eAAO,MAAM,8BAA8B,KAAK,CAAA;AAEhD,MAAM,MAAM,mCAAmC,GAAG;IAChD,eAAe,CAAC,WAAW,EAAE,mCAAmC,GAAG,OAAO,CAAA;CAC3E,CAAA;AAED,eAAO,MAAM,uCAAuC,6FAGjD,CAAA;AAEH,MAAM,MAAM,2BAA2B,GAAG;IACxC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,6FAA6F;IAC7F,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAA;CAC/C,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,2BAA2B,EAAE,CAAA;CAC1D,CAAA;AAED,MAAM,MAAM,mCAAmC,GAAG;IAChD,QAAQ,CAAC,KAAK,EAAE,SAAS,QAAQ,EAAE,CAAA;IACnC,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAA;IACxC;;;OAGG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,SAAS,yBAAyB,EAAE,CAAA;CAC7D,CAAA;AAED,4FAA4F;AAC5F,MAAM,MAAM,+BAA+B,GAAG;IAC5C,QAAQ,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IAC/B,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;CACnC,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG;IACxC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;IACxB,QAAQ,CAAC,KAAK,EAAE,SAAS,GAAG,CAAC,cAAc,EAAE,CAAA;IAC7C,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;CAChC,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,CAAC,OAAO,EAAE,2BAA2B,GAAG,IAAI,CAAA;IAChD,mFAAmF;IACnF,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAAA;IAC/B,IAAI,IAAI,IAAI,CAAA;IACZ,SAAS,IAAI,OAAO,CAAA;IACpB,cAAc,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,GAAG,OAAO,CAAA;IACnD,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,YAAY,IAAI,GAAG,CAAC,cAAc,GAAG,IAAI,CAAA;IACzC,OAAO,IAAI,IAAI,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAC3B,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAA;IACjC,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAA;IAChC,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;CAC9B,CAAA;AAqBD,wBAAgB,gCAAgC,CAC9C,OAAO,EAAE,uBAAuB,GAC/B,0BAA0B,CA8F5B;AAED;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,CAAC,KAAK,EAAE,SAAS,GAAG,CAAC,cAAc,EAAE,CAAA;IAC7C,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAA;CAC/B,CAAA;AAED,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,GAAG,CAAC,cAAc,GAAG,SAAS,GAAG,CAAC,cAAc,EAAE,GAAG,IAAI,GAChE,oBAAoB,CAKtB;AAED,wBAAgB,2BAA2B,CACzC,MAAM,EAAE,wBAAwB,GAAG,IAAI,GACtC,+BAA+B,GAAG,IAAI,CAcxC;AAqBD,8FAA8F;AAC9F,MAAM,MAAM,6BAA6B,GAAG;IAC1C,QAAQ,CAAC,QAAQ,EAAE,uBAAuB,CAAA;IAC1C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CACxB,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,4BAA4B,GAAG,6BAA6B,GAAG;IACzE,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,aAAa,EAAE,iBAAiB,CAAA;CAC1C,CAAA;AAED,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,4BAA4B,EACrC,IAAI,EAAE,GAAG,CAAC,cAAc,GACvB,mCAAmC,GAAG,IAAI,CAqB5C;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,6BAA6B,EACtC,IAAI,EAAE,GAAG,CAAC,cAAc,GACvB,OAAO,CAKT;AAED,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,GACb;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAKlD;AAED,wBAAgB,2BAA2B,CACzC,OAAO,EAAE,6BAA6B,EACtC,UAAU,EAAE,MAAM,GACjB,mCAAmC,CAarC;AAoZD;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,GAAG,CAAC,cAAc,EACxB,kBAAkB,EAAE,GAAG,CAAC,kBAAkB,GAAG,IAAI,GAAG,SAAS,GAC5D,OAAO,CAIT;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAKrE;AA2BD;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,SAAS,GAAG,CAAC,cAAc,EAAE,EACpC,MAAM,EAAE,MAAM,GACb,SAAS,GAAG,CAAC,cAAc,EAAE,CAyB/B"}