lighthouse-reporting 1.4.0 → 1.6.0

package/README.md

@@ -100,6 +100,8 @@ const lhScoresDir = path.join(process.cwd(), process.env.LH_SCORES_DIR || 'lh-sc
 const reportDir = path.join(process.cwd(), process.env.LH_REPORT_DIR || 'lighthouse')
 const htmlFilePath = path.join(reportDir, 'index.html')
 
+// use stories.json instead of index.json for storybook v6
+// make sure to set buildStoriesJson to true in storybook main.js feature section
 const stories = storybookPlaywright.getStories('./storybook-static/index.json', (story) => {
     // skip docs, etc
     if (story.type !== 'story') {
@@ -233,10 +235,11 @@ export default globalSetup
 import { lighthousePlaywrightTeardown, buildAverageCsv } from 'lighthouse-reporting'
 
 const lhScoresDir = path.join(process.cwd(), process.env.LH_SCORES_DIR || 'lh-scores')
+const reportDir = path.join(process.cwd(), 'lighthouse')
 
 async function globalTeardown() {
     await lighthousePlaywrightTeardown()
-    await buildAverageCsv(lhScoresDir)
+    await buildAverageCsv(lhScoresDir, reportDir)
 }
 
 export default globalTeardown

package/dist/lighthouse-reporting.umd.cjs

@@ -77,9 +77,12 @@
     }
     await fse.writeFile(path.join(lhScoresDir, `${name}.json`), JSON.stringify(json, null, 2));
   };
-  const buildAverageCsv = async (lhScoresDir) => {
+  const buildAverageCsv = async (lhScoresDir, reportDir2) => {
     const files = await fse.readdir(lhScoresDir);
     const jsonFiles = files.filter((f) => f.endsWith(".json"));
+    if (jsonFiles.length === 0) {
+      return;
+    }
     const scores = {};
     for (const fileName of jsonFiles) {
       const score = await fse.readJson(
@@ -95,7 +98,7 @@
     Object.entries(scores).forEach(([k, v]) => {
       scores[k] = v / jsonFiles.length;
     });
-    await writeCsvResult(lhScoresDir, "_AVERAGE_", scores);
+    await writeCsvResult(reportDir2, "_AVERAGE_", scores);
   };
   class Locked extends Error {
     constructor(port) {
@@ -236,7 +239,8 @@
         throw new Error("Please build storybook before running tests!");
       }
       const storybookIndexJson = fse.readJsonSync(pathToStorybookIndexJson);
-      const stories = Object.values(storybookIndexJson.entries).filter(storyFilterFn);
+      const storyObject = storybookIndexJson.entries || storybookIndexJson.stories;
+      const stories = Object.values(storyObject).filter(storyFilterFn);
       return stories;
     },
     captureScreenshot: async (story, context, screenshotOptions, actionBeforeScreenshot) => {

package/dist/lighthouseReports.cjs

@@ -58,9 +58,12 @@ const writeScoresToJson = async (lhScoresDir, name, scores, result) => {
   }
   await fse.writeFile(path.join(lhScoresDir, `${name}.json`), JSON.stringify(json, null, 2));
 };
-const buildAverageCsv = async (lhScoresDir) => {
+const buildAverageCsv = async (lhScoresDir, reportDir) => {
   const files = await fse.readdir(lhScoresDir);
   const jsonFiles = files.filter((f) => f.endsWith(".json"));
+  if (jsonFiles.length === 0) {
+    return;
+  }
   const scores = {};
   for (const fileName of jsonFiles) {
     const score = await fse.readJson(
@@ -76,7 +79,7 @@ const buildAverageCsv = async (lhScoresDir) => {
   Object.entries(scores).forEach(([k, v]) => {
     scores[k] = v / jsonFiles.length;
   });
-  await writeCsvResult(lhScoresDir, "_AVERAGE_", scores);
+  await writeCsvResult(reportDir, "_AVERAGE_", scores);
 };
 exports.buildAverageCsv = buildAverageCsv;
 exports.getScores = getScores;

package/dist/lighthouseReports.d.ts

@@ -52,7 +52,9 @@ export declare const writeHtmlListEntryWithRetry: (htmlFilePath: string, name: s
 export declare const getScores: (result: LighthouseResult) => Record<string, number>;
 export declare const writeScoresToJson: (lhScoresDir: string, name: string, scores: Record<string, number>, result: LighthouseResult) => Promise<void>;
 /**
- * Generate average csv file. Make sure to use writeScoresToJson in your test!
+ * Generate average csv file. Make sure to use `writeScoresToJson` in your test!
+ * @param lhScoresDir path to folder with lighthouse json files. See `writeScoresToJson`.
+ * @param reportDir folder where `_AVERAGE_.json` will be generated
  */
-export declare const buildAverageCsv: (lhScoresDir: string) => Promise<void>;
+export declare const buildAverageCsv: (lhScoresDir: string, reportDir: string) => Promise<void>;
 export {};

package/dist/lighthouseReports.js

@@ -56,9 +56,12 @@ const writeScoresToJson = async (lhScoresDir, name, scores, result) => {
   }
   await fse.writeFile(path.join(lhScoresDir, `${name}.json`), JSON.stringify(json, null, 2));
 };
-const buildAverageCsv = async (lhScoresDir) => {
+const buildAverageCsv = async (lhScoresDir, reportDir) => {
   const files = await fse.readdir(lhScoresDir);
   const jsonFiles = files.filter((f) => f.endsWith(".json"));
+  if (jsonFiles.length === 0) {
+    return;
+  }
   const scores = {};
   for (const fileName of jsonFiles) {
     const score = await fse.readJson(
@@ -74,7 +77,7 @@ const buildAverageCsv = async (lhScoresDir) => {
   Object.entries(scores).forEach(([k, v]) => {
     scores[k] = v / jsonFiles.length;
   });
-  await writeCsvResult(lhScoresDir, "_AVERAGE_", scores);
+  await writeCsvResult(reportDir, "_AVERAGE_", scores);
 };
 export {
   buildAverageCsv,

package/dist/storybookPlaywright.cjs

@@ -9,7 +9,8 @@ const storybookPlaywright = {
       throw new Error("Please build storybook before running tests!");
     }
     const storybookIndexJson = fse.readJsonSync(pathToStorybookIndexJson);
-    const stories = Object.values(storybookIndexJson.entries).filter(storyFilterFn);
+    const storyObject = storybookIndexJson.entries || storybookIndexJson.stories;
+    const stories = Object.values(storyObject).filter(storyFilterFn);
     return stories;
   },
   captureScreenshot: async (story, context, screenshotOptions, actionBeforeScreenshot) => {

package/dist/storybookPlaywright.d.ts

@@ -1,4 +1,7 @@
 import { BrowserContext, Locator, Page } from '@playwright/test';
+/**
+ * Storybook v7
+ */
 export interface StorybookIndexStory {
     id: string;
     title: string;
@@ -7,9 +10,24 @@ export interface StorybookIndexStory {
     tags: Array<string>;
     type: 'story' | 'docs';
 }
-type StoriesFilterFn = (story: StorybookIndexStory) => boolean;
+/**
+ * Storybook v6
+ */
+export interface StorybookStoriesStory {
+    id: string;
+    title: string;
+    name: string;
+    importPath: string;
+    kind: string;
+    story: string;
+    parameters: {
+        __id: string;
+        docsOnly: boolean;
+        fileName: string;
+    };
+}
 export declare const storybookPlaywright: {
-    getStories: (pathToStorybookIndexJson: string, storyFilterFn: StoriesFilterFn) => StorybookIndexStory[];
+    getStories: <V7 = true>(pathToStorybookIndexJson: string, storyFilterFn: (story: V7 extends true ? StorybookIndexStory : StorybookStoriesStory) => boolean) => StorybookIndexStory[];
     captureScreenshot: (story: StorybookIndexStory, context: BrowserContext, screenshotOptions?: {
         /**
          * When set to `"disabled"`, stops CSS animations, CSS transitions and Web Animations. Animations get different
@@ -91,4 +109,3 @@ export declare const storybookPlaywright: {
         timeout?: number;
     }, actionBeforeScreenshot?: ((page: Page) => Promise<void>) | undefined) => Promise<void>;
 };
-export {};

package/dist/storybookPlaywright.js

@@ -7,7 +7,8 @@ const storybookPlaywright = {
       throw new Error("Please build storybook before running tests!");
     }
     const storybookIndexJson = fse.readJsonSync(pathToStorybookIndexJson);
-    const stories = Object.values(storybookIndexJson.entries).filter(storyFilterFn);
+    const storyObject = storybookIndexJson.entries || storybookIndexJson.stories;
+    const stories = Object.values(storyObject).filter(storyFilterFn);
     return stories;
   },
   captureScreenshot: async (story, context, screenshotOptions, actionBeforeScreenshot) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lighthouse-reporting",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "type": "module",
   "scripts": {
     "build": "vite build && vite build -c vite.umd.config.ts && tsc -p ./tsconfig.build.json",