@gtkx/testing 0.20.0 → 1.0.0-rc.1

package/dist/matchers.js

@@ -0,0 +1,103 @@
+/// <reference types="@vitest/expect" />
+import * as Gtk from "@gtkx/gi/gtk";
+import { getWidgetAccessibleName, getWidgetCheckedState, getWidgetDisplayValue, getWidgetExpandedState, getWidgetNodeText, getWidgetPlaceholderText, getWidgetPressedState, getWidgetSelectedState, getWidgetValue, } from "./widget-accessible-properties.js";
+const asWidget = (received, matcherName) => {
+    if (!(received instanceof Gtk.Widget)) {
+        throw new TypeError(`${matcherName}: received value must be a Gtk.Widget, got ${typeof received}`);
+    }
+    return received;
+};
+const describeWidget = (widget) => {
+    const role = Gtk.AccessibleRole[widget.getAccessibleRole()];
+    const name = getWidgetAccessibleName(widget);
+    return name !== null ? `<${role} name=${JSON.stringify(name)}>` : `<${role}>`;
+};
+const matchesText = (actual, expected, mode) => {
+    if (expected instanceof RegExp) {
+        expected.lastIndex = 0;
+        return expected.test(actual);
+    }
+    return mode === "exact" ? actual === expected : actual.includes(expected);
+};
+const describeExpected = (expected) => expected instanceof RegExp ? String(expected) : JSON.stringify(expected);
+const textMatcher = (matcherName, read, mode) => function (received, expected) {
+    const widget = asWidget(received, matcherName);
+    const actual = read(widget);
+    if (expected === undefined) {
+        const pass = actual !== null && actual !== "";
+        return {
+            pass,
+            message: () => `expected widget ${this.isNot ? "not " : ""}to have a non-empty value for ${matcherName}, ` +
+                `but got ${JSON.stringify(actual)}\n${describeWidget(widget)}`,
+        };
+    }
+    const pass = actual !== null && matchesText(actual, expected, mode);
+    return {
+        pass,
+        message: () => `expected widget ${this.isNot ? "not " : ""}${matcherName} ${describeExpected(expected)}, ` +
+            `but received ${JSON.stringify(actual)}\n${describeWidget(widget)}`,
+    };
+};
+const booleanStateMatcher = (matcherName, stateName, read) => function (received) {
+    const widget = asWidget(received, matcherName);
+    const state = read(widget);
+    if (state === null) {
+        throw new Error(`${matcherName}: widget does not expose a ${stateName} state ` +
+            `(role ${Gtk.AccessibleRole[widget.getAccessibleRole()]})\n${describeWidget(widget)}`);
+    }
+    return {
+        pass: state,
+        message: () => `expected widget ${this.isNot ? "not " : ""}to be ${stateName}\n${describeWidget(widget)}`,
+    };
+};
+export const toHaveDisplayValue = textMatcher("toHaveDisplayValue", getWidgetDisplayValue, "exact");
+export const toHaveTextContent = textMatcher("toHaveTextContent", (widget) => getWidgetNodeText(widget) ?? getWidgetAccessibleName(widget), "substring");
+export const toHaveAccessibleName = textMatcher("toHaveAccessibleName", getWidgetAccessibleName, "exact");
+export const toHavePlaceholderText = textMatcher("toHavePlaceholderText", getWidgetPlaceholderText, "exact");
+export const toBeChecked = booleanStateMatcher("toBeChecked", "checked", getWidgetCheckedState);
+export const toBePressed = booleanStateMatcher("toBePressed", "pressed", getWidgetPressedState);
+export const toBeExpanded = booleanStateMatcher("toBeExpanded", "expanded", getWidgetExpandedState);
+export const toBeSelected = booleanStateMatcher("toBeSelected", "selected", getWidgetSelectedState);
+export const toHaveValue = function (received, expected) {
+    const widget = asWidget(received, "toHaveValue");
+    const actual = getWidgetValue(widget).now;
+    if (actual === null) {
+        throw new Error(`toHaveValue: widget does not expose a numeric value ` +
+            `(role ${Gtk.AccessibleRole[widget.getAccessibleRole()]})\n${describeWidget(widget)}`);
+    }
+    return {
+        pass: actual === expected,
+        message: () => `expected widget ${this.isNot ? "not " : ""}to have value ${expected}, but received ${actual}\n${describeWidget(widget)}`,
+    };
+};
+/** The widget assertion matchers keyed by name, suitable for passing to `expect.extend`. */
+export const matchers = {
+    toHaveDisplayValue,
+    toHaveTextContent,
+    toHaveAccessibleName,
+    toHavePlaceholderText,
+    toBeChecked,
+    toBePressed,
+    toBeExpanded,
+    toBeSelected,
+    toHaveValue,
+};
+const globalExpect = () => {
+    const candidate = Reflect.get(globalThis, "expect");
+    if (candidate && typeof candidate.extend === "function") {
+        return candidate;
+    }
+    return null;
+};
+let registered = false;
+/** Registers the widget matchers on the global `expect`, when one is available. Safe to call more than once. */
+export const registerMatchers = () => {
+    if (registered)
+        return;
+    const expect = globalExpect();
+    if (!expect)
+        return;
+    expect.extend(matchers);
+    registered = true;
+};
+//# sourceMappingURL=matchers.js.map

