@describe-me/vitest 0.6.0 → 0.6.1

package/dist/browser-profile.js

@@ -8,6 +8,7 @@ export const browserProfile = {
         },
     },
     setupFile: '@describe-me/vitest/setup',
+    env: {},
     configFor({ renderModule }) {
         return {
             config: {

package/dist/dom-profile.js

@@ -9,16 +9,15 @@ export const domProfile = {
         },
     },
     setupFile: '@describe-me/vitest/setup-dom',
+    // Testing Library would otherwise unmount in its own afterEach, before the
+    // closing frame is taken. The adapter unmounts through the recorder instead.
+    env: { RTL_SKIP_AUTO_CLEANUP: 'true' },
     configFor({ userConfig, options }) {
         const build = options.styledComponentsBrowserBuild === false
             ? undefined
             : styledComponentsBrowserBuild(userConfig.root ?? process.cwd());
         const userTest = userConfig.test;
-        const test = {
-            // Testing Library would otherwise unmount in its own afterEach, before the
-            // closing frame is taken. The adapter unmounts through the recorder instead.
-            env: { RTL_SKIP_AUTO_CLEANUP: 'true' },
-        };
+        const test = {};
         // Vitest stubs CSS imports by default, which would leave every imported
         // stylesheet out of the snapshots. An explicit choice by the user wins.
         if (userTest?.css === undefined) {

package/dist/environment-profile.d.ts

@@ -30,6 +30,12 @@ export interface EnvironmentProfile {
     renderModules: Record<NonNullable<DescribeMeOptions['framework']>, RenderModule>;
     /** The setup file that patches interactions and registers the recording hooks. */
     setupFile: string;
+    /**
+     * Variables the tests of a project with the setup file need. The plugin sets
+     * them per project and never in the root's `test.env`, which Vitest hands to
+     * every project, also to one without describe-me.
+     */
+    env: Record<string, string>;
     /** The rest of the environment's config, built in the plugin's `config` hook. */
     configFor(context: ProfileContext): ProfileConfig;
 }

package/dist/plugin.js

@@ -13,6 +13,7 @@ import { projectModulePath } from './project-module-path.js';
 import { registerExports } from './register-exports.js';
 import DescribeMeReporter from './reporter.js';
 import { RUNTIME_OPTIONS_KEY } from './runtime-options.js';
+import { setUpProject } from './set-up-project.js';
 import { validateRenderFrame } from './validate-render-frame.js';
 /**
  * One-line integration: `plugins: [describeMe()]`.
@@ -32,6 +33,8 @@ export function describeMe(options = {}) {
     // Set by `config()`, which Vite runs before `configResolved` and `resolveId`.
     // Stays null while the plugin is disabled.
     let renderModule = null;
+    // The chosen profile, also set by `config()`, for the projects that skip it.
+    let projectProfile = null;
     // Known once Vite has resolved its config. Vitest always serves; a production
     // build that shares the config must not carry the export registration.
     let root = '';
@@ -59,6 +62,7 @@ export function describeMe(options = {}) {
             const provide = { [RUNTIME_OPTIONS_KEY]: runtimeOptions };
             const profile = await loadProfile(environment);
             renderModule = profile.renderModules[framework];
+            projectProfile = profile;
             const { config, setupWarnings } = profile.configFor({ userConfig, options, renderModule });
             const reporter = new DescribeMeReporter({
                 outDir,
@@ -76,6 +80,13 @@ export function describeMe(options = {}) {
                 test: { setupFiles: [profile.setupFile], ...config.test, reporters, provide },
             };
         },
+        // Runs for every project the plugin's Vite server serves, also those that
+        // share the root's server and so never reach `config()` (see setUpProject).
+        configureVitest({ project }) {
+            if (projectProfile !== null) {
+                setUpProject(project, projectProfile);
+            }
+        },
         async resolveId(source, importer) {
             if (!enabled || renderModule === null || source !== renderModule.original) {
                 return null;

package/dist/set-up-project.d.ts

@@ -0,0 +1,12 @@
+import type { TestProject } from 'vitest/node';
+import type { EnvironmentProfile } from './environment-profile.js';
+/**
+ * Gives a project the profile's setup file, when it lacks it, and the
+ * profile's variables. In Vitest 5 a project that shares the root's Vite
+ * server inherits the root config as it was before the plugin's `config`
+ * hook, so it gets the render redirect but not the setup file, and records
+ * nothing. The file goes last, as in the root config. Only projects with the
+ * setup file get the variables, so one without describe-me keeps Testing
+ * Library's own cleanup.
+ */
+export declare function setUpProject(project: TestProject, profile: EnvironmentProfile): void;

package/dist/set-up-project.js

@@ -0,0 +1,39 @@
+import { realpathSync } from 'node:fs';
+import { createRequire } from 'node:module';
+import { join } from 'node:path';
+function resolveFrom(root, specifier) {
+    try {
+        return createRequire(join(root, 'package.json')).resolve(specifier);
+    }
+    catch {
+        return null;
+    }
+}
+function realPathOf(file) {
+    try {
+        return realpathSync(file);
+    }
+    catch {
+        return file;
+    }
+}
+/**
+ * Gives a project the profile's setup file, when it lacks it, and the
+ * profile's variables. In Vitest 5 a project that shares the root's Vite
+ * server inherits the root config as it was before the plugin's `config`
+ * hook, so it gets the render redirect but not the setup file, and records
+ * nothing. The file goes last, as in the root config. Only projects with the
+ * setup file get the variables, so one without describe-me keeps Testing
+ * Library's own cleanup.
+ */
+export function setUpProject(project, profile) {
+    const file = resolveFrom(project.config.root, profile.setupFile);
+    if (file === null) {
+        return;
+    }
+    const real = realPathOf(file);
+    if (!project.config.setupFiles.some((entry) => realPathOf(entry) === real)) {
+        project.config.setupFiles.push(file);
+    }
+    project.config.env = { ...project.config.env, ...profile.env };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@describe-me/vitest",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "Living component documentation from your Vitest tests: the Vitest plugin, setup files and reporter of describe-me",
   "keywords": [
     "vitest",
@@ -71,13 +71,13 @@
   "dependencies": {
     "picomatch": "^4.0.3",
     "std-env": "^4.0.0",
-    "@describe-me/core": "^0.6.0"
+    "@describe-me/core": "^0.6.1"
   },
   "peerDependencies": {
     "vitest": "^4.0.0 || ^5.0.0",
     "typescript": "^5.0.0 || ^6.0.0",
     "@testing-library/user-event": "^14.0.0",
-    "describe-me": "^0.6.0"
+    "describe-me": "^0.6.1"
   },
   "peerDependenciesMeta": {
     "typescript": {