@test2doc/playwright 1.4.0 → 1.5.1

package/dist/DocMeta.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=DocMeta.test.d.ts.map

package/dist/DocMeta.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocMeta.test.d.ts","sourceRoot":"","sources":["../src/DocMeta.test.ts"],"names":[],"mappings":""}

package/dist/DocMeta.test.js

@@ -0,0 +1,46 @@
+import { test, expect, describe, vi } from "vitest";
+describe("withDocMeta", () => {
+    test("returns title without config data if test2doc is not enabled", async () => {
+        const { withDocMeta } = await import("./DocMeta.js");
+        const title = withDocMeta("My Test Title", { title: "My Test Title" });
+        expect(title).toBe("My Test Title");
+    });
+    test("returns title with config data if test2doc is enabled", async () => {
+        const { activateTest2Doc, withDocMeta } = await import("./DocMeta.js");
+        activateTest2Doc();
+        const title = withDocMeta("My Test Title", { title: "My Test Title" });
+        expect(title).toBe('My Test Title[test2doc_page]:{"title":"My Test Title"}');
+    });
+    test("returns title with config data when test2doc flag is provided on the command line", async () => {
+        vi.resetModules();
+        const originalEnv = { ...process.env };
+        process.env.TEST2DOC = "true";
+        const { withDocMeta } = await import("./DocMeta.js");
+        const title = withDocMeta("My Test Title", {
+            title: "My Test Title",
+        });
+        expect(title).toBe('My Test Title[test2doc_page]:{"title":"My Test Title"}');
+        process.env = originalEnv;
+    });
+});
+describe("withDocCategory", () => {
+    test("returns title without category metadata when test2doc is not active", async () => {
+        vi.resetModules();
+        const { withDocCategory } = await import("./DocMeta.js");
+        const title = withDocCategory("My Category", {
+            label: "My Label",
+            link: { type: "generated-index", title: "Index" },
+        });
+        expect(title).toBe("My Category");
+    });
+    test("returns title with category metadata when test2doc is active", async () => {
+        const { activateTest2Doc, withDocCategory } = await import("./DocMeta.js");
+        activateTest2Doc();
+        const title = withDocCategory("My Category", {
+            label: "My Label",
+            link: { type: "generated-index", title: "Index" },
+        });
+        expect(title).toBe('My Category[test2doc_category]:{"label":"My Label","link":{"type":"generated-index","title":"Index"}}');
+    });
+});
+//# sourceMappingURL=DocMeta.test.js.map

package/dist/DocMeta.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocMeta.test.js","sourceRoot":"","sources":["../src/DocMeta.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AAEnD,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,IAAI,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC9E,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,CAAA;QACpD,MAAM,KAAK,GAAG,WAAW,CAAC,eAAe,EAAE,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC,CAAA;QACtE,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;IACrC,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QACvE,MAAM,EAAE,gBAAgB,EAAE,WAAW,EAAE,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,CAAA;QACtE,gBAAgB,EAAE,CAAA;QAClB,MAAM,KAAK,GAAG,WAAW,CAAC,eAAe,EAAE,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC,CAAA;QACtE,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAA;IAC9E,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,mFAAmF,EAAE,KAAK,IAAI,EAAE;QACnG,EAAE,CAAC,YAAY,EAAE,CAAA;QACjB,MAAM,WAAW,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,CAAA;QACtC,OAAO,CAAC,GAAG,CAAC,QAAQ,GAAG,MAAM,CAAA;QAE7B,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,CAAA;QACpD,MAAM,KAAK,GAAG,WAAW,CAAC,eAAe,EAAE;YACzC,KAAK,EAAE,eAAe;SACvB,CAAC,CAAA;QACF,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAA;QAE5E,OAAO,CAAC,GAAG,GAAG,WAAW,CAAA;IAC3B,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA;AAEF,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,IAAI,CAAC,qEAAqE,EAAE,KAAK,IAAI,EAAE;QACrF,EAAE,CAAC,YAAY,EAAE,CAAA;QACjB,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,CAAA;QACxD,MAAM,KAAK,GAAG,eAAe,CAAC,aAAa,EAAE;YAC3C,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,EAAE,IAAI,EAAE,iBAAiB,EAAE,KAAK,EAAE,OAAO,EAAE;SAClD,CAAC,CAAA;QACF,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;IACnC,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC9E,MAAM,EAAE,gBAAgB,EAAE,eAAe,EAAE,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,CAAA;QAC1E,gBAAgB,EAAE,CAAA;QAClB,MAAM,KAAK,GAAG,eAAe,CAAC,aAAa,EAAE;YAC3C,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,EAAE,IAAI,EAAE,iBAAiB,EAAE,KAAK,EAAE,OAAO,EAAE;SAClD,CAAC,CAAA;QACF,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAChB,uGAAuG,CACxG,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/Test2DocReporter.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Test2DocReporter.test.d.ts.map

package/dist/Test2DocReporter.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Test2DocReporter.test.d.ts","sourceRoot":"","sources":["../src/Test2DocReporter.test.ts"],"names":[],"mappings":""}

package/dist/Test2DocReporter.test.js

