@code-pushup/lighthouse-plugin 0.123.0 → 0.124.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/lighthouse-plugin",
-  "version": "0.123.0",
+  "version": "0.124.0",
   "license": "MIT",
   "description": "Code PushUp plugin for measuring web performance and quality with Lighthouse 🔥",
   "homepage": "https://github.com/code-pushup/cli/tree/main/packages/plugin-lighthouse#readme",
@@ -36,8 +36,8 @@
   },
   "type": "module",
   "dependencies": {
-    "@code-pushup/models": "0.123.0",
-    "@code-pushup/utils": "0.123.0",
+    "@code-pushup/models": "0.124.0",
+    "@code-pushup/utils": "0.124.0",
     "ansis": "^3.3.0",
     "chrome-launcher": "^1.1.1",
     "lighthouse": "^12.0.0",

package/src/index.d.ts

@@ -6,3 +6,4 @@ export type { LighthouseGroupSlug, LighthouseOptions } from './lib/types.js';
 export { lighthousePlugin } from './lib/lighthouse-plugin.js';
 export default lighthousePlugin;
 export { lighthouseCategories, mergeLighthouseCategories, } from './lib/categories.js';
+export { lighthouseSetupBinding } from './lib/binding.js';

package/src/index.js

@@ -5,4 +5,5 @@ export { lighthouseAuditRef, lighthouseAuditRefs, lighthouseGroupRef, lighthouse
 export { lighthousePlugin } from './lib/lighthouse-plugin.js';
 export default lighthousePlugin;
 export { lighthouseCategories, mergeLighthouseCategories, } from './lib/categories.js';
+export { lighthouseSetupBinding } from './lib/binding.js';
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAE9D,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,EACL,oBAAoB,EACpB,sBAAsB,EACtB,sBAAsB,GACvB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,eAAe,gBAAgB,CAAC;AAChC,OAAO,EACL,oBAAoB,EACpB,yBAAyB,GAC1B,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAE9D,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,EACL,oBAAoB,EACpB,sBAAsB,EACtB,sBAAsB,GACvB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,eAAe,gBAAgB,CAAC;AAChC,OAAO,EACL,oBAAoB,EACpB,yBAAyB,GAC1B,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC"}

package/src/lib/binding.d.ts

@@ -0,0 +1,44 @@
+import type { CategoryCodegenConfig, PluginAnswer } from '@code-pushup/models';
+export declare const lighthouseSetupBinding: {
+    slug: string;
+    title: string;
+    packageName: string;
+    prompts: (_targetDir: string) => Promise<({
+        key: string;
+        message: string;
+        type: "input";
+        default: string;
+        choices?: undefined;
+    } | {
+        key: string;
+        message: string;
+        type: "checkbox";
+        choices: {
+            name: string;
+            value: string;
+        }[];
+        default: string[];
+    })[]>;
+    generateConfig: (answers: Record<string, PluginAnswer>) => {
+        imports: {
+            namedImports?: string[] | undefined;
+            moduleSpecifier: string;
+            defaultImport: string;
+        }[];
+        pluginInit: string[];
+        pluginDeclaration?: undefined;
+        categories?: undefined;
+    } | {
+        imports: {
+            namedImports?: string[] | undefined;
+            moduleSpecifier: string;
+            defaultImport: string;
+        }[];
+        pluginDeclaration: {
+            identifier: string;
+            expression: string;
+        };
+        pluginInit: string[];
+        categories: CategoryCodegenConfig[];
+    };
+};

package/src/lib/binding.js

@@ -0,0 +1,118 @@
+import { createRequire } from 'node:module';
+import { answerArray, answerNonEmptyArray, singleQuote, } from '@code-pushup/utils';
+import { LIGHTHOUSE_GROUP_SLUGS, LIGHTHOUSE_PLUGIN_SLUG, LIGHTHOUSE_PLUGIN_TITLE, } from './constants.js';
+const { name: PACKAGE_NAME } = createRequire(import.meta.url)('../../package.json');
+const DEFAULT_URL = 'http://localhost:4200';
+const PLUGIN_VAR = 'lhPlugin';
+const CATEGORY_TO_GROUP = {
+    performance: 'performance',
+    a11y: 'accessibility',
+    'best-practices': 'best-practices',
+    seo: 'seo',
+};
+const CATEGORIES = [
+    {
+        slug: 'performance',
+        title: 'Performance',
+        description: 'Measure performance and find opportunities to speed up page loads.',
+        refsExpression: `lighthouseGroupRefs(${PLUGIN_VAR}, 'performance')`,
+    },
+    {
+        slug: 'a11y',
+        title: 'Accessibility',
+        description: 'Determine if all users access content and navigate your site effectively.',
+        refsExpression: `lighthouseGroupRefs(${PLUGIN_VAR}, 'accessibility')`,
+    },
+    {
+        slug: 'best-practices',
+        title: 'Best Practices',
+        description: 'Improve code health of your web page following these best practices.',
+        refsExpression: `lighthouseGroupRefs(${PLUGIN_VAR}, 'best-practices')`,
+    },
+    {
+        slug: 'seo',
+        title: 'SEO',
+        description: 'Ensure that your page is optimized for search engine results ranking.',
+        refsExpression: `lighthouseGroupRefs(${PLUGIN_VAR}, 'seo')`,
+    },
+];
+const CATEGORY_CHOICES = CATEGORIES.map(({ slug, title }) => ({
+    name: title,
+    value: slug,
+}));
+const DEFAULT_CATEGORIES = CATEGORIES.map(({ slug }) => slug);
+export const lighthouseSetupBinding = {
+    slug: LIGHTHOUSE_PLUGIN_SLUG,
+    title: LIGHTHOUSE_PLUGIN_TITLE,
+    packageName: PACKAGE_NAME,
+    prompts: async (_targetDir) => [
+        {
+            key: 'lighthouse.urls',
+            message: 'Target URL(s) (comma-separated)',
+            type: 'input',
+            default: DEFAULT_URL,
+        },
+        {
+            key: 'lighthouse.categories',
+            message: 'Lighthouse categories',
+            type: 'checkbox',
+            choices: [...CATEGORY_CHOICES],
+            default: [...DEFAULT_CATEGORIES],
+        },
+    ],
+    generateConfig: (answers) => {
+        const options = parseAnswers(answers);
+        const hasCategories = options.categories.length > 0;
+        const imports = [
+            {
+                moduleSpecifier: PACKAGE_NAME,
+                defaultImport: 'lighthousePlugin',
+                ...(hasCategories ? { namedImports: ['lighthouseGroupRefs'] } : {}),
+            },
+        ];
+        const pluginCall = formatPluginCall(options);
+        if (!hasCategories) {
+            return {
+                imports,
+                pluginInit: [`${pluginCall},`],
+            };
+        }
+        return {
+            imports,
+            pluginDeclaration: {
+                identifier: PLUGIN_VAR,
+                expression: pluginCall,
+            },
+            pluginInit: [`${PLUGIN_VAR},`],
+            categories: createCategories(options),
+        };
+    },
+};
+function parseAnswers(answers) {
+    return {
+        urls: answerNonEmptyArray(answers, 'lighthouse.urls', DEFAULT_URL),
+        categories: answerArray(answers, 'lighthouse.categories'),
+    };
+}
+function formatPluginCall({ urls, categories }) {
+    const formattedUrls = formatUrls(urls);
+    const groups = categories.flatMap(slug => {
+        const group = CATEGORY_TO_GROUP[slug];
+        return group ? [group] : [];
+    });
+    if (groups.length === 0 || groups.length === LIGHTHOUSE_GROUP_SLUGS.length) {
+        return `lighthousePlugin(${formattedUrls})`;
+    }
+    const onlyGroups = groups.map(singleQuote).join(', ');
+    return `lighthousePlugin(${formattedUrls}, { onlyGroups: [${onlyGroups}] })`;
+}
+function formatUrls([first, ...rest]) {
+    if (rest.length === 0) {
+        return singleQuote(first);
+    }
+    return `[${[first, ...rest].map(singleQuote).join(', ')}]`;
+}
+function createCategories({ categories, }) {
+    return CATEGORIES.filter(({ slug }) => categories.includes(slug));
+}
+//# sourceMappingURL=binding.js.map

package/src/lib/binding.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"binding.js","sourceRoot":"","sources":["../../../src/lib/binding.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAM5C,OAAO,EACL,WAAW,EACX,mBAAmB,EACnB,WAAW,GACZ,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,GACxB,MAAM,gBAAgB,CAAC;AAGxB,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAC3D,oBAAoB,CACkB,CAAC;AAEzC,MAAM,WAAW,GAAG,uBAAuB,CAAC;AAC5C,MAAM,UAAU,GAAG,UAAU,CAAC;AAE9B,MAAM,iBAAiB,GAAwC;IAC7D,WAAW,EAAE,aAAa;IAC1B,IAAI,EAAE,eAAe;IACrB,gBAAgB,EAAE,gBAAgB;IAClC,GAAG,EAAE,KAAK;CACX,CAAC;AAEF,MAAM,UAAU,GAA4B;IAC1C;QACE,IAAI,EAAE,aAAa;QACnB,KAAK,EAAE,aAAa;QACpB,WAAW,EACT,oEAAoE;QACtE,cAAc,EAAE,uBAAuB,UAAU,kBAAkB;KACpE;IACD;QACE,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE,eAAe;QACtB,WAAW,EACT,2EAA2E;QAC7E,cAAc,EAAE,uBAAuB,UAAU,oBAAoB;KACtE;IACD;QACE,IAAI,EAAE,gBAAgB;QACtB,KAAK,EAAE,gBAAgB;QACvB,WAAW,EACT,sEAAsE;QACxE,cAAc,EAAE,uBAAuB,UAAU,qBAAqB;KACvE;IACD;QACE,IAAI,EAAE,KAAK;QACX,KAAK,EAAE,KAAK;QACZ,WAAW,EACT,uEAAuE;QACzE,cAAc,EAAE,uBAAuB,UAAU,UAAU;KAC5D;CACF,CAAC;AAEF,MAAM,gBAAgB,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5D,IAAI,EAAE,KAAK;IACX,KAAK,EAAE,IAAI;CACZ,CAAC,CAAC,CAAC;AAEJ,MAAM,kBAAkB,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;AAO9D,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,IAAI,EAAE,sBAAsB;IAC5B,KAAK,EAAE,uBAAuB;IAC9B,WAAW,EAAE,YAAY;IACzB,OAAO,EAAE,KAAK,EAAE,UAAkB,EAAE,EAAE,CAAC;QACrC;YACE,GAAG,EAAE,iBAAiB;YACtB,OAAO,EAAE,iCAAiC;YAC1C,IAAI,EAAE,OAAO;YACb,OAAO,EAAE,WAAW;SACrB;QACD;YACE,GAAG,EAAE,uBAAuB;YAC5B,OAAO,EAAE,uBAAuB;YAChC,IAAI,EAAE,UAAU;YAChB,OAAO,EAAE,CAAC,GAAG,gBAAgB,CAAC;YAC9B,OAAO,EAAE,CAAC,GAAG,kBAAkB,CAAC;SACjC;KACF;IACD,cAAc,EAAE,CAAC,OAAqC,EAAE,EAAE;QACxD,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,aAAa,GAAG,OAAO,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC;QACpD,MAAM,OAAO,GAAG;YACd;gBACE,eAAe,EAAE,YAAY;gBAC7B,aAAa,EAAE,kBAAkB;gBACjC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACpE;SACF,CAAC;QACF,MAAM,UAAU,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAE7C,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO;gBACL,OAAO;gBACP,UAAU,EAAE,CAAC,GAAG,UAAU,GAAG,CAAC;aAC/B,CAAC;QACJ,CAAC;QACD,OAAO;YACL,OAAO;YACP,iBAAiB,EAAE;gBACjB,UAAU,EAAE,UAAU;gBACtB,UAAU,EAAE,UAAU;aACvB;YACD,UAAU,EAAE,CAAC,GAAG,UAAU,GAAG,CAAC;YAC9B,UAAU,EAAE,gBAAgB,CAAC,OAAO,CAAC;SACtC,CAAC;IACJ,CAAC;CAC2B,CAAC;AAE/B,SAAS,YAAY,CACnB,OAAqC;IAErC,OAAO;QACL,IAAI,EAAE,mBAAmB,CAAC,OAAO,EAAE,iBAAiB,EAAE,WAAW,CAAC;QAClE,UAAU,EAAE,WAAW,CAAC,OAAO,EAAE,uBAAuB,CAAC;KAC1D,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,EAAE,IAAI,EAAE,UAAU,EAAqB;IAC/D,MAAM,aAAa,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IACvC,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACvC,MAAM,KAAK,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACtC,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9B,CAAC,CAAC,CAAC;IACH,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,KAAK,sBAAsB,CAAC,MAAM,EAAE,CAAC;QAC3E,OAAO,oBAAoB,aAAa,GAAG,CAAC;IAC9C,CAAC;IACD,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtD,OAAO,oBAAoB,aAAa,oBAAoB,UAAU,MAAM,CAAC;AAC/E,CAAC;AAED,SAAS,UAAU,CAAC,CAAC,KAAK,EAAE,GAAG,IAAI,CAAwB;IACzD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;IACD,OAAO,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;AAC7D,CAAC;AAED,SAAS,gBAAgB,CAAC,EACxB,UAAU,GACQ;IAClB,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;AACpE,CAAC"}