@singapore-editor/find 0.1.1

package/README.md

@@ -0,0 +1,28 @@
+# @singapore-editor/find
+
+Find and replace plugin for `@singapore-editor/core`.
+
+## Install
+
+```sh
+npm install @singapore-editor/core @singapore-editor/find
+```
+
+## Usage
+
+```ts
+import { Editor } from '@singapore-editor/core/editor'
+import { createEditorFindPlugin } from '@singapore-editor/find'
+import '@singapore-editor/core/style.css'
+import '@singapore-editor/find/style.css'
+
+const editor = new Editor(document.querySelector('#editor')!, {
+  plugins: [createEditorFindPlugin()],
+})
+```
+
+## Exports
+
+- `createEditorFindPlugin` registers find, replace, and match-selection commands.
+- `createEditorFindContributionProviders` exposes the find widget and capability providers.
+- `EDITOR_FIND_FEATURE` and `EDITOR_FIND_FEATURE_ID` expose the find feature capability token.

package/dist/findController.d.ts

@@ -0,0 +1,175 @@
+import { type TextEdit, type TextReadSnapshot } from '@singapore-editor/core/document';
+import type { EditorSetSelectionOptions } from '@singapore-editor/core/editor';
+import type { EditorContributionChange, EditorDisposable, EditorResolvedSelection, EditorSelectionRange, EditorViewContributionUpdateKind } from '@singapore-editor/core/extensions';
+import type { VirtualizedTextHighlightStyle } from '@singapore-editor/core/rendering';
+import { type FindQuery, type FindRange, type FindTextSource } from './search';
+import type { EditorFindOptions } from './types';
+export declare const FIND_HIGHLIGHT_Z_INDEX: {
+    readonly scope: 4;
+    readonly match: 5;
+    readonly current: 6;
+};
+type EditorFindSelectionRange = EditorSelectionRange;
+export type EditorFindResolvedSelection = EditorResolvedSelection & {
+    readonly collapsed: boolean;
+};
+/**
+ * Ranges the host follows through edits on find's behalf.
+ *
+ * A scope outlives the selection it was taken from: the first replace inside it moves the caret off
+ * that selection, so a scope re-derived from what is selected now would be re-derived from
+ * something else — or from nothing, and a scope of nothing is indistinguishable from no scope at
+ * all. Handed over once, it answers from wherever its text went, however many edits later.
+ */
+export type FindTrackedRanges = {
+    resolve(): readonly FindRange[];
+};
+export type EditorFindHost = {
+    hasDocument(): boolean;
+    textSource(): FindTextSource;
+    hasTextSnapshot(snapshot: TextReadSnapshot): boolean;
+    trackRanges(ranges: readonly FindRange[]): FindTrackedRanges;
+    trackPaintedRanges(ranges: readonly FindRange[]): FindTrackedRanges;
+    getSelections(): readonly EditorFindResolvedSelection[];
+    focusEditor(): void;
+    announce(message: string): void;
+    setSelection(anchor: number, head: number, timingName: string, options?: EditorSetSelectionOptions): void;
+    setSelections(selections: readonly EditorFindSelectionRange[], timingName: string, revealOffset?: number): void;
+    setRangeHighlight(name: string, ranges: readonly FindRange[], style: VirtualizedTextHighlightStyle): void;
+    clearRangeHighlight(name: string): void;
+};
+export type EditorFindEditHost = {
+    textSnapshot(): TextReadSnapshot | null;
+    getSelections(): readonly EditorFindResolvedSelection[];
+    applyEdits(edits: readonly TextEdit[], timingName: string, selection?: EditorFindSelectionRange): void;
+};
+export type EditorFindStartOptions = {
+    readonly replace: boolean;
+    readonly focus: 'find' | 'replace' | 'none';
+};
+export type EditorFindState = FindQuery & {
+    readonly replaceString: string;
+    readonly preserveCase: boolean;
+    readonly revealed: boolean;
+    readonly replaceRevealed: boolean;
+    readonly inSelection: boolean;
+};
+export type EditorFindWidgetState = EditorFindState & {
+    readonly matchesCount: number;
+    readonly matchesPosition: number;
+    readonly highlightsTruncated: boolean;
+};
+export type EditorFindUiEvent = {
+    readonly type: 'show';
+    readonly replaceVisible: boolean;
+} | {
+    readonly type: 'hide';
+} | {
+    readonly type: 'focus';
+    readonly target: 'find' | 'replace';
+} | {
+    readonly type: 'update';
+    readonly state: EditorFindWidgetState;
+};
+type EditorFindUiListener = (event: EditorFindUiEvent) => void;
+export declare class EditorFindController {
+    private readonly options;
+    private readonly listeners;
+    private host;
+    private editHost;
+    private matchHighlightName;
+    private currentHighlightName;
+    private scopeHighlightName;
+    private state;
+    private readonly scheduler;
+    private matches;
+    private highlightsTruncated;
+    private totalMatches;
+    private scope;
+    private trackedMatches;
+    private currentMatch;
+    private replacing;
+    private pendingResearch;
+    constructor(options?: EditorFindOptions);
+    attachHost(host: EditorFindHost, highlightPrefix: string): EditorDisposable;
+    attachEditHost(host: EditorFindEditHost): EditorDisposable;
+    subscribe(listener: EditorFindUiListener): EditorDisposable;
+    dispose(): void;
+    isVisible(): boolean;
+    openFind(): boolean;
+    toggleFind(): boolean;
+    openFindReplace(): boolean;
+    close(): boolean;
+    findNext(): boolean;
+    findPrevious(): boolean;
+    replaceOne(): boolean;
+    replaceAll(): boolean;
+    selectAllMatches(): boolean;
+    toggleMatchCase(): boolean;
+    toggleWholeWord(): boolean;
+    toggleRegex(): boolean;
+    togglePreserveCase(): boolean;
+    toggleReplace(): boolean;
+    toggleFindInSelection(): boolean;
+    setSearchString(value: string): void;
+    setReplaceString(value: string): void;
+    handleViewUpdate(kind: EditorViewContributionUpdateKind, change: EditorContributionChange | null): void;
+    private detachHost;
+    private detachEditHost;
+    private open;
+    private ensureFindReady;
+    private research;
+    private scheduleResearch;
+    /**
+     * Adopts a match set and hands it to the host to follow as far as it is painted.
+     *
+     * Handed over now rather than when an edit arrives: find is told about an edit
+     * once the text has already moved, and a range recorded against the document
+     * as it is by then is a range that will never shift.
+     *
+     * What the reader can see is the bound. A set stopping at the paint cap holds
+     * twenty thousand matches, and asking the host to carry all of them costs more
+     * per keystroke than the search this deferral exists to keep off it.
+     */
+    private adoptMatches;
+    /**
+     * Carries the painted matches through the edit that deferred their re-search.
+     *
+     * Until it lands they are what the reader sees, and the offsets they were found
+     * at address text that has since moved — so they are read back from where that
+     * text went. A match whose text is gone resolves to nothing and stops being
+     * painted.
+     */
+    /** Takes the offsets again from what the host is following, after the line it follows to moved. */
+    refreshTrackedMatches(): void;
+    private followPendingMatches;
+    private applyReplacement;
+    private selectNextReplacementMatch;
+    private canPaintCurrentDocument;
+    private commandTextSource;
+    private commandSelections;
+    private commandSearchTarget;
+    private findAll;
+    private countAll;
+    private searchFrom;
+    private searchTarget;
+    private scopeRanges;
+    private selectFirstMatchFromSelection;
+    private nextMatchAt;
+    private selectMatch;
+    private updateHighlights;
+    private currentMatchRanges;
+    private clearHighlights;
+    private updateWidget;
+    private widgetState;
+    private currentMatchPosition;
+    private focusWidget;
+    private seedSearchString;
+    private seedFromLiteralText;
+    private applyAutoFindInSelection;
+    private replacePattern;
+    private primarySelection;
+    private emit;
+}
+export {};
+//# sourceMappingURL=findController.d.ts.map

