@describe-me/vitest 0.2.0 → 0.4.0

package/dist/snapshot-store.d.ts

@@ -5,8 +5,8 @@
 export declare class SnapshotStore {
     private readonly dir;
     constructor(outDir: string);
-    /** Write one snapshot and return its path relative to the manifest. */
-    write(snapshot: unknown): string;
+    /** Write one serialized snapshot and return its path relative to the manifest. */
+    write(json: string): string;
     /** Drop the files no manifest frame points at any more. */
     collectGarbage(referenced: Iterable<string>): void;
 }

package/dist/snapshot-store.js

@@ -11,9 +11,8 @@ export class SnapshotStore {
         this.dir = join(outDir, 'snapshots');
         mkdirSync(this.dir, { recursive: true });
     }
-    /** Write one snapshot and return its path relative to the manifest. */
-    write(snapshot) {
-        const json = JSON.stringify(snapshot);
+    /** Write one serialized snapshot and return its path relative to the manifest. */
+    write(json) {
         const hash = createHash('sha1').update(json).digest('hex').slice(0, 16);
         const file = `${hash}.json`;
         const abs = join(this.dir, file);

package/dist/styled-components-browser-build.d.ts

@@ -0,0 +1,15 @@
+import type { ViteUserConfig } from 'vitest/config';
+/**
+ * The Vite and Vitest config that makes a DOM environment load the browser
+ * build of styled-components, or undefined when the project does not use
+ * styled-components 5 or later.
+ *
+ * Vitest resolves the Node build, whose `createGlobalStyle` never inserts its
+ * CSS on the client, so global resets and fonts would be missing from every
+ * snapshot. The alias points `styled-components` at the browser ESM file. The
+ * optimizer is needed as well: jest-styled-components `require`s
+ * styled-components through Node, which ignores the alias, and would get a
+ * second instance whose styles its serializer cannot see. Bundling both
+ * together gives them one.
+ */
+export declare function styledComponentsBrowserBuild(root: string): ViteUserConfig | undefined;

package/dist/styled-components-browser-build.js

@@ -0,0 +1,69 @@
+import { existsSync, readFileSync } from 'node:fs';
+import { createRequire } from 'node:module';
+import { dirname, join, resolve } from 'node:path';
+function resolverFor(root) {
+    // createRequire wants an absolute file inside the directory; it does not have to exist.
+    const requireFromRoot = createRequire(join(resolve(root), 'package.json'));
+    return (id) => {
+        try {
+            return requireFromRoot.resolve(id);
+        }
+        catch {
+            return undefined;
+        }
+    };
+}
+function withoutDotSlash(path) {
+    return path.replace(/^\.\//, '');
+}
+/** The file the package's `browser` map swaps its `module` entry for, relative to the package. */
+function browserModule(pkg) {
+    if (!pkg.module || !pkg.browser || typeof pkg.browser === 'string') {
+        return undefined;
+    }
+    const moduleEntry = withoutDotSlash(pkg.module);
+    for (const [from, to] of Object.entries(pkg.browser)) {
+        if (withoutDotSlash(from) === moduleEntry && typeof to === 'string') {
+            return to;
+        }
+    }
+    return undefined;
+}
+/**
+ * The Vite and Vitest config that makes a DOM environment load the browser
+ * build of styled-components, or undefined when the project does not use
+ * styled-components 5 or later.
+ *
+ * Vitest resolves the Node build, whose `createGlobalStyle` never inserts its
+ * CSS on the client, so global resets and fonts would be missing from every
+ * snapshot. The alias points `styled-components` at the browser ESM file. The
+ * optimizer is needed as well: jest-styled-components `require`s
+ * styled-components through Node, which ignores the alias, and would get a
+ * second instance whose styles its serializer cannot see. Bundling both
+ * together gives them one.
+ */
+export function styledComponentsBrowserBuild(root) {
+    const resolveFromRoot = resolverFor(root);
+    const manifest = resolveFromRoot('styled-components/package.json');
+    if (!manifest) {
+        return undefined;
+    }
+    const pkg = JSON.parse(readFileSync(manifest, 'utf8'));
+    const major = Number.parseInt(pkg.version ?? '', 10);
+    const browserFile = browserModule(pkg);
+    if (Number.isNaN(major) || major < 5 || !browserFile) {
+        return undefined;
+    }
+    const replacement = join(dirname(manifest), browserFile);
+    if (!existsSync(replacement)) {
+        return undefined;
+    }
+    const include = ['styled-components'];
+    if (resolveFromRoot('jest-styled-components')) {
+        include.push('jest-styled-components');
+    }
+    return {
+        resolve: { alias: [{ find: /^styled-components$/, replacement }] },
+        test: { deps: { optimizer: { client: { enabled: true, include } } } },
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@describe-me/vitest",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Vitest integration for describe-me: plugin, setup file and reporter",
   "keywords": [
     "vitest",
@@ -35,6 +35,10 @@
       "types": "./dist/setup.d.ts",
       "default": "./dist/setup.js"
     },
+    "./setup-dom": {
+      "types": "./dist/setup-dom.d.ts",
+      "default": "./dist/setup-dom.js"
+    },
     "./reporter": {
       "types": "./dist/reporter.d.ts",
       "default": "./dist/reporter.js"
@@ -50,24 +54,31 @@
     "LICENSE"
   ],
   "sideEffects": [
-    "./dist/setup.js"
+    "./dist/setup.js",
+    "./dist/setup-dom.js"
   ],
   "dependencies": {
-    "@describe-me/core": "^0.2.0"
+    "@describe-me/core": "^0.4.0"
   },
   "peerDependencies": {
     "vitest": ">=4",
-    "typescript": ">=5.0"
+    "typescript": ">=5.0",
+    "@testing-library/user-event": ">=14"
   },
   "peerDependenciesMeta": {
     "typescript": {
       "optional": true
+    },
+    "@testing-library/user-event": {
+      "optional": true
     }
   },
   "devDependencies": {
     "vitest": "^5.0.1",
     "@types/node": "^22",
-    "typescript": "^6"
+    "typescript": "^6",
+    "@testing-library/user-event": "^14.6.1",
+    "@testing-library/dom": "^10.4.0"
   },
   "scripts": {
     "build": "rimraf dist && tsc -p tsconfig.json"