@code-pushup/lighthouse-plugin 0.49.0 → 0.50.0

package/index.js

@@ -1,6 +1,6 @@
 // packages/plugin-lighthouse/package.json
 var name = "@code-pushup/lighthouse-plugin";
-var version = "0.49.0";
+var version = "0.50.0";
 
 // packages/plugin-lighthouse/src/lib/constants.ts
 import { join } from "node:path";
@@ -676,6 +676,8 @@ var auditResultSchema = scorableWithPluginMetaSchema.merge(
 );
 var reportsDiffSchema = z15.object({
   commits: makeComparisonSchema(commitSchema).nullable().describe("Commits identifying compared reports"),
+  portalUrl: urlSchema.optional().describe("Link to comparison page in Code PushUp portal"),
+  label: z15.string().optional().describe("Label (e.g. project name)"),
   categories: makeArraysComparisonSchema(
     categoryDiffSchema,
     categoryResultSchema,
@@ -720,6 +722,13 @@ import { md } from "build-md";
 // packages/utils/src/lib/reports/constants.ts
 var TERMINAL_WIDTH = 80;
 
+// packages/utils/src/lib/reports/utils.ts
+function formatReportScore(score) {
+  const scaledScore = score * 100;
+  const roundedScore = Math.round(scaledScore);
+  return roundedScore === 100 && score !== 1 ? Math.floor(scaledScore).toString() : roundedScore.toString();
+}
+
 // packages/utils/src/lib/file-system.ts
 import { bold, gray } from "ansis";
 import { bundleRequire } from "bundle-require";
@@ -960,17 +969,23 @@ var html = {
 };
 
 // packages/utils/src/lib/reports/formatting.ts
-import { MarkdownDocument, md as md2 } from "build-md";
+import {
+  MarkdownDocument,
+  md as md2
+} from "build-md";
 
 // packages/utils/src/lib/reports/generate-md-report-categoy-section.ts
 import { MarkdownDocument as MarkdownDocument2, md as md3 } from "build-md";
 
 // packages/utils/src/lib/reports/generate-md-reports-diff.ts
 import {
-  MarkdownDocument as MarkdownDocument4,
-  md as md5
+  MarkdownDocument as MarkdownDocument5,
+  md as md6
 } from "build-md";
 
+// packages/utils/src/lib/reports/generate-md-reports-diff-utils.ts
+import { MarkdownDocument as MarkdownDocument4, md as md5 } from "build-md";
+
 // packages/utils/src/lib/reports/log-stdout-summary.ts
 import { bold as bold4, cyan, cyanBright, green as green2, red } from "ansis";
 
@@ -1188,7 +1203,6 @@ function parseTableToAuditDetailsTable(details2) {
   }
   try {
     return tableSchema().parse({
-      title: "Table",
       columns: parseTableColumns(rawHeadings),
       rows: items.map((row) => parseTableRow(row, rawHeadings))
     });
@@ -1322,19 +1336,7 @@ function logUnsupportedDetails(lhrAudits, { displayCount = 3 } = {}) {
 // packages/plugin-lighthouse/src/lib/runner/utils.ts
 function normalizeAuditOutputs(auditOutputs, flags = { skipAudits: [] }) {
   const toSkip = new Set(flags.skipAudits ?? []);
-  return auditOutputs.filter(({ slug }) => {
-    const doSkip = toSkip.has(slug);
-    if (doSkip) {
-      ui().logger.info(
-        `Audit ${bold8(
-          slug
-        )} was included in audit outputs of lighthouse but listed under ${bold8(
-          "skipAudits"
-        )}.`
-      );
-    }
-    return !doSkip;
-  });
+  return auditOutputs.filter(({ slug }) => !toSkip.has(slug));
 }
 var LighthouseAuditParsingError = class extends Error {
   constructor(slug, error) {
@@ -1343,37 +1345,37 @@ Audit ${bold8(slug)} failed parsing details:
 ${error.message}`);
   }
 };
+function formatBaseAuditOutput(lhrAudit) {
+  const {
+    id: slug,
+    score,
+    numericValue,
+    displayValue,
+    scoreDisplayMode
+  } = lhrAudit;
+  return {
+    slug,
+    score: score ?? 1,
+    value: numericValue ?? score ?? 0,
+    displayValue: displayValue ?? (scoreDisplayMode === "binary" ? score === 1 ? "passed" : "failed" : score ? `${formatReportScore(score)}%` : void 0)
+  };
+}
+function processAuditDetails(auditOutput, details2) {
+  try {
+    const parsedDetails = toAuditDetails(details2);
+    return Object.keys(parsedDetails).length > 0 ? { ...auditOutput, details: parsedDetails } : auditOutput;
+  } catch (error) {
+    throw new LighthouseAuditParsingError(auditOutput.slug, error);
+  }
+}
 function toAuditOutputs(lhrAudits, { verbose = false } = {}) {
   if (verbose) {
     logUnsupportedDetails(lhrAudits);
   }
-  return lhrAudits.map(
-    ({
-      id: slug,
-      score,
-      numericValue: value = 0,
-      // not every audit has a numericValue
-      details: details2,
-      displayValue
-    }) => {
-      const auditOutput = {
-        slug,
-        score: score ?? 1,
-        // score can be null
-        value,
-        displayValue
-      };
-      if (details2 != null) {
-        try {
-          const parsedDetails = toAuditDetails(details2);
-          return Object.keys(parsedDetails).length > 0 ? { ...auditOutput, details: parsedDetails } : auditOutput;
-        } catch (error) {
-          throw new LighthouseAuditParsingError(slug, error);
-        }
-      }
-      return auditOutput;
-    }
-  );
+  return lhrAudits.map((audit) => {
+    const auditOutput = formatBaseAuditOutput(audit);
+    return audit.details == null ? auditOutput : processAuditDetails(auditOutput, audit.details);
+  });
 }
 function determineAndSetLogLevel({
   verbose,
@@ -1485,7 +1487,7 @@ function normalizeFlags(flags) {
       ([flagName]) => !LIGHTHOUSE_UNSUPPORTED_CLI_FLAGS.has(
         flagName
       )
-    ).map(([key, v]) => [key === "onlyGroups" ? "onlyCategories" : key, v]).map(([key, v]) => {
+    ).map(([key, v]) => [key === "onlyGroups" ? "onlyCategories" : key, v]).filter(([_, v]) => !(Array.isArray(v) && v.length === 0)).map(([key, v]) => {
       if (!REFINED_STRING_OR_STRING_ARRAY.has(key)) {
         return [key, v];
       }
@@ -1596,12 +1598,7 @@ function filterAuditsAndGroupsByOnlyOptions(audits2, groups, options) {
 
 // packages/plugin-lighthouse/src/lib/lighthouse-plugin.ts
 function lighthousePlugin(url, flags) {
-  const {
-    skipAudits = [],
-    onlyAudits = [],
-    onlyCategories: onlyCategories2 = [],
-    ...unparsedFlags
-  } = normalizeFlags(flags ?? {});
+  const { skipAudits, onlyAudits, onlyCategories: onlyCategories2, ...unparsedFlags } = normalizeFlags(flags ?? {});
   const { audits: audits2, groups } = filterAuditsAndGroupsByOnlyOptions(
     LIGHTHOUSE_NAVIGATION_AUDITS,
     LIGHTHOUSE_GROUPS,

package/package.json

@@ -1,15 +1,16 @@
 {
   "name": "@code-pushup/lighthouse-plugin",
-  "version": "0.49.0",
+  "version": "0.50.0",
   "license": "MIT",
+  "description": "Code PushUp plugin for measuring web performance and quality with Lighthouse 🔥",
   "dependencies": {
-    "@code-pushup/models": "0.49.0",
-    "@code-pushup/utils": "0.49.0",
+    "@code-pushup/models": "0.50.0",
+    "@code-pushup/utils": "0.50.0",
     "ansis": "^3.3.0",
     "lighthouse": "^12.0.0",
     "lighthouse-logger": "2.0.1"
   },
-  "homepage": "https://github.com/code-pushup/cli#readme",
+  "homepage": "https://github.com/code-pushup/cli/tree/main/packages/plugin-lighthouse#readme",
   "bugs": {
     "url": "https://github.com/code-pushup/cli/issues"
   },
@@ -18,33 +19,6 @@
     "url": "git+https://github.com/code-pushup/cli.git",
     "directory": "packages/plugin-lighthouse"
   },
-  "contributors": [
-    {
-      "name": "Igor Katsuba",
-      "email": "igor@katsuba.dev",
-      "url": "https://katsuba.dev"
-    },
-    {
-      "name": "Kateřina Pilátová",
-      "email": "katerina.pilatova@flowup.cz",
-      "url": "https://github.com/Tlacenka"
-    },
-    {
-      "name": "Matěj Chalk",
-      "email": "matej.chalk@flowup.cz",
-      "url": "https://github.com/matejchalk"
-    },
-    {
-      "name": "Michael Hladky",
-      "email": "michael.hladky@push-based.io",
-      "url": "https://push-based.io"
-    },
-    {
-      "name": "Michael Seredenko",
-      "email": "misha.seredenko@push-based.io",
-      "url": "https://github.com/MishaSeredenkoPushBased"
-    }
-  ],
   "type": "module",
   "main": "./index.js",
   "types": "./src/index.d.ts"

package/src/index.d.ts

@@ -1,7 +1,7 @@
 import { lighthousePlugin } from './lib/lighthouse-plugin';
 export { LIGHTHOUSE_REPORT_NAME } from './lib/runner';
 export { LIGHTHOUSE_PLUGIN_SLUG, LIGHTHOUSE_OUTPUT_PATH, } from './lib/constants';
-export { lighthouseAuditRef, lighthouseGroupRef, LighthouseGroupSlugs, } from './lib/utils';
-export { LighthouseOptions } from './lib/types';
+export { lighthouseAuditRef, lighthouseGroupRef, type LighthouseGroupSlugs, } from './lib/utils';
+export type { LighthouseOptions } from './lib/types';
 export { lighthousePlugin } from './lib/lighthouse-plugin';
 export default lighthousePlugin;

package/src/lib/normalize-flags.d.ts

@@ -1,4 +1,4 @@
-import { LighthouseCliFlags } from './runner';
+import { type LighthouseCliFlags } from './runner';
 import type { LighthouseOptions } from './types';
 export declare const DEFAULT_LIGHTHOUSE_OPTIONS: {
     onlyGroups: never[];

package/src/lib/runner/details/details.d.ts

@@ -1,7 +1,7 @@
 import type { FormattedIcu } from 'lighthouse';
 import type Details from 'lighthouse/types/lhr/audit-details';
-import { Result } from 'lighthouse/types/lhr/audit-result';
-import { AuditDetails } from '@code-pushup/models';
+import type { Result } from 'lighthouse/types/lhr/audit-result';
+import type { AuditDetails } from '@code-pushup/models';
 export declare function toAuditDetails<T extends FormattedIcu<Details>>(details: T | undefined): AuditDetails;
 export declare const unsupportedDetailTypes: Set<string>;
 export declare function logUnsupportedDetails(lhrAudits: Result[], { displayCount }?: {

package/src/lib/runner/details/opportunity.type.d.ts

@@ -1,5 +1,5 @@
 import type Details from 'lighthouse/types/lhr/audit-details';
-import { Table, TableRowObject } from '@code-pushup/models';
+import { type Table, type TableRowObject } from '@code-pushup/models';
 export declare function parseOpportunityToAuditDetailsTable(details: Details.Opportunity): Table | undefined;
 export declare function parseOpportunityItemToTableRow(opportunityItem: Details.OpportunityItem, headings: Details.TableColumnHeading[]): TableRowObject;
 export declare function parseOpportunityEntry([key, value]: [

package/src/lib/runner/details/table.type.d.ts

@@ -1,5 +1,5 @@
 import type Details from 'lighthouse/types/lhr/audit-details';
-import { Table, TableColumnObject, TableRowObject } from '@code-pushup/models';
+import { type Table, type TableColumnObject, type TableRowObject } from '@code-pushup/models';
 export declare function parseTableToAuditDetailsTable(details: Details.Table): Table | undefined;
 export declare function parseTableColumns(rawHeadings: Details.TableColumnHeading[]): TableColumnObject[];
 export declare function parseTableRow(tableItem: Details.TableItem, headings: Details.TableColumnHeading[]): TableRowObject;

package/src/lib/runner/details/utils.d.ts

@@ -1,4 +1,4 @@
-import Details from 'lighthouse/types/lhr/audit-details';
+import type Details from 'lighthouse/types/lhr/audit-details';
 export declare class LighthouseAuditDetailsParsingError extends Error {
     constructor(type: Details['type'], rawTable: Record<string, unknown>, error: string);
 }

package/src/lib/runner/index.d.ts

@@ -1,3 +1,3 @@
 export { createRunnerFunction } from './runner';
 export { LIGHTHOUSE_REPORT_NAME, LIGHTHOUSE_NAVIGATION_AUDITS, LIGHTHOUSE_GROUPS, DEFAULT_CLI_FLAGS, } from './constants';
-export { LighthouseCliFlags } from './types';
+export type { LighthouseCliFlags } from './types';

package/src/lib/runner/runner.d.ts

@@ -1,3 +1,3 @@
-import { RunnerFunction } from '@code-pushup/models';
-import { LighthouseCliFlags } from './types';
+import type { RunnerFunction } from '@code-pushup/models';
+import type { LighthouseCliFlags } from './types';
 export declare function createRunnerFunction(urlUnderTest: string, flags?: LighthouseCliFlags): RunnerFunction;

package/src/lib/runner/utils.d.ts

@@ -1,8 +1,8 @@
 import type { Config } from 'lighthouse';
-import { Result } from 'lighthouse/types/lhr/audit-result';
-import { AuditOutputs } from '@code-pushup/models';
+import type { Result } from 'lighthouse/types/lhr/audit-result';
+import type { AuditOutputs } from '@code-pushup/models';
 import type { LighthouseOptions } from '../types';
-import { LighthouseCliFlags } from './types';
+import type { LighthouseCliFlags } from './types';
 export declare function normalizeAuditOutputs(auditOutputs: AuditOutputs, flags?: LighthouseOptions): AuditOutputs;
 export declare class LighthouseAuditParsingError extends Error {
     constructor(slug: string, error: Error);

package/src/lib/types.d.ts

@@ -1,5 +1,5 @@
 import type { CliFlags } from 'lighthouse';
-import { ExcludeNullFromPropertyTypes } from '@code-pushup/utils';
+import type { ExcludeNullFromPropertyTypes } from '@code-pushup/utils';
 export type LighthouseOptions = ExcludeNullFromPropertyTypes<Partial<Omit<CliFlags, '_' | 'precomputedLanternDataPath' | 'enableErrorReporting' | 'list-all-audits' | 'list-locales' | 'list-trace-categories' | 'chromeIgnoreDefaultFlags' | 'onlyCategories' | 'onlyAudits' | 'skipAudits'>>> & {
     onlyGroups?: string | string[];
     onlyAudits?: string | string[];

package/src/lib/utils.d.ts

@@ -1,5 +1,5 @@
-import { Audit, CategoryRef, Group } from '@code-pushup/models';
-import { LighthouseCliFlags } from './runner';
+import type { Audit, CategoryRef, Group } from '@code-pushup/models';
+import type { LighthouseCliFlags } from './runner';
 export type LighthouseGroupSlugs = 'performance' | 'accessibility' | 'best-practices' | 'seo' | 'pwa';
 export declare function lighthouseGroupRef(groupSlug: LighthouseGroupSlugs, weight?: number): CategoryRef;
 export declare function lighthouseAuditRef(auditSlug: string, weight?: number): CategoryRef;