Fix opts argument of Node#rangeBy() and Node#positionBy() cannot be omitted (#2031)

mizdra · web-flow · commit 875f1fb7f863 · 2025-03-22T17:13:46.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
diff --git a/lib/node.js b/lib/node.js
@@ -208,7 +208,7 @@ class Node {
     return this.parent.nodes[index + 1]
   }
 
-  positionBy(opts) {
+  positionBy(opts = {}) {
     let pos = this.source.start
     if (opts.index) {
       pos = this.positionInside(opts.index)
@@ -253,7 +253,7 @@ class Node {
     return this.parent.nodes[index - 1]
   }
 
-  rangeBy(opts) {
+  rangeBy(opts = {}) {
     let start = {
       column: this.source.start.column,
       line: this.source.start.line
@@ -423,7 +423,7 @@ class Node {
     return result
   }
 
-  warn(result, text, opts) {
+  warn(result, text, opts = {}) {
     let data = { node: this }
     for (let i in opts) data[i] = opts[i]
     return result.warn(text, data)
diff --git a/test/node.test.ts b/test/node.test.ts
@@ -453,6 +453,29 @@ test('positionInside() supports multi-root documents', () => {
   equal(a.positionInside(1), { column: 9, line: 1 })
 })
 
+test('positionBy() returns position', () => {
+  let css = parse('a {  one: X  }')
+  let a = css.first as Rule
+  let one = a.first as Declaration
+  equal(one.positionBy(), { column: 6, line: 1, offset: 5 })
+  equal(a.positionBy(), { column: 1, line: 1, offset: 0 })
+})
+
+test('positionBy() returns position after AST mutations', () => {
+  let css = parse('a {\n\tone: 1;\n\ttwo: 2;}')
+  let a = css.first as Rule
+  let one = a.first as Declaration
+  let two = one.next() as Declaration
+
+  equal(a.positionBy(), { column: 1, line: 1, offset: 0 })
+  equal(two.positionBy(), { column: 2, line: 3, offset: 14 })
+
+  one.remove()
+
+  equal(a.positionBy(), { column: 1, line: 1, offset: 0 })
+  equal(two.positionBy(), { column: 2, line: 3, offset: 14 })
+})
+
 test('positionBy() returns position for word', () => {
   let css = parse('a {  one: X  }')
   let a = css.first as Rule
@@ -527,6 +550,59 @@ test('positionBy() supports multi-root documents', () => {
   equal(a.positionBy({ word: 'a' }), { column: 8, line: 1 })
 })
 
+test('rangeBy() returns range', () => {
+  let css = parse('a {  one: X  }')
+  let a = css.first as Rule
+  let one = a.first as Declaration
+  equal(one.rangeBy(), {
+    end: { column: 12, line: 1 },
+    start: { column: 6, line: 1 }
+  })
+})
+
+test('rangeBy() returns range when offsets are missing', () => {
+  let css = parse('a {  one: X  }')
+  let a = css.first as Rule
+  let one = a.first as Declaration
+
+  // @ts-expect-error Testing non-standard AST
+  if (one.source?.start) delete one.source.start.offset
+  // @ts-expect-error Testing non-standard AST
+  if (one.source?.end) delete one.source.end.offset
+
+  equal(one.rangeBy(), {
+    end: { column: 12, line: 1 },
+    start: { column: 6, line: 1 }
+  })
+})
+
+test('rangeBy() returns range for empty object even after AST mutations', () => {
+  let css = parse('a {\n\tone: 1;\n\ttwo: 2;}')
+  let a = css.first as Rule
+  let one = a.first as Declaration
+  let two = one.next() as Declaration
+
+  equal(a.rangeBy(), {
+    end: { column: 10, line: 3 },
+    start: { column: 1, line: 1 }
+  })
+  equal(two.rangeBy(), {
+    end: { column: 9, line: 3 },
+    start: { column: 2, line: 3 }
+  })
+
+  one.remove()
+
+  equal(a.rangeBy(), {
+    end: { column: 10, line: 3 },
+    start: { column: 1, line: 1 }
+  })
+  equal(two.rangeBy(), {
+    end: { column: 9, line: 3 },
+    start: { column: 2, line: 3 }
+  })
+})
+
 test('rangeBy() returns range for word', () => {
   let css = parse('a {  one: X  }')
   let a = css.first as Rule
