@techsio/storybook-a11y-reporter 0.0.3 → 0.0.4

package/dist/cli.js

@@ -35,7 +35,11 @@ function formatSummary(entries) {
 }
 function readReport(filePath = 'a11y-report/report.json') {
     const resolvedPath = node_path.resolve(process.cwd(), filePath);
-    return fs_extra.readJSONSync(resolvedPath);
+    if (fs_extra.existsSync(resolvedPath)) return fs_extra.readJSONSync(resolvedPath);
+    const ndjsonPath = resolvedPath.endsWith('report.json') ? resolvedPath.replace(/report\.json$/, 'report.ndjson') : `${resolvedPath}.ndjson`;
+    if (!fs_extra.existsSync(ndjsonPath)) return [];
+    const content = fs_extra.readFileSync(ndjsonPath, 'utf8');
+    return content.split('\n').map((line)=>line.trim()).filter(Boolean).map((line)=>JSON.parse(line));
 }
 function printSummary(entries) {
     return formatSummary(entries);

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAmB,KAAK,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAEhF,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAC5C,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;CACrB;AAgHD,wBAAgB,kBAAkB,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,gBAAgB,CAkC9E;AAED,wBAAgB,UAAU,CAAC,QAAQ,SAA4B,GAAG,gBAAgB,EAAE,CAGnF;AAED,wBAAgB,YAAY,CAAC,OAAO,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAEhE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAmB,KAAK,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAEhF,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAC5C,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;CACrB;AAyID,wBAAgB,kBAAkB,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,gBAAgB,CA6C9E;AAED,wBAAgB,UAAU,CAAC,QAAQ,SAA4B,GAAG,gBAAgB,EAAE,CAoBnF;AAED,wBAAgB,YAAY,CAAC,OAAO,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAEhE"}

package/dist/index.js

@@ -76,31 +76,50 @@ function formatJUnit(entries) {
         ''
     ].join('\n');
 }
-async function writeReports(entries, options) {
+function getOutputPaths(options) {
     const outputDir = node_path.resolve(process.cwd(), options.outputDir);
+    return {
+        outputDir,
+        reportPath: node_path.join(outputDir, 'report.json'),
+        ndjsonPath: node_path.join(outputDir, 'report.ndjson'),
+        summaryPath: node_path.join(outputDir, 'summary.md'),
+        junitPath: node_path.join(outputDir, 'junit.xml')
+    };
+}
+async function appendEntry(entry, options) {
+    const { outputDir, ndjsonPath } = getOutputPaths(options);
+    await fs_extra.ensureDir(outputDir);
+    await fs_extra.appendFile(ndjsonPath, `${JSON.stringify(entry)}\n`);
+    return ndjsonPath;
+}
+async function readEntriesFromNdjson(ndjsonPath) {
+    const exists = await fs_extra.pathExists(ndjsonPath);
+    if (!exists) return [];
+    const content = await fs_extra.readFile(ndjsonPath, 'utf8');
+    return content.split('\n').map((line)=>line.trim()).filter(Boolean).map((line)=>JSON.parse(line));
+}
+async function writeReports(entries, options) {
+    const { outputDir, reportPath, summaryPath, junitPath } = getOutputPaths(options);
     await fs_extra.ensureDir(outputDir);
-    const reportPath = node_path.join(outputDir, 'report.json');
     await fs_extra.writeJSON(reportPath, entries, {
         spaces: 2
     });
-    const summaryPath = node_path.join(outputDir, 'summary.md');
     await fs_extra.writeFile(summaryPath, formatSummary(entries));
-    if (options.writeJUnit) {
-        const junitPath = node_path.join(outputDir, 'junit.xml');
-        await fs_extra.writeFile(junitPath, formatJUnit(entries));
-    }
+    if (options.writeJUnit) await fs_extra.writeFile(junitPath, formatJUnit(entries));
 }
 function createA11yReporter(options) {
     const resolved = resolveOptions(options);
-    const entries = [];
     return {
         async postVisit (page, context) {
             const storyId = context.id;
             const storyContext = await getStoryContext(page, context).catch(()=>null);
-            await page.waitForFunction((id)=>window.__TECHSIO_A11Y_RESULTS__?.storyId === id, storyId, {
+            const a11yParams = storyContext?.parameters?.a11y ?? null;
+            const a11yGlobals = storyContext?.globals?.a11y ?? null;
+            const shouldWaitForResults = a11yParams?.disable !== true && a11yParams?.test !== 'off' && a11yGlobals?.manual !== true;
+            if (shouldWaitForResults) await page.waitForFunction((id)=>window.__TECHSIO_A11Y_RESULTS__?.storyId === id, storyId, {
                 timeout: resolved.waitForResultsMs
             });
-            const pageResults = await page.evaluate(()=>window.__TECHSIO_A11Y_RESULTS__ ?? null);
+            const pageResults = shouldWaitForResults ? await page.evaluate(()=>window.__TECHSIO_A11Y_RESULTS__ ?? null) : null;
             const entry = {
                 storyId,
                 title: context.title,
@@ -109,7 +128,8 @@ function createA11yReporter(options) {
                 parameters: storyContext?.parameters?.a11y ?? null,
                 results: pageResults?.results ?? null
             };
-            entries.push(entry);
+            const ndjsonPath = await appendEntry(entry, resolved);
+            const entries = await readEntriesFromNdjson(ndjsonPath);
             await writeReports(entries, resolved);
             if (resolved.failOnViolations && countViolations(entry.results) > 0) throw new Error(`A11y violations detected in ${context.title} / ${context.name}`);
         }
@@ -117,7 +137,11 @@ function createA11yReporter(options) {
 }
 function readReport(filePath = 'a11y-report/report.json') {
     const resolvedPath = node_path.resolve(process.cwd(), filePath);
-    return fs_extra.readJSONSync(resolvedPath);
+    if (fs_extra.existsSync(resolvedPath)) return fs_extra.readJSONSync(resolvedPath);
+    const ndjsonPath = resolvedPath.endsWith('report.json') ? resolvedPath.replace(/report\.json$/, 'report.ndjson') : `${resolvedPath}.ndjson`;
+    if (!fs_extra.existsSync(ndjsonPath)) return [];
+    const content = fs_extra.readFileSync(ndjsonPath, 'utf8');
+    return content.split('\n').map((line)=>line.trim()).filter(Boolean).map((line)=>JSON.parse(line));
 }
 function printSummary(entries) {
     return formatSummary(entries);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@techsio/storybook-a11y-reporter",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Storybook a11y reporter with APCA support for CI/CLI",
   "type": "module",
   "repository": {