@gjsify/unit 0.36.0 → 0.37.0

package/lib/types/index.d.ts

@@ -16,6 +16,12 @@ export interface Namespaces {
 export type Callback = () => void | Promise<void>;
 export type Runtime = 'Gjs' | 'Deno' | 'Node.js' | 'Unknown' | 'Browser' | 'Display';
 export declare const print: (...data: any[]) => void;
+/**
+ * Render any value for an assertion failure message WITHOUT throwing.
+ * Template-literal / `+` interpolation throws a TypeError on `symbol` and `bigint`
+ * operands, which would mask the real assertion result, so matchers route operands
+ * through this rather than interpolating them.
+ */
 export declare function formatValue(value: unknown): string;
 type AnyFn = (...args: any[]) => any;
 /** A vitest-style mock function: callable with any args + records `.mock.calls`. */
@@ -84,7 +90,7 @@ export declare const describe: {
     } | number): Promise<void>;
     skip(moduleName: string, _callback?: Callback): Promise<void>;
 };
-/** E.g on('Deno', () {  it(...) }) */
+/** Run `callback` only on the named runtime(s): `on('Deno', () => { it(…) })`. */
 export declare const on: (onRuntime: Runtime | Runtime[], version: string | Callback, callback?: Callback) => Promise<void>;
 export declare const beforeEach: (callback?: Callback) => void;
 export declare const afterEach: (callback?: Callback) => void;
@@ -99,39 +105,9 @@ export declare const it: {
     } | number): Promise<void>;
 };
 /**
- * An EXPECTED failure — a test that asserts the correct behaviour against a
- * defect we cannot fix from here (an upstream bug, a platform gap).
- *
- * This is categorically NOT `it.skip`, and the difference is the whole point:
- *
- * - a skip stops running the code, so it hides forever and nothing ever tells
- *   you the day the bug is fixed;
- * - `it.failing` RUNS the test, tolerates the failure it was told to expect —
- *   and **fails the suite the moment the test starts passing**, because that
- *   means the marker has outlived its cause and must be removed.
- *
- * So it is self-retiring: it keeps the suite honest today without turning the
- * gate off, and it turns itself into a task the moment upstream lands the fix.
- * The assertion is never weakened — the test still asserts the spec-correct
- * behaviour, which is what makes the pass-detection meaningful.
- *
- * `reason` is mandatory and should name the upstream defect and where it is
- * tracked, so the next reader does not have to re-derive why this is here.
- *
- * ```ts
- * await it.failing(
- *     'send/receive empty string',
- *     async () => { … },
- *     'GStreamer webrtcdatachannel sends a zero-length buffer for the ' +
- *         'STRING_EMPTY PPID; RFC 8831 §6.6 requires one zero byte. Not ' +
- *         'reachable from JS — needs an upstream fix.',
- * );
- * ```
- */
-/**
- * Live view of the run counters. Exposed so `it.failing`'s own spec can assert
- * on what the CI gate reads (the counters) instead of scraping printed text —
- * the summary's wording is free to change, its accounting is not.
+ * Live view of the run counters. Exposed so `it.failing`'s own spec can assert on
+ * what the CI gate reads instead of scraping printed text — the summary's wording
+ * is free to change, its accounting is not.
  */
 export declare const getTestCounters: () => {
     overall: number;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@gjsify/unit",
-    "version": "0.36.0",
+    "version": "0.37.0",
     "description": "A BDD-style testing framework for Gjs",
     "module": "lib/esm/index.js",
     "types": "lib/types/index.d.ts",
@@ -49,21 +49,21 @@
     "devDependencies": {
         "@girs/gjs": "^4.1.0",
         "@girs/glib-2.0": "^4.1.0",
-        "@gjsify/cli": "^0.36.0",
+        "@gjsify/cli": "^0.37.0",
         "@types/node": "^25.9.2",
         "typescript": "^6.0.3"
     },
     "dependencies": {
-        "@gjsify/abort-controller": "^0.36.0",
-        "@gjsify/assert": "^0.36.0",
-        "@gjsify/buffer": "^0.36.0",
-        "@gjsify/dom-elements": "^0.36.0",
-        "@gjsify/dom-exception": "^0.36.0",
-        "@gjsify/node-globals": "^0.36.0",
-        "@gjsify/process": "^0.36.0",
-        "@gjsify/utils": "^0.36.0",
-        "@gjsify/web-globals": "^0.36.0",
-        "@gjsify/web-streams": "^0.36.0"
+        "@gjsify/abort-controller": "^0.37.0",
+        "@gjsify/assert": "^0.37.0",
+        "@gjsify/buffer": "^0.37.0",
+        "@gjsify/dom-elements": "^0.37.0",
+        "@gjsify/dom-exception": "^0.37.0",
+        "@gjsify/node-globals": "^0.37.0",
+        "@gjsify/process": "^0.37.0",
+        "@gjsify/utils": "^0.37.0",
+        "@gjsify/web-globals": "^0.37.0",
+        "@gjsify/web-streams": "^0.37.0"
     },
     "gjsify": {
         "tier": 1