@@ -0,0 +1,450 @@
+import { describe, it, expect, vi, beforeEach, afterEach, } from "vitest";
+import { mkdirSync, readdirSync, readFileSync, writeFileSync } from "node:fs";
+import { join } from "node:path";
+import { withDocMeta } from "./DocMeta.js";
+import { setup, tempDir, testCleanup, mockSuiteForPages, mockSuiteForCategories, mockTestSuccess, mockTestFail, mockTestPrivacyPolicyLogin, mockTestPrivacyPolicyRegistration, mockStep, baseSuite, mockSuiteWithMultiProjects, mockTestNewUserRegistration, mockTestLoggedInUser, mockTestLoggedOutUser, mockSingleSetupFileSuite, mockSetupTest, mockAuthenticatedTest, } from "./testUtils/index.js";
+const mockFullConfig = {};
+describe("Test2DocReporter", () => {
+    let mockLogging;
+    beforeEach(() => {
+        vi.useFakeTimers();
+        vi.setSystemTime(new Date("2024-01-01T00:00:00Z"));
+        // Mock print to terminal
+        mockLogging = vi
+            .spyOn(process.stdout, "write")
+            .mockImplementation(() => true);
+    });
+    afterEach(() => {
+        vi.useRealTimers();
+        // Clean up the temporary directory
+        testCleanup();
+        mockLogging.mockRestore();
+    });
+    // TODO: remove this later
+    describe("withDocMeta", () => {
+        it("loading the reporter file should enable the withDocMeta JSON stringify for Docusaurus Page Header Data", () => {
+            expect(withDocMeta("test title", { title: "Test" })).toBe('test title[test2doc_page]:{"title":"Test"}');
+        });
+    });
+    it("should generate markdown for each root describe block in a file", () => {
+        const reporter = setup();
+        let bufferCounter = 0;
+        const createMockScreenshotBuffer = () => Buffer.from(`mock image data ${bufferCounter++}`);
+        writeFileSync(join(tempDir, "test2doc-1704067218000-1.png"), createMockScreenshotBuffer());
+        writeFileSync(join(tempDir, "test2doc-old.md"), "# Old Documentation");
+        mkdirSync(join(tempDir, "test2doc-old-dir"));
+        mkdirSync(join(tempDir, "test2doc-old-category-dir"));
+        writeFileSync(join(tempDir, "test2doc-old-category-dir/_category_.json"), JSON.stringify({
+            label: "This needs to be cleaned up",
+            position: 1,
+        }, null, 2));
+        reporter.onBegin(mockFullConfig, mockSuiteForPages);
+        reporter.onStepBegin(mockTestSuccess, {}, mockStep);
+        const mockScreenshotName1 = `test2doc-${Date.now() + 500}-1.png`;
+        const mockScreenshotName2 = `test2doc-${Date.now() + 999}-2.png`;
+        const mockScreenshotName3WithAltText = `test2doc-${Date.now() + 1001}-3.png:Alt Text`;
+        const mockScreenshotName4 = `test2doc-${Date.now() + 1101}-4.png`;
+        const mockScreenshotName5 = `test2doc-${Date.now() + 1201}-5.png`;
+        const buffer1 = createMockScreenshotBuffer();
+        const buffer2 = createMockScreenshotBuffer();
+        const buffer3 = createMockScreenshotBuffer();
+        const buffer4 = createMockScreenshotBuffer();
+        const buffer5 = createMockScreenshotBuffer();
+        const mockAttachmentSuccess = [
+            {
+                name: mockScreenshotName1,
+                body: buffer1,
+                contentType: "image/png",
+            },
+        ];
+        const mockAttachmentFail = [
+            ...mockAttachmentSuccess,
+            {
+                name: mockScreenshotName2,
+                body: buffer2,
+                contentType: "image/png",
+            },
+            {
+                name: mockScreenshotName3WithAltText,
+                body: buffer3,
+                contentType: "image/png",
+            },
+        ];
+        const mockAttachmentPrivacyPolicyLogin = [
+            ...mockAttachmentFail,
+            {
+                name: mockScreenshotName4,
+                body: buffer4,
+                contentType: "image/png",
+            },
+        ];
+        const mockAttachmentPrivacyPolicyRegistration = [
+            ...mockAttachmentPrivacyPolicyLogin,
+            {
+                name: mockScreenshotName5,
+                body: buffer5,
+                contentType: "image/png",
+            },
+        ];
+        vi.advanceTimersByTime(600);
+        reporter.onStepEnd(mockTestSuccess, {
+            attachments: mockAttachmentSuccess,
+        }, mockStep);
+        reporter.onTestEnd(mockTestSuccess, { status: "passed" });
+        vi.advanceTimersByTime(400);
+        reporter.onStepBegin(mockTestFail, {}, mockStep);
+        reporter.onStepEnd(mockTestFail, {
+            attachments: mockAttachmentSuccess,
+        }, mockStep);
+        reporter.onTestEnd(mockTestFail, { status: "passed" });
+        vi.advanceTimersByTime(100);
+        reporter.onStepEnd(mockTestFail, {
+            attachments: mockAttachmentFail,
+        }, mockStep);
+        reporter.onStepBegin(mockTestPrivacyPolicyLogin, {}, mockStep);
+        vi.advanceTimersByTime(100);
+        reporter.onStepEnd(mockTestPrivacyPolicyLogin, {
+            attachments: mockAttachmentPrivacyPolicyLogin,
+        }, mockStep);
+        reporter.onTestEnd(mockTestPrivacyPolicyLogin, {
+            status: "passed",
+        });
+        reporter.onTestEnd(mockTestNewUserRegistration, {
+            status: "passed",
+        });
+        reporter.onStepBegin(mockTestPrivacyPolicyRegistration, {}, mockStep);
+        vi.advanceTimersByTime(100);
+        reporter.onStepEnd(mockTestPrivacyPolicyRegistration, {
+            attachments: mockAttachmentPrivacyPolicyRegistration,
+        }, mockStep);
+        reporter.onTestEnd(mockTestPrivacyPolicyRegistration, {
+            status: "passed",
+        });
+        reporter.onTestEnd(mockTestLoggedInUser, { status: "passed" });
+        reporter.onTestEnd(mockTestLoggedOutUser, {
+            status: "passed",
+        });
+        expect(readdirSync(tempDir)).toHaveLength(4);
+        reporter.onEnd();
+        expect(readdirSync(tempDir)).toHaveLength(8);
+        expect(readFileSync(`${tempDir}/test2doc-registration-page.mdx`, "utf8")).toEqual(`---
+title: Registration Page Documentation
+description: The registration page for new users.
+sidebar_position: 1
+---
+
+# Registration Page
+
+## New User Registration
+
+### should register a new user successfully
+
+## link to privacy policy
+
+### should open privacy policy in new tab
+
+Given user is on login page
+![screenshot](./test2doc-0d5626c46ad3.png)
+
+`);
+        expect(readFileSync(`${tempDir}/test2doc-login-page.mdx`, "utf8")).toEqual(`---
+title: Login Page Documentation
+keywords:
+  - login
+  - password
+  - username
+description: The different login scenarios for the login page.
+sidebar_position: 1
+parse_number_prefixes: true
+---
+
+# Login Page
+
+## Successful Login
+
+### should redirect to dashboard on successful login
+
+Given user is on login page
+![screenshot](./test2doc-fc6a5aa2918b.png)
+
+## Failed Login
+
+### should display error message on failed login
+
+Given user is on login page
+![screenshot](./test2doc-be826aa977e6.png)
+![Alt Text](./test2doc-df78fdc04e9c.png)
+
+## link to privacy policy
+
+### should open privacy policy in new tab
+
+Given user is on login page
+![screenshot](./test2doc-89d4efdc31b3.png)
+
+`);
+        expect(readFileSync(`${tempDir}/test2doc-dashboard-page.mdx`, "utf8")).toEqual(`---
+title: Dashboard Documentation
+description: The dashboard of todo stuff.
+sidebar_position: 2
+---
+
+# Dashboard Page
+
+## Logged In User
+
+### should display a list of todos
+
+## Logged Out User
+
+### should redirect to login page
+
+`);
+        expect(readFileSync(`${tempDir}/test2doc-fc6a5aa2918b.png`)).toEqual(buffer1);
+        expect(readFileSync(`${tempDir}/test2doc-be826aa977e6.png`)).toEqual(buffer2);
+        expect(readFileSync(`${tempDir}/test2doc-df78fdc04e9c.png`)).toEqual(buffer3);
+        expect(readFileSync(`${tempDir}/test2doc-89d4efdc31b3.png`)).toEqual(buffer4);
+        expect(readFileSync(`${tempDir}/test2doc-0d5626c46ad3.png`)).toEqual(buffer5);
+        // Logging expectations
+        expect(mockLogging).toHaveBeenCalledWith("Starting documentation generation for 7 tests...\n");
+        expect(mockLogging).toHaveBeenCalledWith("Found 3 documentation sections\n\n");
+        // Progress bar updates
+        expect(mockLogging).toHaveBeenCalledWith("\r\x1b[K"); // Clear line
+        expect(mockLogging).toHaveBeenCalledWith("[.......] 0/7 (0%)");
+        expect(mockLogging).toHaveBeenCalledWith("[P......] 1/7 (14%)");
+        expect(mockLogging).toHaveBeenCalledWith("[PP.....] 2/7 (29%)");
+        expect(mockLogging).toHaveBeenCalledWith("[PPP....] 3/7 (43%)");
+        expect(mockLogging).toHaveBeenCalledWith("[PPPP...] 4/7 (57%)");
+        expect(mockLogging).toHaveBeenCalledWith("[PPPPP..] 5/7 (71%)");
+        expect(mockLogging).toHaveBeenCalledWith("[PPPPPP.] 6/7 (86%)");
+        expect(mockLogging).toHaveBeenCalledWith("[PPPPPPP] 7/7 (100%)");
+        expect(mockLogging).toHaveBeenCalledWith("\n\n");
+        expect(mockLogging).toHaveBeenCalledWith("Cleaning up old generated files...\n");
+        expect(mockLogging).toHaveBeenCalledWith("Generating documentation files...\n");
+        expect(mockLogging).toHaveBeenCalledWith("Documentation generation completed.\n");
+        expect(mockLogging).toHaveBeenCalledWith(`Output directory: ${tempDir}\n`);
+        expect(mockLogging).toHaveBeenCalledWith("Processed 5 screenshots\n");
+    });
+    it("should generate a directory and a _category_.json, and a page for each describe block child under the category describe", () => {
+        const reporter = setup();
+        reporter.onBegin(mockFullConfig, mockSuiteForCategories);
+        reporter.onStepBegin(mockTestSuccess, {}, mockStep);
+        reporter.onStepBegin(mockTestFail, {}, mockStep);
+        reporter.onEnd();
+        expect(readFileSync(`${tempDir}/test2doc-login-page/_category_.json`, "utf8")).toEqual(JSON.stringify({
+            label: "Login Page Documentation Label",
+            position: 1,
+            className: "login-page",
+            link: {
+                type: "generated-index",
+                title: "Login Page Documentation Title",
+                description: "The different login scenarios for the login page.",
+                slug: "login-page",
+            },
+        }, null, 2));
+        expect(readFileSync(`${tempDir}/test2doc-login-page/test2doc-successful-login.mdx`, "utf8")).toEqual(`---
+sidebar_position: 1
+---
+
+# Successful Login
+
+## should redirect to dashboard on successful login
+
+Given user is on login page
+
+`);
+        expect(readdirSync(`${tempDir}/test2doc-login-page`)).toHaveLength(3);
+        expect(readFileSync(`${tempDir}/test2doc-login-page/test2doc-failed-login.mdx`, "utf8")).toEqual(`# Failed Login
+
+## should display error message on failed login
+
+Given user is on login page
+
+`);
+    });
+    it("should generate markdown if there is no root describe block", () => {
+        const reporter = setup();
+        const mockSuiteWithoutRootDescribe = {
+            ...baseSuite,
+            title: "", // Root Suite
+            type: "root",
+            suites: [
+                {
+                    ...baseSuite,
+                    title: "chromium", // or firefox, webkit, etc.
+                    type: "project",
+                    suites: [
+                        {
+                            ...baseSuite,
+                            title: "login.test.ts", // Test file name
+                            type: "file",
+                            suites: [],
+                            tests: [mockTestSuccess, mockTestFail],
+                        },
+                    ],
+                },
+            ],
+        };
+        reporter.onBegin(mockFullConfig, mockSuiteWithoutRootDescribe);
+        reporter.onEnd();
+        expect(readFileSync(`${tempDir}/test2doc-login.mdx`, "utf8")).toEqual(`# login
+
+## should redirect to dashboard on successful login
+
+## should display error message on failed login
+
+`);
+    });
+    describe("exit test run", () => {
+        let mockExit;
+        beforeEach(() => {
+            mockExit = vi.spyOn(process, "exit").mockImplementation(() => {
+                throw new Error("process.exit called");
+            });
+        });
+        afterEach(() => {
+            mockExit.mockRestore();
+        });
+        it("when there are failed tests", () => {
+            const reporter = setup();
+            const mockFailedResult = {
+                status: "failed",
+            };
+            expect(() => reporter.onTestEnd(mockTestSuccess, mockFailedResult)).toThrow("process.exit called");
+            expect(mockLogging).toHaveBeenCalledWith(`Documentation generation aborted due to test failure: ${mockTestSuccess.title}\n`);
+            expect(mockExit).toHaveBeenCalledWith(1);
+            expect(mockExit).toHaveBeenCalledTimes(1);
+        });
+        it("when there are tests that timeout", () => {
+            const reporter = setup();
+            const mockTimeoutResult = {
+                status: "timedOut",
+            };
+            expect(() => reporter.onTestEnd(mockTestSuccess, mockTimeoutResult)).toThrow("process.exit called");
+            expect(mockLogging).toHaveBeenCalledWith(`Documentation generation aborted due to test failure: ${mockTestSuccess.title}\n`);
+            expect(mockExit).toHaveBeenCalledWith(1);
+            expect(mockExit).toHaveBeenCalledTimes(1);
+        });
+        it("when there are failed tests but the command flag to ignore is set, we run tests anyway.", () => {
+            process.env.IGNORE_TEST_FAILURES = "true";
+            const reporter = setup();
+            const mockFailedResult = {
+                status: "failed",
+            };
+            expect(() => reporter.onTestEnd(mockTestSuccess, mockFailedResult)).not.toThrow("process.exit called");
+            expect(mockLogging).toHaveBeenCalledWith(`Documentation generation aborted due to test failure: ${mockTestSuccess.title}\n`);
+            expect(mockExit).toHaveBeenCalledTimes(0);
+            delete process.env.IGNORE_TEST_FAILURES;
+        });
+    });
+    it("should generate documentation for each project (except for .setup.ts files)", () => {
+        const reporter = setup();
+        reporter.onBegin(mockFullConfig, mockSuiteWithMultiProjects);
+        reporter.onEnd();
+        expect(readdirSync(tempDir)).toHaveLength(2);
+        expect(readFileSync(`${tempDir}/test2doc-login.mdx`, "utf8")).toEqual(`# login
+
+## how to login
+
+## how to logout
+
+`);
+        expect(readFileSync(`${tempDir}/test2doc-authenticated.mdx`, "utf8")).toEqual(`# authenticated
+
+## user name and profile should be visible
+
+## setting button should set
+
+`);
+        // Progress bar should count the setup file
+        expect(mockLogging).toHaveBeenCalledWith("[........] 0/8 (0%)");
+    });
+    it("progress bar should count setup files towards total tests", () => {
+        const reporter = setup();
+        reporter.onBegin(mockFullConfig, mockSingleSetupFileSuite);
+        reporter.onTestEnd(mockSetupTest, {
+            status: "passed",
+        });
+        reporter.onTestEnd(mockAuthenticatedTest, {
+            status: "passed",
+        });
+        reporter.onEnd();
+        expect(mockLogging).toHaveBeenCalledWith("[..] 0/2 (0%)");
+        expect(mockLogging).toHaveBeenCalledWith("[P.] 1/2 (50%)");
+        expect(mockLogging).toHaveBeenCalledWith("[PP] 2/2 (100%)");
+    });
+    it("should not clean up user directories with generated files", () => {
+        const reporter = setup();
+        writeFileSync(join(tempDir, "test2doc-old.md"), "# Old Documentation");
+        mkdirSync(join(tempDir, "test2doc-clean-me-up-dir"));
+        mkdirSync(join(tempDir, "test2doc-login-page"));
+        mkdirSync(join(tempDir, "test2doc-orphan-dir"));
+        writeFileSync(join(tempDir, "test2doc-login-page/_category_.json"), JSON.stringify({
+            label: "This needs to be cleaned up",
+            position: 1,
+        }, null, 2));
+        const handWrittenContent = "# Hand-Written Documentation\n\nThis is some hand-written documentation for the login feature.";
+        writeFileSync(join(tempDir, "test2doc-login-page/hand-written-file.md"), handWrittenContent);
+        const anotherHandWrittenContent = "# Another Hand-Written Documentation\n\nThis is some hand-written documentation for the category feature.";
+        writeFileSync(join(tempDir, "test2doc-orphan-dir/another-hand-written-file.md"), anotherHandWrittenContent);
+        reporter.onBegin(mockFullConfig, mockSuiteForCategories);
+        expect(readdirSync(tempDir)).toHaveLength(4);
+        reporter.onEnd();
+        expect(readdirSync(tempDir)).toHaveLength(2);
+        expect(readdirSync(join(tempDir, "test2doc-login-page"))).toHaveLength(4);
+        expect(readFileSync(join(tempDir, "test2doc-login-page/hand-written-file.md"), "utf8")).toBe(handWrittenContent);
+        expect(readdirSync(join(tempDir, "test2doc-orphan-dir"))).toHaveLength(1);
+        expect(readFileSync(join(tempDir, "test2doc-orphan-dir/another-hand-written-file.md"), "utf8")).toBe(anotherHandWrittenContent);
+    });
+    it("should generate figure and figcaption HTML for screenshots with figure metadata", () => {
+        const reporter = setup();
+        let bufferCounter = 0;
+        const createMockScreenshotBuffer = () => Buffer.from(`mock image data ${bufferCounter++}`);
+        reporter.onBegin(mockFullConfig, mockSuiteForPages);
+        reporter.onStepBegin(mockTestSuccess, {}, mockStep);
+        const mockScreenshotName1 = `test2doc-${Date.now() + 500}-1.png`;
+        const mockScreenshotName2WithFigure = `test2doc-${Date.now() + 600}-2.png[test2doc_screenshot]:${JSON.stringify({ figure: true, caption: "User login screen" })}`;
+        const mockScreenshotName3FigureNoCaption = `test2doc-${Date.now() + 700}-3.png[test2doc_screenshot]:${JSON.stringify({ figure: true })}`;
+        const buffer1 = createMockScreenshotBuffer();
+        const buffer2 = createMockScreenshotBuffer();
+        const buffer3 = createMockScreenshotBuffer();
+        const mockAttachmentWithFigure = [
+            {
+                name: mockScreenshotName1,
+                body: buffer1,
+                contentType: "image/png",
+            },
+            {
+                name: mockScreenshotName2WithFigure,
+                body: buffer2,
+                contentType: "image/png",
+            },
+            {
+                name: mockScreenshotName3FigureNoCaption,
+                body: buffer3,
+                contentType: "image/png",
+            },
+        ];
+        vi.advanceTimersByTime(800);
+        reporter.onStepEnd(mockTestSuccess, {
+            attachments: mockAttachmentWithFigure,
+        }, mockStep);
+        reporter.onTestEnd(mockTestSuccess, { status: "passed" });
+        reporter.onEnd();
+        const content = readFileSync(`${tempDir}/test2doc-login-page.mdx`, "utf8");
+        // Regular screenshot without figure should still work with standard markdown
+        expect(content).toContain("![screenshot](./test2doc-b67cfe621cc5.png)");
+        // Screenshot with figure and caption should include figcaption
+        expect(content).toContain(`<figure>
+
+![User login screen](./test2doc-fc6a5aa2918b.png)
+<figcaption>User login screen</figcaption>
+</figure>`);
+        // Screenshot with figure but no caption should not include figcaption
+        expect(content).toContain(`<figure>
+
+![screenshot](./test2doc-be826aa977e6.png)
+</figure>`);
+    });
+});
+//# sourceMappingURL=Test2DocReporter.test.js.map

