@describe-me/core 0.5.0-next.2 → 0.5.0

package/dist/manifest-diagnostics.d.ts

@@ -1,7 +1,8 @@
 import { type Manifest, type ManifestDiagnostics } from './types.js';
 /**
  * List what the manifest could not document: anonymous components, named ones
- * without props, and assets that will not load. The reporter prints it after a
+ * without props, assets that will not load, font families that nothing loads
+ * and hosts that frames load stylesheets from. The reporter prints it after a
  * run and the viewer shows it in the header, so both agree on what is missing.
  */
 export declare function manifestDiagnostics(manifest: Manifest): ManifestDiagnostics;

package/dist/manifest-diagnostics.js

@@ -5,7 +5,8 @@ function isHostElement(name) {
 }
 /**
  * List what the manifest could not document: anonymous components, named ones
- * without props, and assets that will not load. The reporter prints it after a
+ * without props, assets that will not load, font families that nothing loads
+ * and hosts that frames load stylesheets from. The reporter prints it after a
  * run and the viewer shows it in the header, so both agree on what is missing.
  */
 export function manifestDiagnostics(manifest) {
@@ -30,5 +31,7 @@ export function manifestDiagnostics(manifest) {
         anonymous,
         undocumented: Array.from(undocumented, ([name, tests]) => ({ name, tests })).sort((left, right) => left.name.localeCompare(right.name)),
         assetsMissing: manifest.assetsMissing ?? [],
+        fontsMissing: manifest.fontsMissing ?? [],
+        remoteStylesheets: manifest.remoteStylesheets ?? [],
     };
 }

package/dist/recorder.d.ts

@@ -1,4 +1,4 @@
-import type { CaptureOptions, ComponentInfo, FrameKind, RecorderOptions, TestRecord } from './types.js';
+import { type CaptureOptions, type ComponentInfo, type FrameKind, type RecorderOptions, type TestRecord } from './types.js';
 type Teardown = () => void;
 /**
  * Test-side recorder, running wherever the tests run: the browser-mode iframe
@@ -31,6 +31,10 @@ declare class Recorder {
      * selector throws.
      */
     configure(options: RecorderOptions): void;
+    /**
+     * Name the component the test documents. The first name stays, unless it is
+     * `Anonymous` and `info` is not, or it has no `file` and `info` has one.
+     */
     setComponent(info: ComponentInfo): void;
     capture(kind: FrameKind, label: string, meta?: Record<string, unknown>, options?: CaptureOptions): Promise<void>;
     /**

package/dist/recorder.js

@@ -4,6 +4,7 @@ import { PendingRender } from './pending-render.js';
 import { realTimers } from './real-timers.js';
 import { serializeDocument } from './serialize-document.js';
 import { settle } from './settle.js';
+import { ANONYMOUS_COMPONENT, } from './types.js';
 /** Fails in the setup file rather than in the first test that renders. */
 function assertValidSelector(selector) {
     if (typeof document === 'undefined') {
@@ -69,8 +70,15 @@ class Recorder {
         }
         this.renderFrame = renderFrame;
     }
+    /**
+     * Name the component the test documents. The first name stays, unless it is
+     * `Anonymous` and `info` is not, or it has no `file` and `info` has one.
+     */
     setComponent(info) {
-        if (!this.component) {
+        const current = this.component;
+        const addsFile = current?.file === undefined && info.file !== undefined;
+        const namesAnonymous = current?.name === ANONYMOUS_COMPONENT && info.name !== ANONYMOUS_COMPONENT;
+        if (!current || namesAnonymous || addsFile) {
             this.component = info;
         }
     }

package/dist/types.d.ts

@@ -105,7 +105,14 @@ export interface ManifestFrame {
     snapshot: string;
 }
 export interface ManifestTest {
+    /**
+     * Stable across runs and machines: the first 12 hex characters of a SHA-1 of
+     * the module path, the suite path, the name and, for a repeated name, its
+     * occurrence. Before 0.5 it was Vitest's id.
+     */
     id: string;
+    /** Vitest's `TestCase.id` in the run that recorded the test. Absent in manifests written before 0.5. */
+    vitestId?: string;
     name: string;
     /** suite names from outermost to innermost */
     path: string[];
@@ -169,6 +176,32 @@ export interface Manifest {
      * Absent when `previewHead` is not set.
      */
     head?: string;
+    /**
+     * Font families that frames use but nothing loads, most tests first. Absent
+     * in manifests written before 0.5, which counts as empty.
+     */
+    fontsMissing?: FontMissing[];
+    /**
+     * Hosts that frames load stylesheets from, most frames first. Absent in
+     * manifests written before 0.5, which counts as empty.
+     */
+    remoteStylesheets?: RemoteStylesheet[];
+}
+/** A font family that the captured CSS uses but no `@font-face`, font stylesheet or preview head loads. */
+export interface FontMissing {
+    /** The family as first spelled in manifest order. */
+    family: string;
+    /** Tests with at least one frame that misses it. */
+    tests: number;
+    /** `ManifestTest.id` of the first such test, in manifest order. */
+    testId: string;
+}
+/** A host that frames load stylesheets from, which the viewer fetches from the network. */
+export interface RemoteStylesheet {
+    /** The URL's hostname. */
+    host: string;
+    /** Frames that link or import at least one stylesheet from it. */
+    frames: number;
 }
 /** The name adapters fall back to when a component has no usable name. */
 export declare const ANONYMOUS_COMPONENT: "Anonymous";
@@ -186,4 +219,8 @@ export interface ManifestDiagnostics {
     }[];
     /** Asset paths that will not load in the viewer, root-relative or in the `/@fs/` form. */
     assetsMissing: string[];
+    /** Font families that frames use but nothing loads. */
+    fontsMissing: FontMissing[];
+    /** Hosts that frames load stylesheets from. */
+    remoteStylesheets: RemoteStylesheet[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@describe-me/core",
-  "version": "0.5.0-next.2",
+  "version": "0.5.0",
   "description": "Recorder and manifest types for describe-me: living component docs from your tests",
   "keywords": [
     "vitest",