@forgebook/testing 0.2.0 → 0.2.2

package/README.md

@@ -149,6 +149,9 @@ export default defineConfig({
 });
 ```
 
+The plugin keeps a module that imports story files out of Vitest's module cache (`fsModuleCache`), as a group must be
+listed anew on each run; every other module stays cached.
+
 `storyServerTests` also takes `wrap`: a second pass with every story inside a decorator (a provider with a partial
 translation catalogue), its HTML checked.
 

package/dist/src/browserTests.js

@@ -65,17 +65,18 @@ export const STORY_VARIANTS = storyVariants(DEFAULT_SWITCHES);
 /** A problem list's messages, so a failing test names each problem. */
 const messages = (problems) => problems.map((problem) => problem.message);
 /**
- * Runs the checks of one planned test on a shown story: axe, then for a story about its looks the spills, the
- * source's own check, and the overlays last (it resizes the window, which may close what the story left open). A story
- * about logic gets axe only.
+ * Runs the checks of one planned test on a shown story: axe (unless the catalogue checks no accessibility), then for a
+ * story about its looks the spills, the source's own check, and the overlays last (it resizes the window, which may
+ * close what the story left open). A story about logic gets axe only.
  *
  * @param page - the story's frame, ready.
  * @param planned - the story, its variant and whether its layout is checked.
- * @param a11y - the catalogue's accessibility rules.
+ * @param a11y - the catalogue's accessibility rules; none when it checks no accessibility (`a11y: false`).
  * @param check - the source's own check, if any.
  */
 const expectChecksPass = async (page, planned, a11y, check) => {
-    expect(messages(await axeProblems(page, a11y))).toEqual([]);
+    if (a11y !== undefined)
+        expect(messages(await axeProblems(page, a11y))).toEqual([]);
     if (!planned.hasLookChecks)
         return;
     expect(messages(await spillProblems(page))).toEqual([]);

package/dist/src/checkPage.js

@@ -31,7 +31,7 @@ const checkedPage = async (address, open, a11y) => {
             return result([{ kind: "frame", message: `It answered ${response.status()}` }]);
         }
         return result([
-            ...(await axeProblems(page, a11y)),
+            ...(a11y === undefined ? [] : await axeProblems(page, a11y)),
             ...(await spillProblems(page, "body")),
             ...(await focusProblems(page)),
             ...errorProblems(errors)
@@ -60,7 +60,7 @@ export const checkPages = async ({ addresses, lists }) => {
         for (const address of addresses) {
             results.push(await checkedPage(address, () => context.newPage(), a11y));
         }
-        return { schema: 1, results };
+        return { schema: 1, results, ...(a11y === undefined ? { a11y: "off" } : {}) };
     }
     finally {
         await browser.close();

package/dist/src/checkStories.js

@@ -9,7 +9,7 @@ import { hasLookChecks } from "./storyTestPlan.js";
  *
  * @param page - a fresh page.
  * @param storyPage - the story and the view.
- * @param a11y - the catalogue's accessibility settings.
+ * @param a11y - the catalogue's accessibility settings; none when it checks no accessibility (`a11y: false`).
  */
 const checkedPage = async (page, storyPage, a11y, semantic) => {
     const errors = watchedErrors(page);
@@ -35,7 +35,7 @@ const checkedPage = async (page, storyPage, a11y, semantic) => {
             ...(await overlayProblems(page, isOverlayChecked(storyPage.view), storyPage.story.height))
         ]
         : [];
-    const axe = await axeProblems(page, a11y);
+    const axe = a11y === undefined ? [] : await axeProblems(page, a11y);
     const checked = result([...axe, ...lookProblems, ...(await focusProblems(page)), ...errorProblems(errors)]);
     return semantic === undefined
         ? checked
@@ -50,5 +50,5 @@ const checkedPage = async (page, storyPage, a11y, semantic) => {
 export const checkStories = async (request) => {
     const { a11y } = catalogueSettings("", request.switches, request.lists);
     const results = await eachStoryPage(request, (page, storyPage) => checkedPage(page, storyPage, a11y, request.semantic));
-    return { schema: 1, results };
+    return { schema: 1, results, ...(a11y === undefined ? { a11y: "off" } : {}) };
 };

package/dist/src/storyFiles.d.ts

@@ -1,3 +1,14 @@
+/**
+ * A package's story files and their index, read from the disk: what a test runner that does not go through Vite
+ * (Playwright) needs to declare one test per story.
+ *
+ * @remarks
+ * A `StorySource` names its files with `?forgebook-files` imports, which only the catalogue's Vite plugin answers; this
+ * reads the same files from the same patterns, with the plugin's static index. A package keeps the two lists equal with
+ * `storyFilesMismatch`, run in Vitest, which goes through Vite.
+ *
+ * @module
+ */
 import type { StorySource } from "@forgebook/story-format/source";
 /** Where a package's story files are. */
 export type StoryFilesOptions = {
@@ -7,20 +18,24 @@ export type StoryFilesOptions = {
     readonly name: string;
     /** The folder the patterns are relative to: the folder of the module that declares the source. */
     readonly root: string;
-    /** The same patterns as the source's `?forgebook-files` imports, relative to `root` (`../src/**\/*.stories.tsx`). */
+    /**
+     * The same patterns as the source's `?forgebook-files` imports, relative to `root` (`../src/**\/*.stories.tsx`), or
+     * the catalogue's `stories`: a `!` pattern leaves out what it matches from what the others list.
+     */
     readonly patterns: readonly string[];
 };
 /**
- * The story files the patterns match, as the source's keys (`./x` or `../x`, relative to `root`), sorted.
+ * The story files the patterns list, as the source's keys (`./x` or `../x`, relative to `root`), each once, sorted.
  *
  * @param options - where the files are.
+ * @throws When every pattern is a `!` one: they leave files out, and nothing lists any.
  */
 export declare const storyFiles: (options: StoryFilesOptions) => string[];
 /**
  * A source with its index read from the disk and no loaders: enough for the story tree, the ids and the tests.
  *
  * @param options - where the files are.
- * @throws When a story file cannot be indexed.
+ * @throws When a story file cannot be indexed, or every pattern is a `!` one.
  */
 export declare const indexedSource: (options: StoryFilesOptions) => StorySource;
 /**

package/dist/src/storyFiles.js

@@ -1,44 +1,22 @@
-/**
- * A package's story files and their index, read from the disk: what a test runner that does not go through Vite
- * (Playwright) needs to declare one test per story.
- *
- * @remarks
- * A `StorySource` names its files with `?forgebook-files` imports, which only the catalogue's Vite plugin answers; this
- * reads the same files from the same patterns, with the plugin's static index. A package keeps the two lists equal with
- * `storyFilesMismatch`, run in Vitest, which goes through Vite.
- *
- * @module
- */
-import { readFileSync } from "node:fs";
-import { join } from "node:path";
 import { sourceFiles } from "forgebook/source-files";