package/dist/matchers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"matchers.js","sourceRoot":"","sources":["../src/matchers.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AACpC,OAAO,EACH,uBAAuB,EACvB,qBAAqB,EACrB,qBAAqB,EACrB,sBAAsB,EACtB,iBAAiB,EACjB,wBAAwB,EACxB,qBAAqB,EACrB,sBAAsB,EACtB,cAAc,GACjB,MAAM,mCAAmC,CAAC;AAe3C,MAAM,QAAQ,GAAG,CAAC,QAAiB,EAAE,WAAmB,EAAc,EAAE;IACpE,IAAI,CAAC,CAAC,QAAQ,YAAY,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,SAAS,CAAC,GAAG,WAAW,8CAA8C,OAAO,QAAQ,EAAE,CAAC,CAAC;IACvG,CAAC;IACD,OAAO,QAAQ,CAAC;AACpB,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,MAAkB,EAAU,EAAE;IAClD,MAAM,IAAI,GAAG,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAC5D,MAAM,IAAI,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAC7C,OAAO,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,SAAS,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,CAAC;AAClF,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,MAAc,EAAE,QAAyB,EAAE,IAA2B,EAAW,EAAE;IACpG,IAAI,QAAQ,YAAY,MAAM,EAAE,CAAC;QAC7B,QAAQ,CAAC,SAAS,GAAG,CAAC,CAAC;QACvB,OAAO,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC9E,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,QAAyB,EAAU,EAAE,CAC3D,QAAQ,YAAY,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;AAE7E,MAAM,WAAW,GAAG,CAChB,WAAmB,EACnB,IAA2C,EAC3C,IAA2B,EAChB,EAAE,CACb,UAAgC,QAAiB,EAAE,QAA0B;IACzE,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;IAE5B,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,EAAE,CAAC;QAC9C,OAAO;YACH,IAAI;YACJ,OAAO,EAAE,GAAG,EAAE,CACV,mBAAmB,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,iCAAiC,WAAW,IAAI;gBAC3F,WAAW,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,cAAc,CAAC,MAAM,CAAC,EAAE;SACrE,CAAC;IACN,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,KAAK,IAAI,IAAI,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;IACpE,OAAO;QACH,IAAI;QACJ,OAAO,EAAE,GAAG,EAAE,CACV,mBAAmB,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,WAAW,IAAI,gBAAgB,CAAC,QAAQ,CAAC,IAAI;YAC3F,gBAAgB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,cAAc,CAAC,MAAM,CAAC,EAAE;KAC1E,CAAC;AACN,CAAC,CAAC;AAEN,MAAM,mBAAmB,GAAG,CACxB,WAAmB,EACnB,SAAiB,EACjB,IAA4C,EAChC,EAAE,CACd,UAAgC,QAAiB;IAC7C,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3B,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CACX,GAAG,WAAW,8BAA8B,SAAS,SAAS;YAC1D,SAAS,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC,MAAM,cAAc,CAAC,MAAM,CAAC,EAAE,CAC5F,CAAC;IACN,CAAC;IACD,OAAO;QACH,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,GAAG,EAAE,CAAC,mBAAmB,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,SAAS,KAAK,cAAc,CAAC,MAAM,CAAC,EAAE;KAC5G,CAAC;AACN,CAAC,CAAC;AAEN,MAAM,CAAC,MAAM,kBAAkB,GAAgB,WAAW,CAAC,oBAAoB,EAAE,qBAAqB,EAAE,OAAO,CAAC,CAAC;AACjH,MAAM,CAAC,MAAM,iBAAiB,GAAgB,WAAW,CACrD,mBAAmB,EACnB,CAAC,MAAM,EAAE,EAAE,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,uBAAuB,CAAC,MAAM,CAAC,EACxE,WAAW,CACd,CAAC;AACF,MAAM,CAAC,MAAM,oBAAoB,GAAgB,WAAW,CAAC,sBAAsB,EAAE,uBAAuB,EAAE,OAAO,CAAC,CAAC;AACvH,MAAM,CAAC,MAAM,qBAAqB,GAAgB,WAAW,CACzD,uBAAuB,EACvB,wBAAwB,EACxB,OAAO,CACV,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAiB,mBAAmB,CAAC,aAAa,EAAE,SAAS,EAAE,qBAAqB,CAAC,CAAC;AAC9G,MAAM,CAAC,MAAM,WAAW,GAAiB,mBAAmB,CAAC,aAAa,EAAE,SAAS,EAAE,qBAAqB,CAAC,CAAC;AAC9G,MAAM,CAAC,MAAM,YAAY,GAAiB,mBAAmB,CAAC,cAAc,EAAE,UAAU,EAAE,sBAAsB,CAAC,CAAC;AAClH,MAAM,CAAC,MAAM,YAAY,GAAiB,mBAAmB,CAAC,cAAc,EAAE,UAAU,EAAE,sBAAsB,CAAC,CAAC;AAElH,MAAM,CAAC,MAAM,WAAW,GAAiB,UAErC,QAAiB,EACjB,QAAgB;IAEhB,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;IACjD,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC;IAC1C,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CACX,sDAAsD;YAClD,SAAS,GAAG,CAAC,cAAc,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC,MAAM,cAAc,CAAC,MAAM,CAAC,EAAE,CAC5F,CAAC;IACN,CAAC;IACD,OAAO;QACH,IAAI,EAAE,MAAM,KAAK,QAAQ;QACzB,OAAO,EAAE,GAAG,EAAE,CACV,mBAAmB,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,iBAAiB,QAAQ,kBAAkB,MAAM,KAAK,cAAc,CAAC,MAAM,CAAC,EAAE;KAChI,CAAC;AACN,CAAC,CAAC;AAcF,4FAA4F;AAC5F,MAAM,CAAC,MAAM,QAAQ,GAA2B;IAC5C,kBAAkB;IAClB,iBAAiB;IACjB,oBAAoB;IACpB,qBAAqB;IACrB,WAAW;IACX,WAAW;IACX,YAAY;IACZ,YAAY;IACZ,WAAW;CACd,CAAC;AAIF,MAAM,YAAY,GAAG,GAAwB,EAAE;IAC3C,MAAM,SAAS,GAAY,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAC7D,IAAI,SAAS,IAAI,OAAQ,SAA0B,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;QACxE,OAAO,SAAyB,CAAC;IACrC,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF,IAAI,UAAU,GAAG,KAAK,CAAC;AAEvB,gHAAgH;AAChH,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAS,EAAE;IACvC,IAAI,UAAU;QAAE,OAAO;IACvB,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC;IAC9B,IAAI,CAAC,MAAM;QAAE,OAAO;IACpB,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACxB,UAAU,GAAG,IAAI,CAAC;AACtB,CAAC,CAAC","sourcesContent":["/// <reference types=\"@vitest/expect\" />\nimport * as Gtk from \"@gtkx/gi/gtk\";\nimport {\n    getWidgetAccessibleName,\n    getWidgetCheckedState,\n    getWidgetDisplayValue,\n    getWidgetExpandedState,\n    getWidgetNodeText,\n    getWidgetPlaceholderText,\n    getWidgetPressedState,\n    getWidgetSelectedState,\n    getWidgetValue,\n} from \"./widget-accessible-properties.js\";\n\n/** The expected value for a text matcher: an exact string or a regular expression. */\nexport type TextExpectation = string | RegExp;\n\ntype MatcherResult = { pass: boolean; message: () => string };\n\ninterface MatcherContext {\n    isNot: boolean;\n}\n\ntype TextMatcher = (this: MatcherContext, received: unknown, expected?: TextExpectation) => MatcherResult;\ntype StateMatcher = (this: MatcherContext, received: unknown) => MatcherResult;\ntype ValueMatcher = (this: MatcherContext, received: unknown, expected: number) => MatcherResult;\n\nconst asWidget = (received: unknown, matcherName: string): Gtk.Widget => {\n    if (!(received instanceof Gtk.Widget)) {\n        throw new TypeError(`${matcherName}: received value must be a Gtk.Widget, got ${typeof received}`);\n    }\n    return received;\n};\n\nconst describeWidget = (widget: Gtk.Widget): string => {\n    const role = Gtk.AccessibleRole[widget.getAccessibleRole()];\n    const name = getWidgetAccessibleName(widget);\n    return name !== null ? `<${role} name=${JSON.stringify(name)}>` : `<${role}>`;\n};\n\nconst matchesText = (actual: string, expected: TextExpectation, mode: \"exact\" | \"substring\"): boolean => {\n    if (expected instanceof RegExp) {\n        expected.lastIndex = 0;\n        return expected.test(actual);\n    }\n    return mode === \"exact\" ? actual === expected : actual.includes(expected);\n};\n\nconst describeExpected = (expected: TextExpectation): string =>\n    expected instanceof RegExp ? String(expected) : JSON.stringify(expected);\n\nconst textMatcher = (\n    matcherName: string,\n    read: (widget: Gtk.Widget) => string | null,\n    mode: \"exact\" | \"substring\",\n): TextMatcher =>\n    function (this: MatcherContext, received: unknown, expected?: TextExpectation): MatcherResult {\n        const widget = asWidget(received, matcherName);\n        const actual = read(widget);\n\n        if (expected === undefined) {\n            const pass = actual !== null && actual !== \"\";\n            return {\n                pass,\n                message: () =>\n                    `expected widget ${this.isNot ? \"not \" : \"\"}to have a non-empty value for ${matcherName}, ` +\n                    `but got ${JSON.stringify(actual)}\\n${describeWidget(widget)}`,\n            };\n        }\n\n        const pass = actual !== null && matchesText(actual, expected, mode);\n        return {\n            pass,\n            message: () =>\n                `expected widget ${this.isNot ? \"not \" : \"\"}${matcherName} ${describeExpected(expected)}, ` +\n                `but received ${JSON.stringify(actual)}\\n${describeWidget(widget)}`,\n        };\n    };\n\nconst booleanStateMatcher = (\n    matcherName: string,\n    stateName: string,\n    read: (widget: Gtk.Widget) => boolean | null,\n): StateMatcher =>\n    function (this: MatcherContext, received: unknown): MatcherResult {\n        const widget = asWidget(received, matcherName);\n        const state = read(widget);\n        if (state === null) {\n            throw new Error(\n                `${matcherName}: widget does not expose a ${stateName} state ` +\n                    `(role ${Gtk.AccessibleRole[widget.getAccessibleRole()]})\\n${describeWidget(widget)}`,\n            );\n        }\n        return {\n            pass: state,\n            message: () => `expected widget ${this.isNot ? \"not \" : \"\"}to be ${stateName}\\n${describeWidget(widget)}`,\n        };\n    };\n\nexport const toHaveDisplayValue: TextMatcher = textMatcher(\"toHaveDisplayValue\", getWidgetDisplayValue, \"exact\");\nexport const toHaveTextContent: TextMatcher = textMatcher(\n    \"toHaveTextContent\",\n    (widget) => getWidgetNodeText(widget) ?? getWidgetAccessibleName(widget),\n    \"substring\",\n);\nexport const toHaveAccessibleName: TextMatcher = textMatcher(\"toHaveAccessibleName\", getWidgetAccessibleName, \"exact\");\nexport const toHavePlaceholderText: TextMatcher = textMatcher(\n    \"toHavePlaceholderText\",\n    getWidgetPlaceholderText,\n    \"exact\",\n);\n\nexport const toBeChecked: StateMatcher = booleanStateMatcher(\"toBeChecked\", \"checked\", getWidgetCheckedState);\nexport const toBePressed: StateMatcher = booleanStateMatcher(\"toBePressed\", \"pressed\", getWidgetPressedState);\nexport const toBeExpanded: StateMatcher = booleanStateMatcher(\"toBeExpanded\", \"expanded\", getWidgetExpandedState);\nexport const toBeSelected: StateMatcher = booleanStateMatcher(\"toBeSelected\", \"selected\", getWidgetSelectedState);\n\nexport const toHaveValue: ValueMatcher = function (\n    this: MatcherContext,\n    received: unknown,\n    expected: number,\n): MatcherResult {\n    const widget = asWidget(received, \"toHaveValue\");\n    const actual = getWidgetValue(widget).now;\n    if (actual === null) {\n        throw new Error(\n            `toHaveValue: widget does not expose a numeric value ` +\n                `(role ${Gtk.AccessibleRole[widget.getAccessibleRole()]})\\n${describeWidget(widget)}`,\n        );\n    }\n    return {\n        pass: actual === expected,\n        message: () =>\n            `expected widget ${this.isNot ? \"not \" : \"\"}to have value ${expected}, but received ${actual}\\n${describeWidget(widget)}`,\n    };\n};\n\ninterface MatcherImplementations {\n    toHaveDisplayValue: TextMatcher;\n    toHaveTextContent: TextMatcher;\n    toHaveAccessibleName: TextMatcher;\n    toHavePlaceholderText: TextMatcher;\n    toBeChecked: StateMatcher;\n    toBePressed: StateMatcher;\n    toBeExpanded: StateMatcher;\n    toBeSelected: StateMatcher;\n    toHaveValue: ValueMatcher;\n}\n\n/** The widget assertion matchers keyed by name, suitable for passing to `expect.extend`. */\nexport const matchers: MatcherImplementations = {\n    toHaveDisplayValue,\n    toHaveTextContent,\n    toHaveAccessibleName,\n    toHavePlaceholderText,\n    toBeChecked,\n    toBePressed,\n    toBeExpanded,\n    toBeSelected,\n    toHaveValue,\n};\n\ntype ExpectExtend = { extend: (m: MatcherImplementations) => void };\n\nconst globalExpect = (): ExpectExtend | null => {\n    const candidate: unknown = Reflect.get(globalThis, \"expect\");\n    if (candidate && typeof (candidate as ExpectExtend).extend === \"function\") {\n        return candidate as ExpectExtend;\n    }\n    return null;\n};\n\nlet registered = false;\n\n/** Registers the widget matchers on the global `expect`, when one is available. Safe to call more than once. */\nexport const registerMatchers = (): void => {\n    if (registered) return;\n    const expect = globalExpect();\n    if (!expect) return;\n    expect.extend(matchers);\n    registered = true;\n};\n\ninterface WidgetMatchers<R = void> {\n    toHaveDisplayValue(expected?: TextExpectation): R;\n    toHaveTextContent(expected?: TextExpectation): R;\n    toHaveAccessibleName(expected?: TextExpectation): R;\n    toHavePlaceholderText(expected?: TextExpectation): R;\n    toBeChecked(): R;\n    toBePressed(): R;\n    toBeExpanded(): R;\n    toBeSelected(): R;\n    toHaveValue(expected: number): R;\n}\n\ndeclare module \"@vitest/expect\" {\n    // biome-ignore lint/suspicious/noExplicitAny: must match the `Assertion<T>` signature it augments for declaration merging\n    interface Assertion<T = any> extends WidgetMatchers {}\n    interface AsymmetricMatchersContaining extends WidgetMatchers {}\n}\n"]}

