@codemirror/state 6.2.0 → 6.2.1

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 6.2.1 (2023-05-23)
+
+### Bug fixes
+
+Fix an issue that could cause `RangeSet.compare` to miss changes in the set of active ranges around a point range.
+
 ## 6.2.0 (2022-12-26)
 
 ### New features

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (C) 2018-2021 by Marijn Haverbeke <marijnh@gmail.com> and others
+Copyright (C) 2018-2021 by Marijn Haverbeke <marijn@haverbeke.berlin> and others
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/index.cjs

@@ -6,10 +6,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
 The data structure for documents. @nonabstract
 */
 class Text {
-    /**
-    @internal
-    */
-    constructor() { }
     /**
     Get the line description around the given position.
     */
@@ -104,7 +100,8 @@ class Text {
         return new LineCursor(inner);
     }
     /**
-    @internal
+    Return the document as a string, using newline characters to
+    separate lines.
     */
     toString() { return this.sliceString(0); }
     /**
@@ -117,6 +114,10 @@ class Text {
         return lines;
     }
     /**
+    @internal
+    */
+    constructor() { }
+    /**
     Create a `Text` instance for the given array of lines.
     */
     static of(text) {
@@ -2161,7 +2162,10 @@ class StateEffect {
     is(type) { return this.type == type; }
     /**
     Define a new effect type. The type parameter indicates the type
-    of values that his effect holds.
+    of values that his effect holds. It should be a type that
+    doesn't include `undefined`, since that is used in
+    [mapping](https://codemirror.net/6/docs/ref/#state.StateEffect.map) to indicate that an effect is
+    removed.
     */
     static define(spec = {}) {
         return new StateEffectType(spec.map || (v => v));
@@ -3305,8 +3309,7 @@ class RangeSet {
     static compare(oldSets, newSets, 
     /**
     This indicates how the underlying data changed between these
-    ranges, and is needed to synchronize the iteration. `from` and
-    `to` are coordinates in the _new_ space, after these changes.
+    ranges, and is needed to synchronize the iteration.
     */
     textDiff, comparator, 
     /**
@@ -3417,6 +3420,18 @@ A range set builder is a data structure that helps build up a
 an array of [`Range`](https://codemirror.net/6/docs/ref/#state.Range) objects.
 */
 class RangeSetBuilder {
+    finishChunk(newArrays) {
+        this.chunks.push(new Chunk(this.from, this.to, this.value, this.maxPoint));
+        this.chunkPos.push(this.chunkStart);
+        this.chunkStart = -1;
+        this.setMaxPoint = Math.max(this.setMaxPoint, this.maxPoint);
+        this.maxPoint = -1;
+        if (newArrays) {
+            this.from = [];
+            this.to = [];
+            this.value = [];
+        }
+    }
     /**
     Create an empty builder.
     */
@@ -3434,18 +3449,6 @@ class RangeSetBuilder {
         this.setMaxPoint = -1;
         this.nextLayer = null;
     }
-    finishChunk(newArrays) {
-        this.chunks.push(new Chunk(this.from, this.to, this.value, this.maxPoint));
-        this.chunkPos.push(this.chunkStart);
-        this.chunkStart = -1;
-        this.setMaxPoint = Math.max(this.setMaxPoint, this.maxPoint);
-        this.maxPoint = -1;
-        if (newArrays) {
-            this.from = [];
-            this.to = [];
-            this.value = [];
-        }
-    }
     /**
     Add a range. Ranges should be added in sorted (by `from` and
     `value.startSide`) order.
@@ -3805,7 +3808,7 @@ function compare(a, startA, b, startB, length, comparator) {
         let end = diff < 0 ? a.to + dPos : b.to, clipEnd = Math.min(end, endB);
         if (a.point || b.point) {
             if (!(a.point && b.point && (a.point == b.point || a.point.eq(b.point)) &&
-                sameValues(a.activeForPoint(a.to + dPos), b.activeForPoint(b.to))))
+                sameValues(a.activeForPoint(a.to), b.activeForPoint(b.to))))
                 comparator.comparePoint(pos, clipEnd, a.point, b.point);
         }
         else {

package/dist/index.d.ts

@@ -85,6 +85,11 @@ declare abstract class Text implements Iterable<string> {
     */
     iterLines(from?: number, to?: number): TextIterator;
     /**
+    Return the document as a string, using newline characters to
+    separate lines.
+    */
+    toString(): string;
+    /**
     Convert the document to an array of lines (which can be
     deserialized again via [`Text.of`](https://codemirror.net/6/docs/ref/#state.Text^of)).
     */
@@ -252,7 +257,7 @@ plain object describing a change (a deletion, insertion, or
 replacement, depending on which fields are present), a [change
 set](https://codemirror.net/6/docs/ref/#state.ChangeSet), or an array of change specs.
 */
-declare type ChangeSpec = {
+type ChangeSpec = {
     from: number;
     to?: number;
     insert?: string | Text;
@@ -479,7 +484,7 @@ declare class EditorSelection {
     static range(anchor: number, head: number, goalColumn?: number, bidiLevel?: number): SelectionRange;
 }
 
-declare type FacetConfig<Input, Output> = {
+type FacetConfig<Input, Output> = {
     /**
     How to combine the input values into a single output value. When
     not given, the array of input values becomes the output. This
@@ -559,8 +564,8 @@ declare class Facet<Input, Output = readonly Input[]> {
     from<T extends Input>(field: StateField<T>): Extension;
     from<T>(field: StateField<T>, get: (value: T) => Input): Extension;
 }
-declare type Slot<T> = Facet<any, T> | StateField<T> | "doc" | "selection";
-declare type StateFieldSpec<Value> = {
+type Slot<T> = Facet<any, T> | StateField<T> | "doc" | "selection";
+type StateFieldSpec<Value> = {
     /**
     Creates the initial value for the field when a state is created.
     */
@@ -635,7 +640,7 @@ providers](https://codemirror.net/6/docs/ref/#state.Facet.of), or objects with a
 `extension` property. Extensions can be nested in arrays
 arbitrarily deep—they will be flattened when processed.
 */
-declare type Extension = {
+type Extension = {
     extension: Extension;
 } | readonly Extension[];
 /**
@@ -780,7 +785,10 @@ declare class StateEffect<Value> {
     is<T>(type: StateEffectType<T>): this is StateEffect<T>;
     /**
     Define a new effect type. The type parameter indicates the type
-    of values that his effect holds.
+    of values that his effect holds. It should be a type that
+    doesn't include `undefined`, since that is used in
+    [mapping](https://codemirror.net/6/docs/ref/#state.StateEffect.map) to indicate that an effect is
+    removed.
     */
     static define<Value = null>(spec?: StateEffectSpec<Value>): StateEffectType<Value>;
     /**
@@ -1317,7 +1325,7 @@ Subtype of [`Command`](https://codemirror.net/6/docs/ref/#view.Command) that doe
 to the actual editor view. Mostly useful to define commands that
 can be run and tested outside of a browser environment.
 */
-declare type StateCommand = (target: {
+type StateCommand = (target: {
     state: EditorState;
     dispatch: (transaction: Transaction) => void;
 }) => boolean;
@@ -1459,7 +1467,7 @@ interface RangeCursor<T> {
     */
     to: number;
 }
-declare type RangeSetUpdate<T extends RangeValue> = {
+type RangeSetUpdate<T extends RangeValue> = {
     /**
     An array of ranges to add. If given, this should be sorted by
     `from` position and `startSide` unless
@@ -1538,8 +1546,7 @@ declare class RangeSet<T extends RangeValue> {
     static compare<T extends RangeValue>(oldSets: readonly RangeSet<T>[], newSets: readonly RangeSet<T>[], 
     /**
     This indicates how the underlying data changed between these
-    ranges, and is needed to synchronize the iteration. `from` and
-    `to` are coordinates in the _new_ space, after these changes.
+    ranges, and is needed to synchronize the iteration.
     */
     textDiff: ChangeDesc, comparator: RangeComparator<T>, 
     /**

package/dist/index.js

@@ -2,10 +2,6 @@
 The data structure for documents. @nonabstract
 */
 class Text {
-    /**
-    @internal
-    */
-    constructor() { }
     /**
     Get the line description around the given position.
     */
@@ -100,7 +96,8 @@ class Text {
         return new LineCursor(inner);
     }
     /**
-    @internal
+    Return the document as a string, using newline characters to
+    separate lines.
     */
     toString() { return this.sliceString(0); }
     /**
@@ -113,6 +110,10 @@ class Text {
         return lines;
     }
     /**
+    @internal
+    */
+    constructor() { }
+    /**
     Create a `Text` instance for the given array of lines.
     */
     static of(text) {
@@ -2156,7 +2157,10 @@ class StateEffect {
     is(type) { return this.type == type; }
     /**
     Define a new effect type. The type parameter indicates the type
-    of values that his effect holds.
+    of values that his effect holds. It should be a type that
+    doesn't include `undefined`, since that is used in
+    [mapping](https://codemirror.net/6/docs/ref/#state.StateEffect.map) to indicate that an effect is
+    removed.
     */
     static define(spec = {}) {
         return new StateEffectType(spec.map || (v => v));
@@ -3299,8 +3303,7 @@ class RangeSet {
     static compare(oldSets, newSets, 
     /**
     This indicates how the underlying data changed between these
-    ranges, and is needed to synchronize the iteration. `from` and
-    `to` are coordinates in the _new_ space, after these changes.
+    ranges, and is needed to synchronize the iteration.
     */
     textDiff, comparator, 
     /**
@@ -3411,6 +3414,18 @@ A range set builder is a data structure that helps build up a
 an array of [`Range`](https://codemirror.net/6/docs/ref/#state.Range) objects.
 */
 class RangeSetBuilder {
+    finishChunk(newArrays) {
+        this.chunks.push(new Chunk(this.from, this.to, this.value, this.maxPoint));
+        this.chunkPos.push(this.chunkStart);
+        this.chunkStart = -1;
+        this.setMaxPoint = Math.max(this.setMaxPoint, this.maxPoint);
+        this.maxPoint = -1;
+        if (newArrays) {
+            this.from = [];
+            this.to = [];
+            this.value = [];
+        }
+    }
     /**
     Create an empty builder.
     */
@@ -3428,18 +3443,6 @@ class RangeSetBuilder {
         this.setMaxPoint = -1;
         this.nextLayer = null;
     }
-    finishChunk(newArrays) {
-        this.chunks.push(new Chunk(this.from, this.to, this.value, this.maxPoint));
-        this.chunkPos.push(this.chunkStart);
-        this.chunkStart = -1;
-        this.setMaxPoint = Math.max(this.setMaxPoint, this.maxPoint);
-        this.maxPoint = -1;
-        if (newArrays) {
-            this.from = [];
-            this.to = [];
-            this.value = [];
-        }
-    }
     /**
     Add a range. Ranges should be added in sorted (by `from` and
     `value.startSide`) order.
@@ -3799,7 +3802,7 @@ function compare(a, startA, b, startB, length, comparator) {
         let end = diff < 0 ? a.to + dPos : b.to, clipEnd = Math.min(end, endB);
         if (a.point || b.point) {
             if (!(a.point && b.point && (a.point == b.point || a.point.eq(b.point)) &&
-                sameValues(a.activeForPoint(a.to + dPos), b.activeForPoint(b.to))))
+                sameValues(a.activeForPoint(a.to), b.activeForPoint(b.to))))
                 comparator.comparePoint(pos, clipEnd, a.point, b.point);
         }
         else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codemirror/state",
-  "version": "6.2.0",
+  "version": "6.2.1",
   "description": "Editor state data structures for the CodeMirror code editor",
   "scripts": {
     "test": "cm-runtests",
@@ -12,7 +12,7 @@
   ],
   "author": {
     "name": "Marijn Haverbeke",
-    "email": "marijnh@gmail.com",
+    "email": "marijn@haverbeke.berlin",
     "url": "http://marijnhaverbeke.nl"
   },
   "type": "module",