# @code-pushup/models 中文文档

规范地址：https://npmcn.com/package/%40code-pushup/models/

版本：0\.126\.4
npm 元数据更新时间：2026-09-11T10:10:48.634Z
中文译文更新时间：2026-11-10T06:11:55.948Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40code-pushup/models
原文对照：https://npmcn.com/package/%40code-pushup/models/?lang=original
项目主页：https://github.com/code-pushup/cli/tree/main/packages/models#readme
源码仓库：https://github.com/code-pushup/cli

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：550 kB，86 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2023-12-01T08:35:07.776Z
- 最新版本发布：2026-09-11T10:10:48.323Z
- 近 30 天下载量：5124（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：255（近 12 个月 62 个）

## 中文简介

代码PushUp CLI的模型定义和验证器

## 安装

```sh
npm install @code-pushup/models
```

也可以使用：`pnpm add @code-pushup/models`、`yarn add @code-pushup/models`、`bun add @code-pushup/models`

## README

# @ code- pushup/ 型号

[![npm](https://img.shields.io/npm/v/%40code-pushup%2Fmodels.svg)](https://www.npmjs.com/package/@code-pushup/models) [![downloads](https://img.shields.io/npm/dm/%40code-pushup%2Fmodels)](https://npmtrends.com/@code-pushup/models) [![dependencies](https://img.shields.io/librariesio/release/npm/%40code-pushup/models)](https://www.npmjs.com/package/@code-pushup/models?activeTab=dependencies)

**示范定义和验证人** 联 合 国 [代码 PushUp CLI](https://npmcn.com/package/%40code-pushup/cli/README.md)。 。 。 .

此软件包定义的完整的模型列表,请参见自动生成的 [代码 PushUp 模型参考](https://npmcn.com/package/%40code-pushup/models/docs/models-reference.md)。 。 。 .

## 设置

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

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

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

```sh
yarn add --dev @code-pushup/models
```

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

## 使用量

使用 TypeScript 导入类型定义 :

-   内 `code-pushup.config.ts`数字 :
    
    ```ts
    import type { CoreConfig } from '@code-pushup/models';
    
    export default {
      // ... this is type-checked ...
    } satisfies CoreConfig;
    ```
    
-   在自定义插件中 :
    
    ```ts
    import type { PluginConfig } from '@code-pushup/models';
    
    export default function myCustomPlugin(): PluginConfig {
      return {
        // ... this is type-checked ...
      };
    }
    ```
    
    ```ts
    import type { AuditOutput } from '@code-pushup/models';
    
    async function myCustomPluginRunner() {
      const audits: AuditOutput[] = await collectAudits();
    
      await writeFile(RUNNER_OUTPUT_FILE, JSON.strinfigy(audits));
    }
    ```
    

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

```ts
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
```

## 常见问题

### @code-pushup/models 是什么？

代码PushUp CLI的模型定义和验证器

### 如何安装 @code-pushup/models？

在项目目录运行 npm install @code-pushup/models，或使用 pnpm add / yarn add / bun add。

### @code-pushup/models 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @code-pushup/models 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @code-pushup/models 可以商用吗？

@code-pushup/models 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @code-pushup/models 的下载量有多少？

根据 npm 官方下载统计，@code-pushup/models 在 2026/10/10 – 2026/11/08 这 30 天内被下载 5,124 次，日均约 171 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @code-pushup/models 还在维护吗？

最新版本 0\.126\.4 发布于 2026/09/11（1 个月前）；至今共发布 255 个版本，其中过去 12 个月发布了 62 个；首次发布于 2023/12/01。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。