@adecore/editor-core 0.54.4 → 0.54.6

package/dist/document.d.ts

@@ -20,6 +20,7 @@ export interface DocumentEditOptions extends EditOptions {
         readonly head: Position;
     }[];
     expectedRevision?: number;
+    clearHistory?: boolean;
 }
 export interface TypeTextOptions extends CommandOptions {
     historyGroup?: string;
@@ -77,7 +78,7 @@ export declare class DocumentModel {
     setSelections(selections: readonly Selection[]): void;
     subscribe(listener: (snapshot: EditorSnapshot) => void): Disposable;
     applyEdits(edits: readonly TextEdit[], options?: DocumentEditOptions): boolean;
-    setText(text: string): void;
+    setText(text: string, options?: Pick<DocumentEditOptions, 'clearHistory'>): void;
     undo(): boolean;
     redo(): boolean;
     positionAt(offset: number): Position;
@@ -188,6 +189,7 @@ export declare class DocumentModel {
     private addCaretPerSelectedLine;
     private changeSelections;
     private structure;
+    private clearHistory;
     private state;
     private invalidate;
     private restore;

package/dist/document.js

@@ -411,6 +411,9 @@ export class DocumentModel {
         // Several edits can cancel each other out, like moving a character and moving it back.
         const unchanged = next === this.rope || (changed.length > 1 && next.length === this.rope.length && next.equalsRange(this.rope, changed[0].from, changed.at(-1).to));
         if (unchanged) {
+            if (options.clearHistory) {
+                this.clearHistory();
+            }
             if (options.selections) {
                 this.setSelections(options.selections);
             }
@@ -439,7 +442,10 @@ export class DocumentModel {
             last.after.rope === before.rope &&
             sameSelections(last.after.selections, before.selections);
         const joinsPrevious = options.joinPrevious === true && last !== undefined && last.after.rope === before.rope;
-        if (last !== undefined && (joinsGroup || joinsPrevious)) {
+        if (options.clearHistory) {
+            this.undoStack = [];
+        }
+        else if (last !== undefined && (joinsGroup || joinsPrevious)) {
             last.after = after;
             last.changes.push(changes);
         }
@@ -449,14 +455,14 @@ export class DocumentModel {
         if (this.undoStack.length > historyLimit) {
             this.undoStack.shift();
         }
-        this.groupOpen = Boolean(options.historyGroup) && !joinsPrevious;
+        this.groupOpen = Boolean(options.historyGroup) && !joinsPrevious && !options.clearHistory;
         this.redoStack = [];
         this.emit([changes], options.source ?? 'external', () => (rebuild ? stretchEdits(previous, next, [changes]) : editsOf(previous, changed)), options.typed);
         return true;
     }
-    /* Replaces everything as one undoable external edit. */
-    setText(text) {
-        this.applyEdits([{ from: 0, to: this.rope.length, text }], { source: 'external' });
+    /* Replaces everything as one undoable external edit, or with `clearHistory` as a text with no history before it, such as a reload from disk. */
+    setText(text, options = {}) {
+        this.applyEdits([{ from: 0, to: this.rope.length, text }], { source: 'external', clearHistory: options.clearHistory });
     }
     undo() {
         const entry = this.undoStack.pop();
@@ -2108,6 +2114,15 @@ export class DocumentModel {
     structure() {
         return (this.structureCache ??= scanStructure(this.getText()));
     }
+    clearHistory() {
+        if (this.undoStack.length === 0 && this.redoStack.length === 0) {
+            return;
+        }
+        this.undoStack = [];
+        this.redoStack = [];
+        this.groupOpen = false;
+        this.emit();
+    }
     state() {
         return { rope: this.rope, selections: this.selections.map((selection) => ({ ...selection })) };
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adecore/editor-core",
-  "version": "0.54.4",
+  "version": "0.54.6",
   "type": "module",
   "exports": {
     ".": {
@@ -16,7 +16,7 @@
     "test": "bun test --conditions=source"
   },
   "dependencies": {
-    "@adecore/utils": "0.54.4"
+    "@adecore/utils": "0.54.6"
   },
   "devDependencies": {
     "@types/bun": "^1.4.4",

package/src/document.ts

@@ -66,6 +66,8 @@ export interface DocumentEditOptions extends EditOptions {
     selectionPositions?: readonly { readonly anchor: Position; readonly head: Position }[];
     /* The edit is refused, with nothing changed, unless the document is still at this revision. */
     expectedRevision?: number;
+    /* Takes no undo step and drops the history, even when the text stays the same, so undo never goes back past this text. */
+    clearHistory?: boolean;
 }
 
 export interface TypeTextOptions extends CommandOptions {
@@ -636,6 +638,10 @@ export class DocumentModel {
             next === this.rope || (changed.length > 1 && next.length === this.rope.length && next.equalsRange(this.rope, changed[0]!.from, changed.at(-1)!.to));
 
         if (unchanged) {
+            if (options.clearHistory) {
+                this.clearHistory();
+            }
+
             if (options.selections) {
                 this.setSelections(options.selections);
             }
@@ -672,7 +678,9 @@ export class DocumentModel {
 
         const joinsPrevious = options.joinPrevious === true && last !== undefined && last.after.rope === before.rope;
 
-        if (last !== undefined && (joinsGroup || joinsPrevious)) {
+        if (options.clearHistory) {
+            this.undoStack = [];
+        } else if (last !== undefined && (joinsGroup || joinsPrevious)) {
             last.after = after;
             last.changes.push(changes);
         } else {
@@ -683,7 +691,7 @@ export class DocumentModel {
             this.undoStack.shift();
         }
 
-        this.groupOpen = Boolean(options.historyGroup) && !joinsPrevious;
+        this.groupOpen = Boolean(options.historyGroup) && !joinsPrevious && !options.clearHistory;
         this.redoStack = [];
 
         this.emit(
@@ -696,9 +704,9 @@ export class DocumentModel {
         return true;
     }
 
-    /* Replaces everything as one undoable external edit. */
-    setText(text: string): void {
-        this.applyEdits([{ from: 0, to: this.rope.length, text }], { source: 'external' });
+    /* Replaces everything as one undoable external edit, or with `clearHistory` as a text with no history before it, such as a reload from disk. */
+    setText(text: string, options: Pick<DocumentEditOptions, 'clearHistory'> = {}): void {
+        this.applyEdits([{ from: 0, to: this.rope.length, text }], { source: 'external', clearHistory: options.clearHistory });
     }
 
     undo(): boolean {
@@ -2950,6 +2958,17 @@ export class DocumentModel {
         return (this.structureCache ??= scanStructure(this.getText()));
     }
 
+    private clearHistory(): void {
+        if (this.undoStack.length === 0 && this.redoStack.length === 0) {
+            return;
+        }
+
+        this.undoStack = [];
+        this.redoStack = [];
+        this.groupOpen = false;
+        this.emit();
+    }
+
     private state(): State {
         return { rope: this.rope, selections: this.selections.map((selection) => ({ ...selection })) };
     }