Function create

examples/plugins/src/lighthouse/src/lighthouse.plugin.ts:50–84

(options: PluginOptions)

 *
 */
export async function create(options: PluginOptions) {
  const {
    // @NOTICE
    // Not all audits are implemented, so we always rely on the `onlyAudits` argument
    onlyAudits: onlyAuditsOption = audits.map(({ slug }) => slug),
    headless: headlessOption = true,
    outputPath,
  } = options;
  const onlyAudits = toArray(onlyAuditsOption);
  const headless = headlessOption ? ('new' as const) : false;

  // ensure output dir
  if (outputPath !== undefined) {
    await ensureDirectoryExists(path.dirname(outputPath));
  }

  return {
    slug: PLUGIN_SLUG,
    title: 'Lighthouse',
    icon: 'lighthouse',
    description: 'Chrome lighthouse CLI as code-pushup plugin',
    runner: runnerConfig({
      ...options,
      onlyAudits,
      // @NOTICE
      // Examples have a reduced scope, so we only execute the performance category here
      onlyCategories: ['performance'],
      headless,
    }),
    audits: audits.filter(({ slug }) => onlyAudits.includes(slug)),
    groups: filterItemRefsBy([categoryCorePerfGroup], ({ slug }) =>
      onlyAudits.includes(slug),
    ),
  } satisfies PluginConfig;
}

export function runnerConfig(options: LighthouseCliOptions): RunnerConfig {
  const {