package/dist/findController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"findController.d.ts","sourceRoot":"","sources":["../src/findController.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,QAAQ,EACb,KAAK,gBAAgB,EACtB,MAAM,iCAAiC,CAAA;AACxC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAA;AAC9E,OAAO,KAAK,EACV,wBAAwB,EACxB,gBAAgB,EAChB,uBAAuB,EACvB,oBAAoB,EACpB,gCAAgC,EACjC,MAAM,mCAAmC,CAAA;AAC1C,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,kCAAkC,CAAA;AAErF,OAAO,EAcL,KAAK,SAAS,EACd,KAAK,SAAS,EACd,KAAK,cAAc,EACpB,MAAM,UAAU,CAAA;AAEjB,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAgBhD,eAAO,MAAM,sBAAsB;;;;CAIzB,CAAA;AAyCV,KAAK,wBAAwB,GAAG,oBAAoB,CAAA;AAEpD,MAAM,MAAM,2BAA2B,GAAG,uBAAuB,GAAG;IAClE,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAA;CAC5B,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,IAAI,SAAS,SAAS,EAAE,CAAA;CAChC,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,WAAW,IAAI,OAAO,CAAA;IAGtB,UAAU,IAAI,cAAc,CAAA;IAC5B,eAAe,CAAC,QAAQ,EAAE,gBAAgB,GAAG,OAAO,CAAA;IAIpD,WAAW,CAAC,MAAM,EAAE,SAAS,SAAS,EAAE,GAAG,iBAAiB,CAAA;IAG5D,kBAAkB,CAAC,MAAM,EAAE,SAAS,SAAS,EAAE,GAAG,iBAAiB,CAAA;IACnE,aAAa,IAAI,SAAS,2BAA2B,EAAE,CAAA;IACvD,WAAW,IAAI,IAAI,CAAA;IACnB,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IAC/B,YAAY,CACV,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,yBAAyB,GAClC,IAAI,CAAA;IACP,aAAa,CACX,UAAU,EAAE,SAAS,wBAAwB,EAAE,EAC/C,UAAU,EAAE,MAAM,EAClB,YAAY,CAAC,EAAE,MAAM,GACpB,IAAI,CAAA;IACP,iBAAiB,CACf,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,SAAS,SAAS,EAAE,EAC5B,KAAK,EAAE,6BAA6B,GACnC,IAAI,CAAA;IACP,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;CACxC,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,YAAY,IAAI,gBAAgB,GAAG,IAAI,CAAA;IACvC,aAAa,IAAI,SAAS,2BAA2B,EAAE,CAAA;IACvD,UAAU,CACR,KAAK,EAAE,SAAS,QAAQ,EAAE,EAC1B,UAAU,EAAE,MAAM,EAClB,SAAS,CAAC,EAAE,wBAAwB,GACnC,IAAI,CAAA;CACR,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAAA;CAC5C,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG;IACxC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAC9B,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAA;IAC9B,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAA;IAC1B,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAA;IACjC,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG,eAAe,GAAG;IAEpD,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;IAEhC,QAAQ,CAAC,mBAAmB,EAAE,OAAO,CAAA;CACtC,CAAA;AAED,MAAM,MAAM,iBAAiB,GACzB;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAA;CAAE,GAC3D;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GACzB;IAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAC/D;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,qBAAqB,CAAA;CAAE,CAAA;AAGtE,KAAK,oBAAoB,GAAG,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAA;AAU9D,qBAAa,oBAAoB;IAC/B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAqB;IAC7C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAkC;IAC5D,OAAO,CAAC,IAAI,CAA8B;IAC1C,OAAO,CAAC,QAAQ,CAAkC;IAClD,OAAO,CAAC,kBAAkB,CAAK;IAC/B,OAAO,CAAC,oBAAoB,CAAK;IACjC,OAAO,CAAC,kBAAkB,CAAK;IAC/B,OAAO,CAAC,KAAK,CAUZ;IACD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAqC;IAC/D,OAAO,CAAC,OAAO,CAA2B;IAC1C,OAAO,CAAC,mBAAmB,CAAQ;IAEnC,OAAO,CAAC,YAAY,CAAI;IACxB,OAAO,CAAC,KAAK,CAAiC;IAG9C,OAAO,CAAC,cAAc,CAAiC;IACvD,OAAO,CAAC,YAAY,CAAyB;IAC7C,OAAO,CAAC,SAAS,CAAQ;IACzB,OAAO,CAAC,eAAe,CAAQ;gBAEZ,OAAO,GAAE,iBAAsB;IAI3C,UAAU,CAAC,IAAI,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,GAAG,gBAAgB;IAU3E,cAAc,CAAC,IAAI,EAAE,kBAAkB,GAAG,gBAAgB;IAK1D,SAAS,CAAC,QAAQ,EAAE,oBAAoB,GAAG,gBAAgB;IAK3D,OAAO,IAAI,IAAI;IASf,SAAS,IAAI,OAAO;IAIpB,QAAQ,IAAI,OAAO;IAInB,UAAU,IAAI,OAAO;IAKrB,eAAe,IAAI,OAAO;IAI1B,KAAK,IAAI,OAAO;IAgBhB,QAAQ,IAAI,OAAO;IAYnB,YAAY,IAAI,OAAO;IAYvB,UAAU,IAAI,OAAO;IAwCrB,UAAU,IAAI,OAAO;IAgCrB,gBAAgB,IAAI,OAAO;IAwB3B,eAAe,IAAI,OAAO;IAM1B,eAAe,IAAI,OAAO;IAM1B,WAAW,IAAI,OAAO;IAMtB,kBAAkB,IAAI,OAAO;IAM7B,aAAa,IAAI,OAAO;IAMxB,qBAAqB,IAAI,OAAO;IAoBhC,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKpC,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKrC,gBAAgB,CACrB,IAAI,EAAE,gCAAgC,EACtC,MAAM,EAAE,wBAAwB,GAAG,IAAI,GACtC,IAAI;IAkCP,OAAO,CAAC,UAAU;IAmBlB,OAAO,CAAC,cAAc;IAOtB,OAAO,CAAC,IAAI;IAkBZ,OAAO,CAAC,eAAe;IAMvB,OAAO,CAAC,QAAQ;IAyBhB,OAAO,CAAC,gBAAgB;IAWxB;;;;;;;;;;OAUG;IACH,OAAO,CAAC,YAAY;IAKpB;;;;;;;OAOG;IACH,mGAAmG;IAC5F,qBAAqB,IAAI,IAAI;IAIpC,OAAO,CAAC,oBAAoB;IAa5B,OAAO,CAAC,gBAAgB;IAgBxB,OAAO,CAAC,0BAA0B;IAOlC,OAAO,CAAC,uBAAuB;IAM/B,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,mBAAmB;IAK3B,OAAO,CAAC,OAAO;IAOf,OAAO,CAAC,QAAQ;IAKhB,OAAO,CAAC,UAAU;IAclB,OAAO,CAAC,YAAY;IAYpB,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,6BAA6B;IAQrC,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,WAAW;IAYnB,OAAO,CAAC,gBAAgB;IAgBxB,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,eAAe;IASvB,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,WAAW;IAYnB,OAAO,CAAC,oBAAoB;IAQ5B,OAAO,CAAC,WAAW;IAKnB,OAAO,CAAC,gBAAgB;IAkBxB,OAAO,CAAC,mBAAmB;IAI3B,OAAO,CAAC,wBAAwB;IAiBhC,OAAO,CAAC,cAAc;IAKtB,OAAO,CAAC,gBAAgB;IAIxB,OAAO,CAAC,IAAI;CAGb"}