@code-pushup/lighthouse-plugin 0.42.0

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@code-pushup/lighthouse-plugin",
+  "version": "0.42.0",
+  "license": "MIT",
+  "dependencies": {
+    "@code-pushup/models": "0.42.0",
+    "lighthouse": "^11.0.0",
+    "@code-pushup/utils": "0.42.0",
+    "lighthouse-logger": "2.0.1",
+    "chalk": "^5.3.0"
+  },
+  "homepage": "https://github.com/code-pushup/cli#readme",
+  "bugs": {
+    "url": "https://github.com/code-pushup/cli/issues"
+  },
+  "repository": {
+    "type": "git",
+    "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

@@ -0,0 +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 { lighthousePlugin } from './lib/lighthouse-plugin';
+export default lighthousePlugin;

package/src/lib/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const LIGHTHOUSE_PLUGIN_SLUG = "lighthouse";
+export declare const LIGHTHOUSE_OUTPUT_PATH: string;

package/src/lib/lighthouse-plugin.d.ts

@@ -0,0 +1,3 @@
+import type { PluginConfig } from '@code-pushup/models';
+import type { LighthouseOptions } from './types';
+export declare function lighthousePlugin(url: string, flags?: LighthouseOptions): PluginConfig;

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

@@ -0,0 +1,20 @@
+import { LighthouseCliFlags } from './runner';
+import type { LighthouseOptions } from './types';
+export declare const DEFAULT_LIGHTHOUSE_OPTIONS: {
+    onlyGroups: never[];
+    verbose: false;
+    quiet: false;
+    saveAssets: false;
+    chromeFlags: string[];
+    port: number;
+    hostname: string;
+    view: false;
+    channel: string;
+    onlyAudits: never[];
+    skipAudits: never[];
+    budgets: never[];
+    output: "json"[];
+    outputPath: string;
+};
+export declare function normalizeFlags(flags?: LighthouseOptions): LighthouseCliFlags;
+export declare function logUnsupportedFlagsInUse(flags: LighthouseOptions, displayCount?: number): void;

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

@@ -0,0 +1,21 @@
+import type { Audit, Group } from '@code-pushup/models';
+export declare const PLUGIN_SLUG = "lighthouse";
+export declare const LIGHTHOUSE_NAVIGATION_AUDITS: Audit[];
+export declare const LIGHTHOUSE_GROUPS: Group[];
+export declare const LIGHTHOUSE_REPORT_NAME = "lighthouse-report.json";
+export declare const DEFAULT_CLI_FLAGS: {
+    verbose: false;
+    quiet: false;
+    saveAssets: false;
+    chromeFlags: string[];
+    port: number;
+    hostname: string;
+    view: false;
+    channel: string;
+    onlyAudits: never[];
+    skipAudits: never[];
+    onlyCategories: never[];
+    budgets: never[];
+    output: "json"[];
+    outputPath: string;
+};

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

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

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

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

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

@@ -0,0 +1,10 @@
+import type { Budget } from 'lighthouse';
+import type { LighthouseOptions } from '../types';
+export type NormalizedFlags = {
+    chromeFlags: string[];
+    onlyAudits: string[];
+    onlyCategories: string[];
+    skipAudits: string[];
+    budgets: Budget[];
+};
+export type LighthouseCliFlags = Omit<LighthouseOptions, keyof NormalizedFlags> & NormalizedFlags;

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

@@ -0,0 +1,20 @@
+import type { Budget, Config } from 'lighthouse';
+import { Result } from 'lighthouse/types/lhr/audit-result';
+import { AuditOutputs } from '@code-pushup/models';
+import type { LighthouseOptions } from '../types';
+import { LighthouseCliFlags } from './types';
+export declare function normalizeAuditOutputs(auditOutputs: AuditOutputs, flags?: LighthouseOptions): AuditOutputs;
+export declare function toAuditOutputs(lhrAudits: Result[], { verbose }?: {
+    verbose?: boolean;
+}): AuditOutputs;
+export declare const unsupportedDetailTypes: Set<string>;
+export declare function logUnsupportedDetails(lhrAudits: Result[], { displayCount }?: {
+    displayCount?: number;
+}): void;
+export declare function setLogLevel({ verbose, quiet, }?: {
+    verbose?: boolean;
+    quiet?: boolean;
+}): void;
+export type ConfigOptions = Partial<Pick<LighthouseCliFlags, 'configPath' | 'preset'>>;
+export declare function getConfig(options?: ConfigOptions): Promise<Config | undefined>;
+export declare function getBudgets(budgetPath?: string): Promise<Budget[]>;

package/src/lib/types.d.ts

@@ -0,0 +1,7 @@
+import type { CliFlags } from 'lighthouse';
+import { 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[];
+    skipAudits?: string | string[];
+};

package/src/lib/utils.d.ts

@@ -0,0 +1,18 @@
+import { Audit, CategoryRef, Group } from '@code-pushup/models';
+import { 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;
+export declare class AuditsNotImplementedError extends Error {
+    constructor(auditSlugs: string[]);
+}
+export declare function validateAudits(audits: Audit[], onlyAudits: string[]): boolean;
+export declare class CategoriesNotImplementedError extends Error {
+    constructor(categorySlugs: string[]);
+}
+export declare function validateOnlyCategories(groups: Group[], onlyCategories: string | string[]): boolean;
+export type FilterOptions = Partial<Pick<LighthouseCliFlags, 'onlyAudits' | 'onlyCategories' | 'skipAudits'>>;
+export declare function filterAuditsAndGroupsByOnlyOptions(audits: Audit[], groups: Group[], options?: FilterOptions): {
+    audits: Audit[];
+    groups: Group[];
+};