package/dist/Test2DocReporter.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Test2DocReporter.test.js","sourceRoot":"","sources":["../src/Test2DocReporter.test.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EACR,EAAE,EACF,MAAM,EACN,EAAE,EACF,UAAU,EACV,SAAS,GAEV,MAAM,QAAQ,CAAA;AAEf,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAC7E,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EACL,KAAK,EACL,OAAO,EACP,WAAW,EACX,iBAAiB,EACjB,sBAAsB,EACtB,eAAe,EACf,YAAY,EACZ,0BAA0B,EAC1B,iCAAiC,EACjC,QAAQ,EACR,SAAS,EACT,0BAA0B,EAC1B,2BAA2B,EAC3B,oBAAoB,EACpB,qBAAqB,EACrB,wBAAwB,EACxB,aAAa,EACb,qBAAqB,GACtB,MAAM,sBAAsB,CAAA;AAE7B,MAAM,cAAc,GAAe,EAAgB,CAAA;AAEnD,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,IAAI,WAA0D,CAAA;IAC9D,UAAU,CAAC,GAAG,EAAE;QACd,EAAE,CAAC,aAAa,EAAE,CAAA;QAClB,EAAE,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAA;QAElD,yBAAyB;QACzB,WAAW,GAAG,EAAE;aACb,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC;aAC9B,kBAAkB,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA;IACnC,CAAC,CAAC,CAAA;IAEF,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,aAAa,EAAE,CAAA;QAClB,mCAAmC;QACnC,WAAW,EAAE,CAAA;QACb,WAAW,CAAC,WAAW,EAAE,CAAA;IAC3B,CAAC,CAAC,CAAA;IAEF,0BAA0B;IAC1B,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAC3B,EAAE,CAAC,wGAAwG,EAAE,GAAG,EAAE;YAChH,MAAM,CAAC,WAAW,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CACvD,4CAA4C,CAC7C,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACzE,MAAM,QAAQ,GAAG,KAAK,EAAE,CAAA;QACxB,IAAI,aAAa,GAAG,CAAC,CAAA;QACrB,MAAM,0BAA0B,GAAG,GAAG,EAAE,CACtC,MAAM,CAAC,IAAI,CAAC,mBAAmB,aAAa,EAAE,EAAE,CAAC,CAAA;QACnD,aAAa,CACX,IAAI,CAAC,OAAO,EAAE,8BAA8B,CAAC,EAC7C,0BAA0B,EAAE,CAC7B,CAAA;QACD,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,iBAAiB,CAAC,EAAE,qBAAqB,CAAC,CAAA;QACtE,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC,CAAA;QAC5C,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,2BAA2B,CAAC,CAAC,CAAA;QACrD,aAAa,CACX,IAAI,CAAC,OAAO,EAAE,2CAA2C,CAAC,EAC1D,IAAI,CAAC,SAAS,CACZ;YACE,KAAK,EAAE,6BAA6B;YACpC,QAAQ,EAAE,CAAC;SACZ,EACD,IAAI,EACJ,CAAC,CACF,CACF,CAAA;QAED,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAA;QACnD,QAAQ,CAAC,WAAW,CAAC,eAAe,EAAE,EAAgB,EAAE,QAAQ,CAAC,CAAA;QACjE,MAAM,mBAAmB,GAAG,YAAY,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAAA;QAChE,MAAM,mBAAmB,GAAG,YAAY,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAAA;QAChE,MAAM,8BAA8B,GAAG,YAAY,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,iBAAiB,CAAA;QACrF,MAAM,mBAAmB,GAAG,YAAY,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,QAAQ,CAAA;QACjE,MAAM,mBAAmB,GAAG,YAAY,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,QAAQ,CAAA;QACjE,MAAM,OAAO,GAAG,0BAA0B,EAAE,CAAA;QAC5C,MAAM,OAAO,GAAG,0BAA0B,EAAE,CAAA;QAC5C,MAAM,OAAO,GAAG,0BAA0B,EAAE,CAAA;QAC5C,MAAM,OAAO,GAAG,0BAA0B,EAAE,CAAA;QAC5C,MAAM,OAAO,GAAG,0BAA0B,EAAE,CAAA;QAC5C,MAAM,qBAAqB,GAAG;YAC5B;gBACE,IAAI,EAAE,mBAAmB;gBACzB,IAAI,EAAE,OAAO;gBACb,WAAW,EAAE,WAAW;aACzB;SACF,CAAA;QACD,MAAM,kBAAkB,GAAG;YACzB,GAAG,qBAAqB;YACxB;gBACE,IAAI,EAAE,mBAAmB;gBACzB,IAAI,EAAE,OAAO;gBACb,WAAW,EAAE,WAAW;aACzB;YACD;gBACE,IAAI,EAAE,8BAA8B;gBACpC,IAAI,EAAE,OAAO;gBACb,WAAW,EAAE,WAAW;aACzB;SACF,CAAA;QACD,MAAM,gCAAgC,GAAG;YACvC,GAAG,kBAAkB;YACrB;gBACE,IAAI,EAAE,mBAAmB;gBACzB,IAAI,EAAE,OAAO;gBACb,WAAW,EAAE,WAAW;aACzB;SACF,CAAA;QACD,MAAM,uCAAuC,GAAG;YAC9C,GAAG,gCAAgC;YACnC;gBACE,IAAI,EAAE,mBAAmB;gBACzB,IAAI,EAAE,OAAO;gBACb,WAAW,EAAE,WAAW;aACzB;SACF,CAAA;QACD,EAAE,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAA;QAE3B,QAAQ,CAAC,SAAS,CAChB,eAAe,EACf;YACE,WAAW,EAAE,qBAAqB;SACrB,EACf,QAAQ,CACT,CAAA;QAED,QAAQ,CAAC,SAAS,CAAC,eAAe,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAgB,CAAC,CAAA;QAEvE,EAAE,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAA;QAE3B,QAAQ,CAAC,WAAW,CAAC,YAAY,EAAE,EAAgB,EAAE,QAAQ,CAAC,CAAA;QAC9D,QAAQ,CAAC,SAAS,CAChB,YAAY,EACZ;YACE,WAAW,EAAE,qBAAqB;SACrB,EACf,QAAQ,CACT,CAAA;QACD,QAAQ,CAAC,SAAS,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAgB,CAAC,CAAA;QACpE,EAAE,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAA;QAC3B,QAAQ,CAAC,SAAS,CAChB,YAAY,EACZ;YACE,WAAW,EAAE,kBAAkB;SAClB,EACf,QAAQ,CACT,CAAA;QAED,QAAQ,CAAC,WAAW,CAAC,0BAA0B,EAAE,EAAgB,EAAE,QAAQ,CAAC,CAAA;QAC5E,EAAE,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAA;QAC3B,QAAQ,CAAC,SAAS,CAChB,0BAA0B,EAC1B;YACE,WAAW,EAAE,gCAAgC;SAChC,EACf,QAAQ,CACT,CAAA;QACD,QAAQ,CAAC,SAAS,CAAC,0BAA0B,EAAE;YAC7C,MAAM,EAAE,QAAQ;SACH,CAAC,CAAA;QAEhB,QAAQ,CAAC,SAAS,CAAC,2BAA2B,EAAE;YAC9C,MAAM,EAAE,QAAQ;SACH,CAAC,CAAA;QAEhB,QAAQ,CAAC,WAAW,CAClB,iCAAiC,EACjC,EAAgB,EAChB,QAAQ,CACT,CAAA;QACD,EAAE,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAA;QAC3B,QAAQ,CAAC,SAAS,CAChB,iCAAiC,EACjC;YACE,WAAW,EAAE,uCAAuC;SACvC,EACf,QAAQ,CACT,CAAA;QAED,QAAQ,CAAC,SAAS,CAAC,iCAAiC,EAAE;YACpD,MAAM,EAAE,QAAQ;SACH,CAAC,CAAA;QAChB,QAAQ,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAgB,CAAC,CAAA;QAC5E,QAAQ,CAAC,SAAS,CAAC,qBAAqB,EAAE;YACxC,MAAM,EAAE,QAAQ;SACH,CAAC,CAAA;QAEhB,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;QAC5C,QAAQ,CAAC,KAAK,EAAE,CAAA;QAEhB,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;QAC5C,MAAM,CACJ,YAAY,CAAC,GAAG,OAAO,iCAAiC,EAAE,MAAM,CAAC,CAClE,CAAC,OAAO,CACP;;;;;;;;;;;;;;;;;;;CAmBL,CACI,CAAA;QACD,MAAM,CAAC,YAAY,CAAC,GAAG,OAAO,0BAA0B,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CACxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmCL,CACI,CAAA;QACD,MAAM,CACJ,YAAY,CAAC,GAAG,OAAO,8BAA8B,EAAE,MAAM,CAAC,CAC/D,CAAC,OAAO,CACP;;;;;;;;;;;;;;;;CAgBL,CACI,CAAA;QACD,MAAM,CAAC,YAAY,CAAC,GAAG,OAAO,4BAA4B,CAAC,CAAC,CAAC,OAAO,CAClE,OAAO,CACR,CAAA;QACD,MAAM,CAAC,YAAY,CAAC,GAAG,OAAO,4BAA4B,CAAC,CAAC,CAAC,OAAO,CAClE,OAAO,CACR,CAAA;QACD,MAAM,CAAC,YAAY,CAAC,GAAG,OAAO,4BAA4B,CAAC,CAAC,CAAC,OAAO,CAClE,OAAO,CACR,CAAA;QACD,MAAM,CAAC,YAAY,CAAC,GAAG,OAAO,4BAA4B,CAAC,CAAC,CAAC,OAAO,CAClE,OAAO,CACR,CAAA;QACD,MAAM,CAAC,YAAY,CAAC,GAAG,OAAO,4BAA4B,CAAC,CAAC,CAAC,OAAO,CAClE,OAAO,CACR,CAAA;QAED,uBAAuB;QACvB,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CACtC,oDAAoD,CACrD,CAAA;QACD,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CACtC,oCAAoC,CACrC,CAAA;QAED,uBAAuB;QACvB,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAA,CAAC,aAAa;QAClE,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,CAAA;QAC9D,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,CAAA;QAC/D,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,CAAA;QAC/D,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,CAAA;QAC/D,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,CAAA;QAC/D,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,CAAA;QAC/D,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,CAAA;QAC/D,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,sBAAsB,CAAC,CAAA;QAEhE,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAA;QAChD,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CACtC,sCAAsC,CACvC,CAAA;QACD,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CACtC,qCAAqC,CACtC,CAAA;QACD,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CACtC,uCAAuC,CACxC,CAAA;QACD,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,qBAAqB,OAAO,IAAI,CAAC,CAAA;QAC1E,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,2BAA2B,CAAC,CAAA;IACvE,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,yHAAyH,EAAE,GAAG,EAAE;QACjI,MAAM,QAAQ,GAAG,KAAK,EAAE,CAAA;QAExB,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,sBAAsB,CAAC,CAAA;QACxD,QAAQ,CAAC,WAAW,CAAC,eAAe,EAAE,EAAgB,EAAE,QAAQ,CAAC,CAAA;QACjE,QAAQ,CAAC,WAAW,CAAC,YAAY,EAAE,EAAgB,EAAE,QAAQ,CAAC,CAAA;QAC9D,QAAQ,CAAC,KAAK,EAAE,CAAA;QAEhB,MAAM,CACJ,YAAY,CAAC,GAAG,OAAO,sCAAsC,EAAE,MAAM,CAAC,CACvE,CAAC,OAAO,CACP,IAAI,CAAC,SAAS,CACZ;YACE,KAAK,EAAE,gCAAgC;YACvC,QAAQ,EAAE,CAAC;YACX,SAAS,EAAE,YAAY;YACvB,IAAI,EAAE;gBACJ,IAAI,EAAE,iBAAiB;gBACvB,KAAK,EAAE,gCAAgC;gBACvC,WAAW,EAAE,mDAAmD;gBAChE,IAAI,EAAE,YAAY;aACnB;SACF,EACD,IAAI,EACJ,CAAC,CACF,CACF,CAAA;QACD,MAAM,CACJ,YAAY,CACV,GAAG,OAAO,oDAAoD,EAC9D,MAAM,CACP,CACF,CAAC,OAAO,CACP;;;;;;;;;;CAUL,CACI,CAAA;QACD,MAAM,CAAC,WAAW,CAAC,GAAG,OAAO,sBAAsB,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;QACrE,MAAM,CACJ,YAAY,CACV,GAAG,OAAO,gDAAgD,EAC1D,MAAM,CACP,CACF,CAAC,OAAO,CACP;;;;;;CAML,CACI,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;QACrE,MAAM,QAAQ,GAAG,KAAK,EAAE,CAAA;QACxB,MAAM,4BAA4B,GAAU;YAC1C,GAAG,SAAS;YACZ,KAAK,EAAE,EAAE,EAAE,aAAa;YACxB,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE;gBACN;oBACE,GAAG,SAAS;oBACZ,KAAK,EAAE,UAAU,EAAE,2BAA2B;oBAC9C,IAAI,EAAE,SAAS;oBACf,MAAM,EAAE;wBACN;4BACE,GAAG,SAAS;4BACZ,KAAK,EAAE,eAAe,EAAE,iBAAiB;4BACzC,IAAI,EAAE,MAAM;4BACZ,MAAM,EAAE,EAAE;4BACV,KAAK,EAAE,CAAC,eAAe,EAAE,YAAY,CAAC;yBACvC;qBACF;iBACF;aACF;SACF,CAAA;QAED,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,4BAA4B,CAAC,CAAA;QAC9D,QAAQ,CAAC,KAAK,EAAE,CAAA;QAEhB,MAAM,CAAC,YAAY,CAAC,GAAG,OAAO,qBAAqB,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CACnE;;;;;;CAML,CACI,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,IAAI,QAEH,CAAA;QAED,UAAU,CAAC,GAAG,EAAE;YACd,QAAQ,GAAG,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE;gBAC3D,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAA;YACxC,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,SAAS,CAAC,GAAG,EAAE;YACb,QAAQ,CAAC,WAAW,EAAE,CAAA;QACxB,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,MAAM,QAAQ,GAAG,KAAK,EAAE,CAAA;YAExB,MAAM,gBAAgB,GAAe;gBACnC,MAAM,EAAE,QAAQ;aACH,CAAA;YAEf,MAAM,CAAC,GAAG,EAAE,CACV,QAAQ,CAAC,SAAS,CAAC,eAAe,EAAE,gBAAgB,CAAC,CACtD,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAA;YAEhC,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CACtC,yDAAyD,eAAe,CAAC,KAAK,IAAI,CACnF,CAAA;YACD,MAAM,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAA;YACxC,MAAM,CAAC,QAAQ,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;QAC3C,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;YAC3C,MAAM,QAAQ,GAAG,KAAK,EAAE,CAAA;YAExB,MAAM,iBAAiB,GAAe;gBACpC,MAAM,EAAE,UAAU;aACL,CAAA;YAEf,MAAM,CAAC,GAAG,EAAE,CACV,QAAQ,CAAC,SAAS,CAAC,eAAe,EAAE,iBAAiB,CAAC,CACvD,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAA;YAEhC,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CACtC,yDAAyD,eAAe,CAAC,KAAK,IAAI,CACnF,CAAA;YACD,MAAM,CAAC,QAAQ,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAA;YACxC,MAAM,CAAC,QAAQ,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;QAC3C,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,yFAAyF,EAAE,GAAG,EAAE;YACjG,OAAO,CAAC,GAAG,CAAC,oBAAoB,GAAG,MAAM,CAAA;YACzC,MAAM,QAAQ,GAAG,KAAK,EAAE,CAAA;YAExB,MAAM,gBAAgB,GAAe;gBACnC,MAAM,EAAE,QAAQ;aACH,CAAA;YAEf,MAAM,CAAC,GAAG,EAAE,CACV,QAAQ,CAAC,SAAS,CAAC,eAAe,EAAE,gBAAgB,CAAC,CACtD,CAAC,GAAG,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAA;YAEpC,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CACtC,yDAAyD,eAAe,CAAC,KAAK,IAAI,CACnF,CAAA;YAED,MAAM,CAAC,QAAQ,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACzC,OAAO,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAA;QACzC,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,6EAA6E,EAAE,GAAG,EAAE;QACrF,MAAM,QAAQ,GAAG,KAAK,EAAE,CAAA;QAExB,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,0BAA0B,CAAC,CAAA;QAC5D,QAAQ,CAAC,KAAK,EAAE,CAAA;QAEhB,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;QAE5C,MAAM,CAAC,YAAY,CAAC,GAAG,OAAO,qBAAqB,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CACnE;;;;;;CAML,CACI,CAAA;QAED,MAAM,CACJ,YAAY,CAAC,GAAG,OAAO,6BAA6B,EAAE,MAAM,CAAC,CAC9D,CAAC,OAAO,CAAC;;;;;;CAMb,CAAC,CAAA;QAEE,2CAA2C;QAC3C,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,CAAA;IACjE,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,MAAM,QAAQ,GAAG,KAAK,EAAE,CAAA;QAExB,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,wBAAwB,CAAC,CAAA;QAC1D,QAAQ,CAAC,SAAS,CAAC,aAAa,EAAE;YAChC,MAAM,EAAE,QAAQ;SACH,CAAC,CAAA;QAChB,QAAQ,CAAC,SAAS,CAAC,qBAAqB,EAAE;YACxC,MAAM,EAAE,QAAQ;SACH,CAAC,CAAA;QAChB,QAAQ,CAAC,KAAK,EAAE,CAAA;QAEhB,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAA;QACzD,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,CAAA;QAC1D,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAA;IAC7D,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,MAAM,QAAQ,GAAG,KAAK,EAAE,CAAA;QACxB,aAAa,CAAC,IAAI,CAAC,OAAO,EAAE,iBAAiB,CAAC,EAAE,qBAAqB,CAAC,CAAA;QACtE,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,0BAA0B,CAAC,CAAC,CAAA;QACpD,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,qBAAqB,CAAC,CAAC,CAAA;QAC/C,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,qBAAqB,CAAC,CAAC,CAAA;QAE/C,aAAa,CACX,IAAI,CAAC,OAAO,EAAE,qCAAqC,CAAC,EACpD,IAAI,CAAC,SAAS,CACZ;YACE,KAAK,EAAE,6BAA6B;YACpC,QAAQ,EAAE,CAAC;SACZ,EACD,IAAI,EACJ,CAAC,CACF,CACF,CAAA;QACD,MAAM,kBAAkB,GACtB,gGAAgG,CAAA;QAClG,aAAa,CACX,IAAI,CAAC,OAAO,EAAE,0CAA0C,CAAC,EACzD,kBAAkB,CACnB,CAAA;QACD,MAAM,yBAAyB,GAC7B,2GAA2G,CAAA;QAC7G,aAAa,CACX,IAAI,CAAC,OAAO,EAAE,kDAAkD,CAAC,EACjE,yBAAyB,CAC1B,CAAA;QAED,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,sBAAsB,CAAC,CAAA;QAExD,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;QAC5C,QAAQ,CAAC,KAAK,EAAE,CAAA;QAEhB,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;QAC5C,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;QACzE,MAAM,CACJ,YAAY,CACV,IAAI,CAAC,OAAO,EAAE,0CAA0C,CAAC,EACzD,MAAM,CACP,CACF,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAA;QAC1B,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;QACzE,MAAM,CACJ,YAAY,CACV,IAAI,CAAC,OAAO,EAAE,kDAAkD,CAAC,EACjE,MAAM,CACP,CACF,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAA;IACnC,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,iFAAiF,EAAE,GAAG,EAAE;QACzF,MAAM,QAAQ,GAAG,KAAK,EAAE,CAAA;QACxB,IAAI,aAAa,GAAG,CAAC,CAAA;QACrB,MAAM,0BAA0B,GAAG,GAAG,EAAE,CACtC,MAAM,CAAC,IAAI,CAAC,mBAAmB,aAAa,EAAE,EAAE,CAAC,CAAA;QAEnD,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAA;QACnD,QAAQ,CAAC,WAAW,CAAC,eAAe,EAAE,EAAgB,EAAE,QAAQ,CAAC,CAAA;QAEjE,MAAM,mBAAmB,GAAG,YAAY,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAAA;QAChE,MAAM,6BAA6B,GAAG,YAAY,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,+BAA+B,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,mBAAmB,EAAE,CAAC,EAAE,CAAA;QACjK,MAAM,kCAAkC,GAAG,YAAY,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,+BAA+B,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,CAAA;QACxI,MAAM,OAAO,GAAG,0BAA0B,EAAE,CAAA;QAC5C,MAAM,OAAO,GAAG,0BAA0B,EAAE,CAAA;QAC5C,MAAM,OAAO,GAAG,0BAA0B,EAAE,CAAA;QAE5C,MAAM,wBAAwB,GAAG;YAC/B;gBACE,IAAI,EAAE,mBAAmB;gBACzB,IAAI,EAAE,OAAO;gBACb,WAAW,EAAE,WAAW;aACzB;YACD;gBACE,IAAI,EAAE,6BAA6B;gBACnC,IAAI,EAAE,OAAO;gBACb,WAAW,EAAE,WAAW;aACzB;YACD;gBACE,IAAI,EAAE,kCAAkC;gBACxC,IAAI,EAAE,OAAO;gBACb,WAAW,EAAE,WAAW;aACzB;SACF,CAAA;QAED,EAAE,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAA;QAE3B,QAAQ,CAAC,SAAS,CAChB,eAAe,EACf;YACE,WAAW,EAAE,wBAAwB;SACxB,EACf,QAAQ,CACT,CAAA;QAED,QAAQ,CAAC,SAAS,CAAC,eAAe,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAgB,CAAC,CAAA;QACvE,QAAQ,CAAC,KAAK,EAAE,CAAA;QAEhB,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,OAAO,0BAA0B,EAAE,MAAM,CAAC,CAAA;QAE1E,6EAA6E;QAC7E,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,4CAA4C,CAAC,CAAA;QAEvE,+DAA+D;QAC/D,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CACvB;;;;UAII,CACL,CAAA;QAED,sEAAsE;QACtE,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CACvB;;;UAGI,CACL,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/index.d.ts