-import { autoTitle, patternBase } from "forgebook/vite/auto-title";
-import { indexStoryFile } from "forgebook/vite/index-story-file";
-import { storyFileKeys } from "forgebook/vite/story-files-module";
+import { indexedStoryFiles, storyFileKeys } from "forgebook/vite/story-files-module";
 /**
- * The story files the patterns match, as the source's keys (`./x` or `../x`, relative to `root`), sorted.
+ * The story files the patterns list, as the source's keys (`./x` or `../x`, relative to `root`), each once, sorted.
  *
  * @param options - where the files are.
+ * @throws When every pattern is a `!` one: they leave files out, and nothing lists any.
  */
 export const storyFiles = (options) => storyFileKeys(options.root, options.patterns);
 /**
  * A source with its index read from the disk and no loaders: enough for the story tree, the ids and the tests.
  *
  * @param options - where the files are.
- * @throws When a story file cannot be indexed.
+ * @throws When a story file cannot be indexed, or every pattern is a `!` one.
  */
 export const indexedSource = (options) => {
-    const index = {};
-    for (const file of storyFiles(options)) {
-        // the title the plugin gives: from the first pattern that matches the file, as each pattern is one module
-        const pattern = options.patterns.find((candidate) => storyFileKeys(options.root, [candidate]).includes(file));
-        const title = pattern === undefined ? undefined : autoTitle(patternBase(pattern), file);
-        const text = readFileSync(join(options.root, file), "utf8");
-        const entry = indexStoryFile(file, text, title === undefined ? {} : { autoTitle: title });
-        if (typeof entry === "string")
-            throw new Error(entry);
-        index[file] = entry;
-    }
+    // indexed as the plugin indexes them: a file's title from the first pattern that lists it
+    const files = indexedStoryFiles(options.root, options.patterns, () => undefined);
+    const index = Object.fromEntries(files.map((file) => [file.key, file.index]));
     return {
         id: options.sourceId,
         name: options.name,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forgebook/testing",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Tests from a package's stories: each story and variant in the browser with axe, spills and overlays, screenshots, and each story rendered on the server.",
   "license": "MIT",
   "repository": {
@@ -80,13 +80,13 @@
   "dependencies": {
     "@axe-core/playwright": "4.14.0",
     "@ensiria/cli-kit": "^0.1.1",
-    "@forgebook/story-format": "0.2.0"
+    "@forgebook/story-format": "0.2.2"
   },
   "peerDependencies": {
     "@playwright/test": "^1.64.0",
     "vite": "^8.0.0",
     "vitest": "^5.0.0",
-    "forgebook": "^0.2.0"
+    "forgebook": "^0.3.1"
   },
   "devDependencies": {
     "@playwright/test": "1.64.1",
@@ -97,7 +97,7 @@
     "vitest": "5.0.5",
     "@forgebook/tools": "0.0.0",
     "@forgebook/typescript-config": "0.0.0",
-    "forgebook": "0.2.0"
+    "forgebook": "0.3.1"
   },
   "publishConfig": {
     "access": "public"