package/dist/pretty-widget.d.ts

@@ -1,37 +1,33 @@
+import type * as Gtk from "@gtkx/gi/gtk";
 import { type Container } from "./traversal.js";
+type WidgetIdResolver = (widget: Gtk.Widget) => string;
 /**
- * Options for {@link prettyWidget}.
+ * Options controlling how a widget tree is rendered to a string by
+ * {@link prettyWidget} and {@link logWidget}.
  */
 export type PrettyWidgetOptions = {
-    /** Maximum output length before truncation (default: 7000) */
+    /** Truncates the output once it exceeds this many characters. */
     maxLength?: number;
-    /** Enable ANSI color highlighting (default: auto-detect) */
+    /** Whether to apply ANSI color highlighting; defaults to the terminal capabilities. */
     highlight?: boolean;
-    /** Include widget IDs for MCP/agentic interactions (default: false) */
-    includeIds?: boolean;
+    /** Resolves an `id` attribute to show for each widget. */
+    getId?: WidgetIdResolver;
 };
 /**
- * Formats a widget tree as a readable string for debugging.
+ * Renders a widget tree as an indented, HTML-like string showing each widget's
+ * tag, accessible attributes, and text content.
  *
- * Renders the widget hierarchy in an HTML-like format with accessibility
- * attributes like role, data-testid, and text content.
- *
- * @param container - The container widget or application to format
- * @param options - Formatting options for length and highlighting
- * @returns Formatted string representation of the widget tree
- *
- * @example
- * ```tsx
- * import { prettyWidget } from "@gtkx/testing";
- *
- * console.log(prettyWidget(application));
- * // Output:
- * // <GtkApplicationWindow role="window">
- * //   <GtkButton role="button">
- * //     Click me
- * //   </GtkButton>
- * // </GtkApplicationWindow>
- * ```
+ * @param container The scope whose widget tree is formatted.
+ * @param options Formatting options such as truncation length and highlighting.
+ * @returns The formatted representation of the tree.
  */
 export declare const prettyWidget: (container: Container, options?: PrettyWidgetOptions) => string;