@@ -26,12 +26,13 @@ declare class Test2DocReporter implements Reporter {
     private updateProgressBar;
     onEnd(): void;
     private buildDocFiles;
-    private transformScreenshotFilename;
+    private generateHashedScreenshotFilename;
     private generateScreenshots;
     private cleanupTest2DocFiles;
     private extractDocMetadata;
     private generateHeader;
     private generateTitle;
+    private parseScreenshotMetadata;
     private generateMarkdown;
 }
 export default Test2DocReporter;

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EACV,QAAQ,EACR,KAAK,EACL,QAAQ,EACR,UAAU,EACV,QAAQ,EACT,MAAM,2BAA2B,CAAA;AAsClC,UAAU,uBAAuB;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAwBD;;;GAGG;AACH,cAAM,gBAAiB,YAAW,QAAQ;IACxC,OAAO,CAAC,IAAI,CAAgB;IAC5B,OAAO,CAAC,MAAM,CAA4C;IAC1D,OAAO,CAAC,SAAS,CAAQ;IACzB,OAAO,CAAC,mBAAmB,CAAsB;IACjD,OAAO,CAAC,cAAc,CAAoB;IAC1C,OAAO,CAAC,UAAU,CAAI;IACtB,OAAO,CAAC,cAAc,CAAI;IAC1B,OAAO,CAAC,WAAW,CAAgC;gBAGjD,OAAO,GAAE,uBAER;IAKH,OAAO,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK;IA+BzC,OAAO,CAAC,gBAAgB;IAYxB,OAAO,CAAC,aAAa;IAYrB,OAAO,CAAC,YAAY;IAmBpB,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,GAAG,IAAI;IAOtE,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,GAAG,IAAI;IAqBnE,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU;IAqB5C,OAAO,CAAC,iBAAiB;IAczB,KAAK;IAeL,OAAO,CAAC,aAAa;IA8BrB,OAAO,CAAC,2BAA2B;IAInC,OAAO,CAAC,mBAAmB;IAS3B,OAAO,CAAC,oBAAoB;IAqB5B,OAAO,CAAC,kBAAkB;IAW1B,OAAO,CAAC,cAAc;IAiCtB,OAAO,CAAC,aAAa;IAQrB,OAAO,CAAC,gBAAgB;CAiCzB;AAOD,eAAe,gBAAgB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EACV,QAAQ,EACR,KAAK,EACL,QAAQ,EACR,UAAU,EACV,QAAQ,EACT,MAAM,2BAA2B,CAAA;AAuClC,UAAU,uBAAuB;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAwBD;;;GAGG;AACH,cAAM,gBAAiB,YAAW,QAAQ;IACxC,OAAO,CAAC,IAAI,CAAgB;IAC5B,OAAO,CAAC,MAAM,CAA4C;IAC1D,OAAO,CAAC,SAAS,CAAQ;IACzB,OAAO,CAAC,mBAAmB,CAAsB;IACjD,OAAO,CAAC,cAAc,CAAoB;IAC1C,OAAO,CAAC,UAAU,CAAI;IACtB,OAAO,CAAC,cAAc,CAAI;IAC1B,OAAO,CAAC,WAAW,CAAgC;gBAGjD,OAAO,GAAE,uBAER;IAKH,OAAO,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK;IA+BzC,OAAO,CAAC,gBAAgB;IAYxB,OAAO,CAAC,aAAa;IAYrB,OAAO,CAAC,YAAY;IAmBpB,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,GAAG,IAAI;IAOtE,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,GAAG,IAAI;IAqBnE,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU;IAqB5C,OAAO,CAAC,iBAAiB;IAczB,KAAK;IAeL,OAAO,CAAC,aAAa;IA8BrB,OAAO,CAAC,gCAAgC;IAIxC,OAAO,CAAC,mBAAmB;IAS3B,OAAO,CAAC,oBAAoB;IAqB5B,OAAO,CAAC,kBAAkB;IAW1B,OAAO,CAAC,cAAc;IAiCtB,OAAO,CAAC,aAAa;IAQrB,OAAO,CAAC,uBAAuB;IAmB/B,OAAO,CAAC,gBAAgB;CAsDzB;AAOD,eAAe,gBAAgB,CAAA"}

