@crvy/strybk 0.0.1 → 0.0.3

package/CHANGELOG.md

@@ -5,4 +5,51 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.0.3] - 2026-06-18
+
+### Added
+
+- Match stories by importPath and resolve globs via configDir
+## [0.0.2] - 2026-06-11
+## [0.0.1] - 2026-06-11
+
+### Added
+
+- Add lean config and generator core
+- Support creevey skip metadata extraction
+- Add Storybook channel driver and switchStory helper
+- Add shared-page Playwright fixtures
+- Add strybk CLI
+- Simplify generated spec imports to use @crvy/strybk directly
+
+### Documentation
+
+- Correct Yarn 4 local link instructions
+- Add minimal config example and improve fetch error message
+
+### Fixed
+
+- Default generated region marker in renderer
+- Harden creevey metadata filtering
+- Support meta-level creevey skip
+- Harden Storybook channel driver
+- Keep switch timeout through font readiness
+- Preserve sharedPage fixture typing
+- Hide internal worker page fixture
+- Preserve built-in playwright fixture types
+- Harden linked playwright runtime and generation
+
+### Miscellaneous
+
+- Bootstrap strybk package
+- Align strybk bootstrap with plan
+- Fix strybk bin entry
+- Make strybk bootstrap manifest honest
+- Tighten strybk bootstrap packaging
+- Ignore strybk build artifacts
+- Sync strybk lockfile
+- Build strybk before packing
+- Sync current workspace
+- Align publish setup with crvy-rprtr
+- Bump version to 0.0.1 and update bin field format
 ## [Unreleased]

package/README.md

@@ -25,17 +25,29 @@ bun run check
 Generate screenshot specs from a Storybook index:
 
 ```sh
-strybk generate --config ./strybk.config.ts
+crvy-strybk generate --config ./strybk.config.ts
 ```
 
 Use `--dry-run` to compute outputs without writing files:
 
 ```sh
-strybk generate --config ./strybk.config.ts --dry-run
+crvy-strybk generate --config ./strybk.config.ts --dry-run
 ```
 
 The config module should export a `StrybkConfig` object, typically as the default export from `defineConfig(...)`.
 
+Minimal `strybk.config.ts`:
+
+```ts
+import { defineConfig } from "@crvy/strybk";
+
+export default defineConfig({
+  storybookUrl: "http://localhost:6006",
+  storyGlobs: ["src/**/*.stories.tsx"],
+  resolveSpecPath: ({ storyFilePath }) => storyFilePath.replace(/\.stories\.tsx$/, ".spec.ts"),
+});
+```
+
 ## Changelog
 
 Preview the next changelog entry:
@@ -69,7 +81,7 @@ Link it into the consumer project:
 
 ```sh
 cd /path/to/consumer-project
-bun link strybk
+bun link @crvy/strybk
 ```
 
 If you want to persist the link in the consumer's manifest, Bun supports a `link:` dependency entry:
@@ -77,7 +89,7 @@ If you want to persist the link in the consumer's manifest, Bun supports a `link
 ```json
 {
   "dependencies": {
-    "strybk": "link:strybk"
+    "@crvy/strybk": "link:strybk"
   }
 }
 ```

package/dist/src/cli.js

