Add isHidden for ranges to builder

Author: szuend

src/builder/builder.test.ts

@@ -154,6 +154,15 @@ describe("ScopeInfoBuilder", () => {
 
       assertStrictEquals(info.ranges[0]?.isStackFrame, true);
     });
+
+    it("can set isHidden via option", () => {
+      const info = builder.startRange(0, 0, { isHidden: true }).endRange(
+        10,
+        0,
+      ).build();
+
+      assertStrictEquals(info.ranges[0]?.isHidden, true);
+    });
   });
 
   describe("setRangeDefinitionScope", () => {
@@ -179,13 +188,23 @@ describe("ScopeInfoBuilder", () => {
       const info = builder.startRange(0, 0).setRangeStackFrame(true).endRange(
         10,
         0,
-      )
-        .build();
+      ).build();
 
       assertStrictEquals(info.ranges[0]?.isStackFrame, true);
     });
   });
 
+  describe("setRangeHidden", () => {
+    it("sets the isHidden flag", () => {
+      const info = builder.startRange(0, 0).setRangeHidden(true).endRange(
+        10,
+        0,
+      ).build();
+
+      assertStrictEquals(info.ranges[0]?.isHidden, true);
+    });
+  });
+
   describe("endRange", () => {
     it("does nothing when no range is open", () => {
       builder.endRange(0, 20);

src/builder/builder.ts

@@ -113,13 +113,17 @@ export class ScopeInfoBuilder {
   startRange(
     line: number,
     column: number,
-    options?: { scope?: number | OriginalScope; isStackFrame?: boolean },
+    options?: {
+      scope?: number | OriginalScope;
+      isStackFrame?: boolean;
+      isHidden?: boolean;
+    },
   ): this {
     const range: GeneratedRange = {
       start: { line, column },
       end: { line, column },
       isStackFrame: Boolean(options?.isStackFrame),
-      isHidden: false,
+      isHidden: Boolean(options?.isHidden),
       values: [],
       children: [],
     };
@@ -159,6 +163,13 @@ export class ScopeInfoBuilder {
     return this;
   }
 
+  setRangeHidden(isHidden: boolean): this {
+    const range = this.#rangeStack.at(-1);
+    if (range) range.isHidden = isHidden;
+
+    return this;
+  }
+
   endRange(line: number, column: number): this {
     const range = this.#rangeStack.pop();
     if (!range) return this;

src/builder/safe_builder.test.ts

@@ -201,6 +201,18 @@ describe("SafeScopeInfoBuilder", () => {
     });
   });
 
+  describe("setRangeHidden", () => {
+    it("throws when no range is on open", () => {
+      assertThrows(() => builder.setRangeHidden(true));
+    });
+
+    it("throws while building a scope", () => {
+      builder.startScope(0, 0);
+
+      assertThrows(() => builder.setRangeHidden(true));
+    });
+  });
+
   describe("endRange", () => {
     it("throws when the range stack is empty", () => {
       assertThrows(() => builder.endRange(5, 0));

src/builder/safe_builder.ts

@@ -170,6 +170,14 @@ export class SafeScopeInfoBuilder extends ScopeInfoBuilder {
     return this;
   }
 
+  override setRangeHidden(isHidden: boolean): this {
+    this.#verifyEmptyScopeStack("setRangeHidden");
+    this.#verifyRangePresent("setRangeHidden");
+
+    super.setRangeHidden(isHidden);
+    return this;
+  }
+
   override endRange(line: number, column: number): this {
     this.#verifyEmptyScopeStack("endRange");