package/dist/index.js

@@ -2,6 +2,7 @@ import { mkdirSync, readdirSync, rmdirSync, rmSync, statSync, unlinkSync, writeF
 import { activateTest2Doc } from "./DocMeta.js";
 import { convertToKebabCase } from "./utils.js";
 import { join } from "node:path";
+import crypto from "node:crypto";
 // TODO: remove this later, here right now as a hacky solution for testing
 activateTest2Doc();
 /**
@@ -145,7 +146,7 @@ class Test2DocReporter {
         if (metaType === "page") {
             const markdownHeader = this.generateHeader(metadata);
             const markdown = markdownHeader + this.generateMarkdown({ ...doc, title }, 1);
-            const filePath = `${outputDir}/test2doc-${convertToKebabCase(title)}.md`;
+            const filePath = `${outputDir}/test2doc-${convertToKebabCase(title)}.mdx`;
             writeFileSync(filePath, markdown);
             this.generateScreenshots(outputDir);
         }
@@ -160,17 +161,17 @@ class Test2DocReporter {
         }
         else {
             const markdown = this.generateMarkdown(doc, 1);
-            const filePath = `${outputDir}/test2doc-${convertToKebabCase(doc.title)}.md`;
+            const filePath = `${outputDir}/test2doc-${convertToKebabCase(doc.title)}.mdx`;
             writeFileSync(filePath, markdown);
             this.generateScreenshots(outputDir);
         }
     }
-    transformScreenshotFilename(name) {
-        return name.replace(/test2doc-\d+-/, "test2doc-");
+    generateHashedScreenshotFilename(image) {
+        return `test2doc-${crypto.createHash("sha256").update(image).digest("hex").slice(0, 12)}.png`;
     }
     generateScreenshots(output) {
-        this.screenshotMoveQueue.forEach(({ name, buffer }) => {
-            const filename = this.transformScreenshotFilename(name);
+        this.screenshotMoveQueue.forEach(({ buffer }) => {
+            const filename = this.generateHashedScreenshotFilename(buffer);
             const dest = `${output}/${filename}`;
             writeFileSync(dest, buffer);
         });
@@ -242,6 +243,21 @@ class Test2DocReporter {
         }
         return `${titleMarkdown} ${title}\n\n`;
     }
+    parseScreenshotMetadata(screenshotName) {
+        // Check for JSON metadata format: filename.png[test2doc_screenshot]:{"figure":true,"caption":"text"}
+        const jsonMatch = screenshotName.match(/\[test2doc_screenshot\]:(.+)$/);
+        if (jsonMatch?.[1]) {
+            try {
+                return JSON.parse(jsonMatch[1]);
+            }
+            catch {
+                // If JSON parsing fails, fall through to legacy format
+            }
+        }
+        // Legacy format: filename.png:altText
+        const [, caption] = screenshotName.split(":") ?? [];
+        return caption ? { caption } : {};
+    }
     generateMarkdown(docNode, depth) {
         let markdown = this.generateTitle(docNode.title, depth);
         if (docNode.tests) {
@@ -254,9 +270,25 @@ class Test2DocReporter {
                         }
                         if (step.screenshot) {
                             this.screenshotMoveQueue.push(step.screenshot);
-                            const [filename, altText] = step.screenshot.name.split(":") ?? [];
-                            const transformedFilename = this.transformScreenshotFilename(filename ?? step.screenshot.name);
-                            markdown += `![${altText ?? "screenshot"}](./${transformedFilename})\n`;
+                            const transformedFilename = this.generateHashedScreenshotFilename(step.screenshot.buffer);
+                            // Parse screenshot metadata (supports both legacy :altText and new JSON format)
+                            const { caption, figure } = this.parseScreenshotMetadata(step.screenshot.name);
+                            if (figure) {
+                                // Generate figure/figcaption format
+                                const altText = caption ?? "screenshot";
+                                markdown += `<figure>
+
+![${altText}](./${transformedFilename})${caption
+                                    ? `
+<figcaption>${caption}</figcaption>`
+                                    : ""}
+</figure>
+`;
+                            }
+                            else {
+                                // Generate standard markdown image
+                                markdown += `![${caption ?? "screenshot"}](./${transformedFilename})\n`;
+                            }
                         }
                     }
                     markdown += "\n";