@ code- pushup/ 型号

示范定义和验证人 联 合 国 代码 PushUp CLI。 。 。 .

此软件包定义的完整的模型列表,请参见自动生成的 代码 PushUp 模型参考。 。 。 .

设置

如果你已经安装了另一个 @code-pushup/* 软件包,然后您可能已经安装 @code-pushup/models 间接的.

如果没有,则可以始终单独安装:

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

yarn add --dev @code-pushup/models

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

使用量

使用 TypeScript 导入类型定义 :

• 内 code-pushup.config.ts数字 :

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

• 在自定义插件中 :

  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));
  }
  

如果您需要运行时间验证, 请使用 Zod 基本计划 :

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

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