@@ -32,8 +32,7 @@ const resolveConfigExport = (moduleNamespace) => {
 const isStrybkConfig = (value) => isRecord(value) &&
     typeof value.storybookUrl === "string" &&
     Array.isArray(value.storyGlobs) &&
-    typeof value.resolveSpecPath === "function" &&
-    typeof value.resolveHarnessImports === "function";
+    typeof value.resolveSpecPath === "function";
 const getIndexEntriesRecord = (payload) => {
     if (!isRecord(payload)) {
         throw new Error("Storybook index response must be an object");
@@ -54,14 +53,15 @@ const toStoryIndexEntry = (value) => {
     }
     if (typeof value.id !== "string" ||
         typeof value.title !== "string" ||
-        typeof value.name !== "string") {
+        typeof value.name !== "string" ||
+        typeof value.importPath !== "string") {
         return null;
     }
     return {
         id: value.id,
         title: value.title,
         name: value.name,
-        importPath: typeof value.importPath === "string" ? value.importPath : undefined,
+        importPath: value.importPath,
         exportName: typeof value.exportName === "string" ? value.exportName : undefined,
     };
 };
@@ -77,9 +77,15 @@ const loadConfig = async (configPath) => {
 };
 const fetchStoryIndex = async (config) => {
     const indexUrl = resolveStorybookIndexUrl(config.storybookUrl);
-    const response = await fetch(indexUrl);
+    let response;
+    try {
+        response = await fetch(indexUrl);
+    }
+    catch (error) {
+        throw new Error(`Failed to fetch Storybook index at ${indexUrl.toString()} — is Storybook running?`, { cause: error });
+    }
     if (!response.ok) {
-        throw new Error(`Failed to fetch ${indexUrl.toString()}: ${response.status} ${response.statusText}`.trim());
+        throw new Error(`Failed to fetch Storybook index at ${indexUrl.toString()}: ${response.status} ${response.statusText}`.trim());
     }
     const payload = asUnknown(await response.json());
     const entries = getIndexEntriesRecord(payload);
@@ -139,6 +145,7 @@ export async function runCli(argv) {
     const indexEntries = await fetchStoryIndex(config);
     const outputs = await generateScreenshots({
         config,
+        configDir: dirname(resolve(cliArgs.configPath)),
         indexEntries,
         readExistingFile,
     });

package/dist/src/config.d.ts

@@ -7,12 +7,6 @@ export interface StrybkConfig {
     resolveSpecPath: (args: {
         storyFilePath: string;
     }) => string;
-    resolveHarnessImports: (args: {
-        outputPath: string;
-    }) => {
-        fixturesImport: string;
-        switchStoryImport: string;
-    };
     generatedRegionName?: string;
     deleteOrphans?: boolean;
     metadataExtractors?: "creevey"[];

package/dist/src/generate/discover.d.ts

@@ -1,5 +1,6 @@
 export interface StoryFile {
     filePath: string;
-    title: string;
 }
-export declare function discoverStoryFiles(patterns: string[]): Promise<StoryFile[]>;
+export declare function discoverStoryFiles(patterns: string[], options?: {
+    cwd?: string;
+}): Promise<StoryFile[]>;

package/dist/src/generate/discover.js

@@ -1,13 +1,6 @@
-import { readFileSync } from "node:fs";
 import { glob } from "glob";
-export async function discoverStoryFiles(patterns) {
-    const files = await glob(patterns, { absolute: true });
-    return files.flatMap((filePath) => {
-        const content = readFileSync(filePath, "utf8");
-        const titleMatch = content.match(/title:\s*['"]([^'"]+)['"]/u);
-        if (!titleMatch) {
-            return [];
-        }
-        return [{ filePath, title: titleMatch[1] }];
-    });
+export async function discoverStoryFiles(patterns, options = {}) {
+    const cwd = options.cwd ?? process.cwd();
+    const files = await glob(patterns, { absolute: true, cwd });
+    return files.map((filePath) => ({ filePath }));
 }

package/dist/src/generate/index.d.ts

@@ -3,13 +3,14 @@ export interface StoryIndexEntry {
     id: string;
     title: string;
     name: string;
-    importPath?: string;
+    importPath: string;
     exportName?: string;
 }
 export declare function generateScreenshots(args: {
     config: StrybkConfig;
     indexEntries: StoryIndexEntry[];
     readExistingFile?: (filePath: string) => string | null;
+    configDir?: string;
 }): Promise<Array<{
     outputPath: string;
     content: string;

package/dist/src/generate/index.js

@@ -2,6 +2,16 @@ import { readFileSync } from "node:fs";
 import { discoverStoryFiles } from "./discover.js";
 import { extractCreeveyMetadata, FILE_POLICY_KEY } from "./metadata.js";
 import { renderScreenshotSpec } from "./render.js";
+const normalizePath = (value) => value.replace(/\\/gu, "/").replace(/^\.\//u, "");
+const matchesByImportPath = (filePath, importPath) => {
+    const normalizedImport = normalizePath(importPath);
+    const normalizedFile = normalizePath(filePath);
+    return normalizedFile === normalizedImport || normalizedFile.endsWith(`/${normalizedImport}`);
+};
+const resolveStoryTitle = (storyFile, indexEntries) => {
+    const pathMatch = indexEntries.find((entry) => matchesByImportPath(storyFile.filePath, entry.importPath));
+    return pathMatch?.title ?? null;
+};
 const escapeForRegExp = (value) => value.replace(/[.*+?^${}()|[\]\\]/gu, "\\$&");
 const toStoryIdSegment = (value) => value
     .replace(/([a-z0-9])([A-Z])/gu, "$1-$2")
@@ -16,12 +26,16 @@ const isStorySkipped = (story, storyMetadata) => {
     return Object.entries(storyMetadata).some(([exportName, policy]) => policy.skip === true && toStoryIdSegment(exportName) === storyIdSegment);
 };
 export async function generateScreenshots(args) {
-    const storyFiles = await discoverStoryFiles(args.config.storyGlobs);
+    const storyFiles = await discoverStoryFiles(args.config.storyGlobs, args.configDir === undefined ? {} : { cwd: args.configDir });
     const generatedRegionName = args.config.generatedRegionName ?? "auto-screenshots";
     const manualRegionPattern = new RegExp(`// @generated-end ${escapeForRegExp(generatedRegionName)}\\s*([\\s\\S]*)$`, "u");
     const shouldExtractCreeveyMetadata = args.config.metadataExtractors?.includes("creevey") ?? false;
     return storyFiles.flatMap((storyFile) => {
-        const stories = args.indexEntries.filter((entry) => entry.title === storyFile.title);
+        const title = resolveStoryTitle(storyFile, args.indexEntries);
+        if (title === null) {
+            return [];
+        }
+        const stories = args.indexEntries.filter((entry) => entry.title === title);
         const storyMetadata = shouldExtractCreeveyMetadata
             ? extractCreeveyMetadata(readFileSync(storyFile.filePath, "utf8"))
             : {};
@@ -35,15 +49,12 @@ export async function generateScreenshots(args) {
         if (filteredStories.length === 0 && manualRegion.length === 0) {
             return [];
         }
-        const harnessImports = args.config.resolveHarnessImports({ outputPath });
         return [
             {
                 outputPath,
                 content: renderScreenshotSpec({
                     config: args.config,
-                    fixturesImport: harnessImports.fixturesImport,
-                    switchStoryImport: harnessImports.switchStoryImport,
-                    title: storyFile.title,
+                    title,
                     stories: filteredStories,
                     manualRegion,
                 }),

package/dist/src/generate/render.d.ts

@@ -5,8 +5,6 @@ export interface RenderableStory {
 }
 export declare function renderScreenshotSpec(args: {
     config: StrybkConfig;
-    fixturesImport: string;
-    switchStoryImport: string;
     title: string;
     stories: RenderableStory[];
     manualRegion: string;

package/dist/src/generate/render.js

@@ -4,5 +4,5 @@ export function renderScreenshotSpec(args) {
     const tests = args.stories
         .map((story) => `  test('${escapeSingleQuotes(story.name)}', async ({ sharedPage }) => {\n    await switchStory(sharedPage, '${story.id}');\n    await expect(sharedPage).toHaveScreenshot();\n  });`)
         .join("\n\n");
-    return `import { test, expect } from '${args.fixturesImport}';\nimport { switchStory } from '${args.switchStoryImport}';\n\n// @generated-begin ${generatedRegionName}\ntest.describe('${escapeSingleQuotes(args.title)}', () => {\n${tests}\n});\n// @generated-end ${generatedRegionName}\n\n${args.manualRegion}`;
+    return `import { test, expect, switchStory } from '@crvy/strybk';\n\n// @generated-begin ${generatedRegionName}\ntest.describe('${escapeSingleQuotes(args.title)}', () => {\n${tests}\n});\n// @generated-end ${generatedRegionName}\n\n${args.manualRegion}`;
 }

package/dist/src/index.d.ts

@@ -1,4 +1,4 @@
 export { defineConfig } from "./config.js";
 export type { StrybkConfig, StorybookGlobals } from "./config.js";
 export { generateScreenshots } from "./generate/index.js";
-export { createStrybkFixtures, switchStory } from "./playwright/index.js";
+export { test, expect, switchStory } from "./playwright/index.js";

package/dist/src/index.js

@@ -1,3 +1,3 @@
 export { defineConfig } from "./config.js";
 export { generateScreenshots } from "./generate/index.js";
-export { createStrybkFixtures, switchStory } from "./playwright/index.js";
+export { test, expect, switchStory } from "./playwright/index.js";

package/dist/src/playwright/index.d.ts

@@ -1,2 +1,5 @@
-export { createStrybkFixtures } from "./fixtures.js";
 export { switchStory } from "./switchStory.js";
+export declare const test: import("playwright/test").TestType<import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & {
+    sharedPage: import("playwright-core").Page;
+}, import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions>;
+export declare const expect: import("playwright/test").Expect<{}>;

package/dist/src/playwright/index.js

@@ -1,2 +1,5 @@
-export { createStrybkFixtures } from "./fixtures.js";
+import { createStrybkFixtures } from "./fixtures.js";
 export { switchStory } from "./switchStory.js";
+const fixtures = createStrybkFixtures();
+export const test = fixtures.test;
+export const expect = fixtures.expect;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crvy/strybk",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Generator-first Playwright screenshot testing for Storybook.",
   "keywords": [
     "crvy",
@@ -20,7 +20,7 @@
     "url": "git+https://github.com/creevey/strybk.git"
   },
   "bin": {
-    "strybk": "./dist/src/cli.js"
+    "crvy-strybk": "./dist/src/cli.js"
   },
   "files": [
     "dist/",
@@ -89,7 +89,7 @@
   },
   "engines": {
     "bun": ">=1.3.0",
-    "node": ">=24"
+    "node": ">=22"
   },
   "packageManager": "bun@1.3.13"
 }