+/**
+ * Prints one or more widget trees to the console using {@link prettyWidget}.
+ *
+ * @param container A single scope or an array of scopes to format and print.
+ * @param options Formatting options passed through to {@link prettyWidget}.
+ */
+export declare const logWidget: (container: Container | Container[], options?: PrettyWidgetOptions) => void;
+export {};
 //# sourceMappingURL=pretty-widget.d.ts.map

package/dist/pretty-widget.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pretty-widget.d.ts","sourceRoot":"","sources":["../src/pretty-widget.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,SAAS,EAAiB,MAAM,gBAAgB,CAAC;AAkB/D;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAC9B,8DAA8D;IAC9D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4DAA4D;IAC5D,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,uEAAuE;IACvE,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAqIF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,YAAY,GAAI,WAAW,SAAS,EAAE,UAAS,mBAAwB,KAAG,MAkBtF,CAAC"}
+{"version":3,"file":"pretty-widget.d.ts","sourceRoot":"","sources":["../src/pretty-widget.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,cAAc,CAAC;AAGzC,OAAO,EAAE,KAAK,SAAS,EAAS,MAAM,gBAAgB,CAAC;AAMvD,KAAK,gBAAgB,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,KAAK,MAAM,CAAC;AAEvD;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAC9B,iEAAiE;IACjE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uFAAuF;IACvF,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,0DAA0D;IAC1D,KAAK,CAAC,EAAE,gBAAgB,CAAC;CAC5B,CAAC;AAqGF;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,cAAe,SAAS,YAAW,mBAAmB,KAAQ,MAqBtF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,SAAS,cAAe,SAAS,GAAG,SAAS,EAAE,YAAY,mBAAmB,KAAG,IAK7F,CAAC"}

package/dist/pretty-widget.js

@@ -1,18 +1,34 @@
-import * as Gtk from "@gtkx/ffi/gtk";
+import { sortStringsBy } from "@gtkx/utils";
 import { formatRole } from "./role-helpers.js";
-import { isApplication } from "./traversal.js";
-import { getWidgetPropertyText } from "./widget-text.js";
+import { roots } from "./traversal.js";
+import { getWidgetNodeText } from "./widget-accessible-properties.js";
 const DEFAULT_MAX_LENGTH = 7000;
 const INDENT = "  ";
-const debugIdMap = new WeakMap();
-let nextDebugId = 0;
-const getWidgetDebugId = (widget) => {
-    let id = debugIdMap.get(widget);
-    if (!id) {
-        id = String(nextDebugId++);
-        debugIdMap.set(widget, id);
+const buildAttrs = (widget, getId) => {
+    const attrs = [];
+    if (getId) {
+        attrs.push(["id", getId(widget)]);
+    }
+    const name = widget.getName();
+    if (name) {
+        attrs.push(["name", name]);
+    }
+    attrs.push(["role", formatRole(widget.getAccessibleRole())]);
+    if (!widget.getSensitive()) {
+        attrs.push(["accessible-disabled", "true"]);
+    }
+    if (!widget.getVisible()) {
+        attrs.push(["accessible-hidden", "true"]);
     }
-    return id;
+    const idAttrs = attrs.filter(([key]) => key === "id");
+    const otherAttrs = sortStringsBy(attrs.filter(([key]) => key !== "id"), ([key]) => key);
+    return [...idAttrs, ...otherAttrs];
+};
+const ansi = {
+    cyan: "\x1b[36m",
+    yellow: "\x1b[33m",
+    green: "\x1b[32m",
+    reset: "\x1b[0m",
 };
 const shouldHighlight = () => {
     if (typeof process === "undefined")
@@ -21,141 +37,79 @@ const shouldHighlight = () => {
         return false;
     if (process.env.COLORS === "true" || process.env.FORCE_COLOR)
         return true;
-    return process.stdout?.isTTY ?? false;
-};
-const ansi = {
-    cyan: "\x1b[36m",
-    yellow: "\x1b[33m",
-    green: "\x1b[32m",
-    reset: "\x1b[0m",
+    return process.stdout.isTTY;
 };
 const createColors = (enabled) => {
     if (!enabled) {
         const identity = (s) => s;
-        return { tag: identity, attr: identity, value: identity, text: identity, reset: "" };
+        return { tag: identity, attr: identity, value: identity };
     }
     return {
         tag: (s) => `${ansi.cyan}${s}${ansi.reset}`,
         attr: (s) => `${ansi.yellow}${s}${ansi.reset}`,
         value: (s) => `${ansi.green}${s}${ansi.reset}`,
-        text: (s) => s,
-        reset: ansi.reset,
     };
 };
-const formatTagName = (widget) => {
-    return widget.constructor.name;
-};
-const escapeAttrValue = (value) => {
-    return value.replace(/"/g, """);
-};
-const formatAttributes = (widget, colors, includeIds) => {
-    const attrs = [];
-    if (includeIds) {
-        attrs.push(["id", getWidgetDebugId(widget)]);
-    }
-    const name = widget.getName();
-    if (name) {
-        attrs.push(["data-testid", name]);
-    }
-    const role = widget.getAccessibleRole();
-    if (role !== undefined) {
-        attrs.push(["role", formatRole(role)]);
-    }
-    if (!widget.getSensitive()) {
-        attrs.push(["aria-disabled", "true"]);
-    }
-    if (!widget.getVisible()) {
-        attrs.push(["aria-hidden", "true"]);
-    }
-    if (attrs.length === 0)
-        return "";
-    return attrs
-        .sort(([a], [b]) => {
-        if (a === "id")
-            return -1;
-        if (b === "id")
-            return 1;
-        return a.localeCompare(b);
-    })
-        .map(([key, value]) => ` ${colors.attr(key)}=${colors.value(`"${escapeAttrValue(value)}"`)}`)
-        .join("");
-};
-const hasChildren = (widget) => {
-    return widget.getFirstChild() !== null;
-};
-const printWidget = (widget, colors, depth, includeIds) => {
+const escapeAttrValue = (value) => value.replaceAll('"', """);
+const formatAttrs = (attrs, colors) => attrs.map(([key, value]) => ` ${colors.attr(key)}=${colors.value(`"${escapeAttrValue(value)}"`)}`).join("");
+const formatWidget = (widget, depth, getId, colors) => {
     const indent = INDENT.repeat(depth);
-    const tagName = formatTagName(widget);
-    const attributes = formatAttributes(widget, colors, includeIds);
-    const text = getWidgetPropertyText(widget);
-    const children = [];
-    let child = widget.getFirstChild();
-    while (child) {
-        children.push(printWidget(child, colors, depth + 1, includeIds));
-        child = child.getNextSibling();
-    }
-    const openTag = `${colors.tag("<")}${colors.tag(tagName)}${attributes}${colors.tag(">")}`;
-    if (!hasChildren(widget) && !text) {
+    const tag = widget.constructor.name;
+    const attrs = formatAttrs(buildAttrs(widget, getId), colors);
+    const openTag = `${colors.tag("<")}${colors.tag(tag)}${attrs}${colors.tag(">")}`;
+    const closeTag = `${colors.tag("</")}${colors.tag(tag)}${colors.tag(">")}`;
+    const text = getWidgetNodeText(widget);
+    const firstChild = widget.getFirstChild();
+    if (!text && !firstChild) {
         return `${indent}${openTag}\n`;
     }
-    const closeTag = `${colors.tag("</")}${colors.tag(tagName)}${colors.tag(">")}`;
-    if (text && !hasChildren(widget)) {
-        const textContent = colors.text(text);
-        return `${indent}${openTag}\n${indent}${INDENT}${textContent}\n${indent}${closeTag}\n`;
-    }
-    let result = `${indent}${openTag}\n`;
+    let output = `${indent}${openTag}\n`;
     if (text) {
-        result += `${indent}${INDENT}${colors.text(text)}\n`;
-    }
-    for (const childOutput of children) {
-        result += childOutput;
+        output += `${indent}${INDENT}${text}\n`;
     }
-    result += `${indent}${closeTag}\n`;
-    return result;
-};
-const printContainer = (container, colors, includeIds) => {
-    if (isApplication(container)) {
-        const windows = Gtk.Window.listToplevels();
-        return windows.map((window) => printWidget(window, colors, 0, includeIds)).join("");
+    let child = firstChild;
+    while (child) {
+        output += formatWidget(child, depth + 1, getId, colors);
+        child = child.getNextSibling();
     }
-    return printWidget(container, colors, 0, includeIds);
+    output += `${indent}${closeTag}\n`;
+    return output;
 };
 /**
- * Formats a widget tree as a readable string for debugging.
- *
- * Renders the widget hierarchy in an HTML-like format with accessibility
- * attributes like role, data-testid, and text content.
- *
- * @param container - The container widget or application to format
- * @param options - Formatting options for length and highlighting
- * @returns Formatted string representation of the widget tree
+ * Renders a widget tree as an indented, HTML-like string showing each widget's
+ * tag, accessible attributes, and text content.
  *
- * @example
- * ```tsx
- * import { prettyWidget } from "@gtkx/testing";
- *
- * console.log(prettyWidget(application));
- * // Output:
- * // <GtkApplicationWindow role="window">
- * //   <GtkButton role="button">
- * //     Click me
- * //   </GtkButton>
- * // </GtkApplicationWindow>
- * ```
+ * @param container The scope whose widget tree is formatted.
+ * @param options Formatting options such as truncation length and highlighting.
+ * @returns The formatted representation of the tree.
  */
 export const prettyWidget = (container, options = {}) => {
     const envLimit = process.env.DEBUG_PRINT_LIMIT ? Number(process.env.DEBUG_PRINT_LIMIT) : DEFAULT_MAX_LENGTH;
     const maxLength = options.maxLength ?? envLimit;
-    const highlight = options.highlight ?? shouldHighlight();
-    const includeIds = options.includeIds ?? false;
     if (maxLength === 0) {
         return "";
     }
+    const highlight = options.highlight ?? shouldHighlight();
     const colors = createColors(highlight);
-    const output = printContainer(container, colors, includeIds);
+    let output = "";
+    for (const root of roots(container)) {
+        output += formatWidget(root, 0, options.getId, colors);
+    }
     if (output.length > maxLength) {
         return `${output.slice(0, maxLength)}...`;
     }
     return output.trimEnd();
 };
+/**
+ * Prints one or more widget trees to the console using {@link prettyWidget}.
+ *
+ * @param container A single scope or an array of scopes to format and print.
+ * @param options Formatting options passed through to {@link prettyWidget}.
+ */
+export const logWidget = (container, options) => {
+    const containers = Array.isArray(container) ? container : [container];
+    for (const target of containers) {
+        console.log(prettyWidget(target, options));
+    }
+};
 //# sourceMappingURL=pretty-widget.js.map

package/dist/pretty-widget.js.map

@@ -1 +1 @@
-{"version":3,"file":"pretty-widget.js","sourceRoot":"","sources":["../src/pretty-widget.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,eAAe,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAkB,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/D,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAEzD,MAAM,kBAAkB,GAAG,IAAI,CAAC;AAChC,MAAM,MAAM,GAAG,IAAI,CAAC;AAEpB,MAAM,UAAU,GAAG,IAAI,OAAO,EAAsB,CAAC;AACrD,IAAI,WAAW,GAAG,CAAC,CAAC;AAEpB,MAAM,gBAAgB,GAAG,CAAC,MAAkB,EAAU,EAAE;IACpD,IAAI,EAAE,GAAG,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAChC,IAAI,CAAC,EAAE,EAAE,CAAC;QACN,EAAE,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;QAC3B,UAAU,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC/B,CAAC;IACD,OAAO,EAAE,CAAC;AACd,CAAC,CAAC;AAsBF,MAAM,eAAe,GAAG,GAAY,EAAE;IAClC,IAAI,OAAO,OAAO,KAAK,WAAW;QAAE,OAAO,KAAK,CAAC;IACjD,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,KAAK,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ;QAAE,OAAO,KAAK,CAAC;IACzE,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,KAAK,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW;QAAE,OAAO,IAAI,CAAC;IAC1E,OAAO,OAAO,CAAC,MAAM,EAAE,KAAK,IAAI,KAAK,CAAC;AAC1C,CAAC,CAAC;AAEF,MAAM,IAAI,GAAG;IACT,IAAI,EAAE,UAAU;IAChB,MAAM,EAAE,UAAU;IAClB,KAAK,EAAE,UAAU;IACjB,KAAK,EAAE,SAAS;CACnB,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,OAAgB,EAAmB,EAAE;IACvD,IAAI,CAAC,OAAO,EAAE,CAAC;QACX,MAAM,QAAQ,GAAG,CAAC,CAAS,EAAU,EAAE,CAAC,CAAC,CAAC;QAC1C,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;IACzF,CAAC;IACD,OAAO;QACH,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,EAAE;QAC3C,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,EAAE;QAC9C,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,EAAE;QAC9C,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACd,KAAK,EAAE,IAAI,CAAC,KAAK;KACpB,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,MAAkB,EAAU,EAAE;IACjD,OAAO,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC;AACnC,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,KAAa,EAAU,EAAE;IAC9C,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AACzC,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,MAAkB,EAAE,MAAuB,EAAE,UAAmB,EAAU,EAAE;IAClG,MAAM,KAAK,GAAuB,EAAE,CAAC;IAErC,IAAI,UAAU,EAAE,CAAC;QACb,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACjD,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;IAC9B,IAAI,IAAI,EAAE,CAAC;QACP,KAAK,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,CAAC,iBAAiB,EAAE,CAAC;IACxC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACrB,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,CAAC;QACzB,KAAK,CAAC,IAAI,CAAC,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC;QACvB,KAAK,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC;IACxC,CAAC;IAED,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IAElC,OAAO,KAAK;SACP,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE;QACf,IAAI,CAAC,KAAK,IAAI;YAAE,OAAO,CAAC,CAAC,CAAC;QAC1B,IAAI,CAAC,KAAK,IAAI;YAAE,OAAO,CAAC,CAAC;QACzB,OAAO,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAC9B,CAAC,CAAC;SACD,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;SAC5F,IAAI,CAAC,EAAE,CAAC,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,MAAkB,EAAW,EAAE;IAChD,OAAO,MAAM,CAAC,aAAa,EAAE,KAAK,IAAI,CAAC;AAC3C,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,MAAkB,EAAE,MAAuB,EAAE,KAAa,EAAE,UAAmB,EAAU,EAAE;IAC5G,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACpC,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IACtC,MAAM,UAAU,GAAG,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;IAChE,MAAM,IAAI,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;IAC3C,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,IAAI,KAAK,GAAG,MAAM,CAAC,aAAa,EAAE,CAAC;IACnC,OAAO,KAAK,EAAE,CAAC;QACX,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,GAAG,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC;QACjE,KAAK,GAAG,KAAK,CAAC,cAAc,EAAE,CAAC;IACnC,CAAC;IAED,MAAM,OAAO,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;IAE1F,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QAChC,OAAO,GAAG,MAAM,GAAG,OAAO,IAAI,CAAC;IACnC,CAAC;IAED,MAAM,QAAQ,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;IAE/E,IAAI,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;QAC/B,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtC,OAAO,GAAG,MAAM,GAAG,OAAO,KAAK,MAAM,GAAG,MAAM,GAAG,WAAW,KAAK,MAAM,GAAG,QAAQ,IAAI,CAAC;IAC3F,CAAC;IAED,IAAI,MAAM,GAAG,GAAG,MAAM,GAAG,OAAO,IAAI,CAAC;IACrC,IAAI,IAAI,EAAE,CAAC;QACP,MAAM,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IACzD,CAAC;IACD,KAAK,MAAM,WAAW,IAAI,QAAQ,EAAE,CAAC;QACjC,MAAM,IAAI,WAAW,CAAC;IAC1B,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,GAAG,QAAQ,IAAI,CAAC;IAEnC,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,SAAoB,EAAE,MAAuB,EAAE,UAAmB,EAAU,EAAE;IAClG,IAAI,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;QAC3B,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;QAC3C,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACxF,CAAC;IACD,OAAO,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC;AACzD,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,SAAoB,EAAE,UAA+B,EAAE,EAAU,EAAE;IAC5F,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC;IAC5G,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,QAAQ,CAAC;IAChD,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,eAAe,EAAE,CAAC;IACzD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,KAAK,CAAC;IAE/C,IAAI,SAAS,KAAK,CAAC,EAAE,CAAC;QAClB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,MAAM,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;IACvC,MAAM,MAAM,GAAG,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;IAE7D,IAAI,MAAM,CAAC,MAAM,GAAG,SAAS,EAAE,CAAC;QAC5B,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC;IAC9C,CAAC;IAED,OAAO,MAAM,CAAC,OAAO,EAAE,CAAC;AAC5B,CAAC,CAAC"}
+{"version":3,"file":"pretty-widget.js","sourceRoot":"","sources":["../src/pretty-widget.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAkB,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AAEtE,MAAM,kBAAkB,GAAG,IAAI,CAAC;AAChC,MAAM,MAAM,GAAG,IAAI,CAAC;AAiBpB,MAAM,UAAU,GAAG,CAAC,MAAkB,EAAE,KAAmC,EAAsB,EAAE;IAC/F,MAAM,KAAK,GAAuB,EAAE,CAAC;IAErC,IAAI,KAAK,EAAE,CAAC;QACR,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;IAC9B,IAAI,IAAI,EAAE,CAAC;QACP,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC,CAAC,CAAC,CAAC;IAE7D,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,CAAC;QACzB,KAAK,CAAC,IAAI,CAAC,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC,CAAC;IAChD,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC;QACvB,KAAK,CAAC,IAAI,CAAC,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC;IACtD,MAAM,UAAU,GAAG,aAAa,CAC5B,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,EACrC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CACjB,CAAC;IACF,OAAO,CAAC,GAAG,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;AACvC,CAAC,CAAC;AAQF,MAAM,IAAI,GAAG;IACT,IAAI,EAAE,UAAU;IAChB,MAAM,EAAE,UAAU;IAClB,KAAK,EAAE,UAAU;IACjB,KAAK,EAAE,SAAS;CACnB,CAAC;AAEF,MAAM,eAAe,GAAG,GAAY,EAAE;IAClC,IAAI,OAAO,OAAO,KAAK,WAAW;QAAE,OAAO,KAAK,CAAC;IACjD,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,KAAK,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ;QAAE,OAAO,KAAK,CAAC;IACzE,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,KAAK,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW;QAAE,OAAO,IAAI,CAAC;IAC1E,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;AAChC,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,OAAgB,EAAU,EAAE;IAC9C,IAAI,CAAC,OAAO,EAAE,CAAC;QACX,MAAM,QAAQ,GAAG,CAAC,CAAS,EAAU,EAAE,CAAC,CAAC,CAAC;QAC1C,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;IAC9D,CAAC;IACD,OAAO;QACH,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,EAAE;QAC3C,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,EAAE;QAC9C,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,EAAE;KACjD,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,KAAa,EAAU,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;AAEnF,MAAM,WAAW,GAAG,CAAC,KAAyB,EAAE,MAAc,EAAU,EAAE,CACtE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAEhH,MAAM,YAAY,GAAG,CACjB,MAAkB,EAClB,KAAa,EACb,KAAmC,EACnC,MAAc,EACR,EAAE;IACR,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACpC,MAAM,GAAG,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC;IACpC,MAAM,KAAK,GAAG,WAAW,CAAC,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;IAC7D,MAAM,OAAO,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;IACjF,MAAM,QAAQ,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;IAE3E,MAAM,IAAI,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACvC,MAAM,UAAU,GAAG,MAAM,CAAC,aAAa,EAAE,CAAC;IAE1C,IAAI,CAAC,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;QACvB,OAAO,GAAG,MAAM,GAAG,OAAO,IAAI,CAAC;IACnC,CAAC;IAED,IAAI,MAAM,GAAG,GAAG,MAAM,GAAG,OAAO,IAAI,CAAC;IACrC,IAAI,IAAI,EAAE,CAAC;QACP,MAAM,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,IAAI,CAAC;IAC5C,CAAC;IACD,IAAI,KAAK,GAAG,UAAU,CAAC;IACvB,OAAO,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;QACxD,KAAK,GAAG,KAAK,CAAC,cAAc,EAAE,CAAC;IACnC,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,GAAG,QAAQ,IAAI,CAAC;IACnC,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,SAAoB,EAAE,OAAO,GAAwB,EAAE,EAAU,EAAE;IAC5F,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC;IAC5G,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,QAAQ,CAAC;IAEhD,IAAI,SAAS,KAAK,CAAC,EAAE,CAAC;QAClB,OAAO,EAAE,CAAC;IACd,CAAC;IAED,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,eAAe,EAAE,CAAC;IACzD,MAAM,MAAM,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;IAEvC,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,YAAY,CAAC,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,GAAG,SAAS,EAAE,CAAC;QAC5B,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC;IAC9C,CAAC;IAED,OAAO,MAAM,CAAC,OAAO,EAAE,CAAC;AAC5B,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,SAAkC,EAAE,OAA6B,EAAQ,EAAE;IACjG,MAAM,UAAU,GAAgB,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACnF,KAAK,MAAM,MAAM,IAAI,UAAU,EAAE,CAAC;QAC9B,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAC/C,CAAC;AACL,CAAC,CAAC","sourcesContent":["import type * as Gtk from \"@gtkx/gi/gtk\";\nimport { sortStringsBy } from \"@gtkx/utils\";\nimport { formatRole } from \"./role-helpers.js\";\nimport { type Container, roots } from \"./traversal.js\";\nimport { getWidgetNodeText } from \"./widget-accessible-properties.js\";\n\nconst DEFAULT_MAX_LENGTH = 7000;\nconst INDENT = \"  \";\n\ntype WidgetIdResolver = (widget: Gtk.Widget) => string;\n\n/**\n * Options controlling how a widget tree is rendered to a string by\n * {@link prettyWidget} and {@link logWidget}.\n */\nexport type PrettyWidgetOptions = {\n    /** Truncates the output once it exceeds this many characters. */\n    maxLength?: number;\n    /** Whether to apply ANSI color highlighting; defaults to the terminal capabilities. */\n    highlight?: boolean;\n    /** Resolves an `id` attribute to show for each widget. */\n    getId?: WidgetIdResolver;\n};\n\nconst buildAttrs = (widget: Gtk.Widget, getId: WidgetIdResolver | undefined): [string, string][] => {\n    const attrs: [string, string][] = [];\n\n    if (getId) {\n        attrs.push([\"id\", getId(widget)]);\n    }\n\n    const name = widget.getName();\n    if (name) {\n        attrs.push([\"name\", name]);\n    }\n\n    attrs.push([\"role\", formatRole(widget.getAccessibleRole())]);\n\n    if (!widget.getSensitive()) {\n        attrs.push([\"accessible-disabled\", \"true\"]);\n    }\n\n    if (!widget.getVisible()) {\n        attrs.push([\"accessible-hidden\", \"true\"]);\n    }\n\n    const idAttrs = attrs.filter(([key]) => key === \"id\");\n    const otherAttrs = sortStringsBy(\n        attrs.filter(([key]) => key !== \"id\"),\n        ([key]) => key,\n    );\n    return [...idAttrs, ...otherAttrs];\n};\n\ntype Colors = {\n    tag: (s: string) => string;\n    attr: (s: string) => string;\n    value: (s: string) => string;\n};\n\nconst ansi = {\n    cyan: \"\\x1b[36m\",\n    yellow: \"\\x1b[33m\",\n    green: \"\\x1b[32m\",\n    reset: \"\\x1b[0m\",\n};\n\nconst shouldHighlight = (): boolean => {\n    if (typeof process === \"undefined\") return false;\n    if (process.env.COLORS === \"false\" || process.env.NO_COLOR) return false;\n    if (process.env.COLORS === \"true\" || process.env.FORCE_COLOR) return true;\n    return process.stdout.isTTY;\n};\n\nconst createColors = (enabled: boolean): Colors => {\n    if (!enabled) {\n        const identity = (s: string): string => s;\n        return { tag: identity, attr: identity, value: identity };\n    }\n    return {\n        tag: (s) => `${ansi.cyan}${s}${ansi.reset}`,\n        attr: (s) => `${ansi.yellow}${s}${ansi.reset}`,\n        value: (s) => `${ansi.green}${s}${ansi.reset}`,\n    };\n};\n\nconst escapeAttrValue = (value: string): string => value.replaceAll('\"', \"&quot;\");\n\nconst formatAttrs = (attrs: [string, string][], colors: Colors): string =>\n    attrs.map(([key, value]) => ` ${colors.attr(key)}=${colors.value(`\"${escapeAttrValue(value)}\"`)}`).join(\"\");\n\nconst formatWidget = (\n    widget: Gtk.Widget,\n    depth: number,\n    getId: WidgetIdResolver | undefined,\n    colors: Colors,\n): string => {\n    const indent = INDENT.repeat(depth);\n    const tag = widget.constructor.name;\n    const attrs = formatAttrs(buildAttrs(widget, getId), colors);\n    const openTag = `${colors.tag(\"<\")}${colors.tag(tag)}${attrs}${colors.tag(\">\")}`;\n    const closeTag = `${colors.tag(\"</\")}${colors.tag(tag)}${colors.tag(\">\")}`;\n\n    const text = getWidgetNodeText(widget);\n    const firstChild = widget.getFirstChild();\n\n    if (!text && !firstChild) {\n        return `${indent}${openTag}\\n`;\n    }\n\n    let output = `${indent}${openTag}\\n`;\n    if (text) {\n        output += `${indent}${INDENT}${text}\\n`;\n    }\n    let child = firstChild;\n    while (child) {\n        output += formatWidget(child, depth + 1, getId, colors);\n        child = child.getNextSibling();\n    }\n    output += `${indent}${closeTag}\\n`;\n    return output;\n};\n\n/**\n * Renders a widget tree as an indented, HTML-like string showing each widget's\n * tag, accessible attributes, and text content.\n *\n * @param container The scope whose widget tree is formatted.\n * @param options Formatting options such as truncation length and highlighting.\n * @returns The formatted representation of the tree.\n */\nexport const prettyWidget = (container: Container, options: PrettyWidgetOptions = {}): string => {\n    const envLimit = process.env.DEBUG_PRINT_LIMIT ? Number(process.env.DEBUG_PRINT_LIMIT) : DEFAULT_MAX_LENGTH;\n    const maxLength = options.maxLength ?? envLimit;\n\n    if (maxLength === 0) {\n        return \"\";\n    }\n\n    const highlight = options.highlight ?? shouldHighlight();\n    const colors = createColors(highlight);\n\n    let output = \"\";\n    for (const root of roots(container)) {\n        output += formatWidget(root, 0, options.getId, colors);\n    }\n\n    if (output.length > maxLength) {\n        return `${output.slice(0, maxLength)}...`;\n    }\n\n    return output.trimEnd();\n};\n\n/**\n * Prints one or more widget trees to the console using {@link prettyWidget}.\n *\n * @param container A single scope or an array of scopes to format and print.\n * @param options Formatting options passed through to {@link prettyWidget}.\n */\nexport const logWidget = (container: Container | Container[], options?: PrettyWidgetOptions): void => {\n    const containers: Container[] = Array.isArray(container) ? container : [container];\n    for (const target of containers) {\n        console.log(prettyWidget(target, options));\n    }\n};\n"]}