Fix missing offset in Node#positionInside, Node#positionBy and Node#rangeBy (#2033)

mizdra · ai · web-flow · commit 7892a29ff849 · 2025-03-22T18:07:03.000+01:00
* Fix `opts` argument cannot be omitted

* Assign default values to `opts` just in case

- The `opts` argument to `Node#error` is currently omissible, but we'll assign a default value just in case.

* Add test cases

* Add test cases for `Node#rangeBy({start, end})`

* Add test cases for offset

* Fix missing offset in `Node#positionInside`, `Node#positionBy` and `Node#rangeBy`

* Fix conflict resolution mistakes

---------

Co-authored-by: Andrey Sitnik &lt;andrey@sitnik.ru&gt;
diff --git a/lib/node.d.ts b/lib/node.d.ts
@@ -424,7 +424,7 @@ declare abstract class Node_ {
    * @return Range.
    */
   rangeBy(
-    opts?: Pick<WarningOptions, 'endIndex' | 'index' | 'word'>
+    opts?: Pick<WarningOptions, 'end' | 'endIndex' | 'index' | 'start' | 'word'>
   ): Node.Range
 
   /**
diff --git a/lib/node.js b/lib/node.js
@@ -244,7 +244,7 @@ class Node {
       }
     }
 
-    return { column, line }
+    return { column, line, offset: end }
   }
 
   prev() {
@@ -254,24 +254,33 @@ class Node {
   }
 
   rangeBy(opts = {}) {
+    let inputString = ('document' in this.source.input)
+      ? this.source.input.document
+      : this.source.input.css
     let start = {
       column: this.source.start.column,
-      line: this.source.start.line
+      line: this.source.start.line,
+      offset: sourceOffset(inputString, this.source.start)
     }
     let end = this.source.end
       ? {
           column: this.source.end.column + 1,
-          line: this.source.end.line
+          line: this.source.end.line,
+          offset: typeof this.source.end.offset === 'number'
+            // `source.end.offset` is exclusive, so we don't need to add 1
+            ? this.source.end.offset
+            // Since line/column in this.source.end is inclusive,
+            // the `sourceOffset(... , this.source.end)` returns an inclusive offset.
+            // So, we add 1 to convert it to exclusive.
+            : sourceOffset(inputString, this.source.end) + 1
         }
       : {
           column: start.column + 1,
-          line: start.line
+          line: start.line,
+          offset: start.offset + 1
         }
 
     if (opts.word) {
-      let inputString = ('document' in this.source.input)
-        ? this.source.input.document
-        : this.source.input.css
       let stringRepresentation = inputString.slice(
         sourceOffset(inputString, this.source.start),
         sourceOffset(inputString, this.source.end)
@@ -287,7 +296,8 @@ class Node {
       if (opts.start) {
         start = {
           column: opts.start.column,
-          line: opts.start.line
+          line: opts.start.line,
+          offset: sourceOffset(inputString, opts.start)
         }
       } else if (opts.index) {
         start = this.positionInside(opts.index)
@@ -296,7 +306,8 @@ class Node {
       if (opts.end) {
         end = {
           column: opts.end.column,
-          line: opts.end.line
+          line: opts.end.line,
+          offset: sourceOffset(inputString, opts.end)
         }
       } else if (typeof opts.endIndex === 'number') {
         end = this.positionInside(opts.endIndex)
@@ -309,7 +320,11 @@ class Node {
       end.line < start.line ||
       (end.line === start.line && end.column <= start.column)
     ) {
-      end = { column: start.column + 1, line: start.line }
+      end = {
+        column: start.column + 1,
+        line: start.line,
+        offset: start.offset + 1
+      }
     }
 
     return { end, start }
diff --git a/test/node.test.ts b/test/node.test.ts
