@code-pushup/models

@code-pushup/models

Model definitions and validators for the Code PushUp CLI.

For a full list of models defined by this package, see the auto-generated Code PushUp models reference.

Setup

If you've already installed another @code-pushup/* package, then you may have already installed @code-pushup/models indirectly.

If not, you can always install it separately:

npm install --save-dev @code-pushup/models

yarn add --dev @code-pushup/models

pnpm add --save-dev @code-pushup/models

Usage

Import the type definitions if using TypeScript:

• in code-pushup.config.ts:

  import type { CoreConfig } from '@code-pushup/models';
  
  export default {
    // ... this is type-checked ...
  } satisfies CoreConfig;
  

• in custom plugin:

  import type { PluginConfig } from '@code-pushup/models';
  
  export default function myCustomPlugin(): PluginConfig {
    return {
      // ... this is type-checked ...
    };
  }
  

  import type { AuditOutput } from '@code-pushup/models';
  
  async function myCustomPluginRunner() {
    const audits: AuditOutput[] = await collectAudits();
  
    await writeFile(RUNNER_OUTPUT_FILE, JSON.strinfigy(audits));
  }
  

If you need runtime validation, use the underlying Zod schemas:

import { coreConfigSchema } from '@code-pushup/models';

const json = JSON.parse(readFileSync('code-pushup.config.json'));
const config = coreConfigSchema.parse(json); // throws ZodError if invalid

Changelog

0.48.0 (2024-07-15)

🚀 Features

• implement skip-plugins option (73695855)
• add skipPlugin options to global configs (64f45dab)
• nx-plugin: add general executor logic (3b5b9770)
• plugin-lighthouse: parse opportunity details from lighthouse report (2e76d08c)
• testing-utils: add test helper for paths (ccef3a1c)
• utils: merge configs function (ac67ea5c)
• utils: add explicit types to merge config function and helpers (e16c1c43)
• utils: export merge configs helper as public API (2f8d78e4)

🩹 Fixes

• restore e2e tests (9a2e45b9)
• nx-plugin: fix lint (d6161599)
• nx-plugin: fix test for windows (4fed38cf)
• utils: unchanged categories table markdown content (1df3ccb6)

❤️ Thank You

• Matěj Chalk
• Michael @rx-angular
• Nacho Vazquez @NachoVazquez
• Vojtech Masek @vmasek