# @chkit/plugin-codegen 中文文档

规范地址：https://npmcn.com/package/%40chkit/plugin-codegen/

版本：0\.2\.0-beta\.16
npm 元数据更新时间：2026-11-08T23:59:01.602Z
中文译文更新时间：2026-11-09T13:59:34.195Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40chkit/plugin-codegen
原文对照：https://npmcn.com/package/%40chkit/plugin-codegen/?lang=original
项目主页：https://chkit.obsessiondb.com/
源码仓库：https://github.com/obsessiondb/chkit

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

- 包体积（解压后）：96.7 kB，42 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：zod ^4\.0\.0
- 首次发布：2026-02-17T04:31:29.188Z
- 最新版本发布：2026-11-08T23:59:01.305Z
- 近 30 天下载量：8907（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：40（近 12 个月 40 个）

## 中文简介

Chkit 的 TypeScript 类型和 Zod 计划生成插件

## 安装

```sh
npm install @chkit/plugin-codegen
```

也可以使用：`pnpm add @chkit/plugin-codegen`、`yarn add @chkit/plugin-codegen`、`bun add @chkit/plugin-codegen`

## README

# @ chkit/ plugin- codegen

从您的 chkit 计划定义中生成 TypeScript 行类型和可选 Zod 计划插件 .

部分 [齐克特](https://github.com/obsessiondb/chkit) 单相机 此插件扩展 [`chkit`](https://www.npmjs.com/package/chkit) 带有 TypeScript 代码生成的 CLI.

## 安装

```bash
bun add -d @chkit/plugin-codegen zod
```

`zod` 属于对等关系( e)`^4.0.0`: 插件在运行时使用, 以及任意 生成 Zod 计程器( R)`emitZod: true`导入 `zod` 从你的项目。 安装 同样的 `zod` 您的工程已经用于避免重复复制.

## 使用量

在配置中注册插件 :

```ts
// clickhouse.config.ts
import { defineConfig } from '@chkit/core'
import { codegen } from '@chkit/plugin-codegen'

export default defineConfig({
  schema: './src/db/schema/**/*.ts',
  outDir: './chkit',
  plugins: [
    codegen({
      outFile: './src/generated/chkit-types.ts',
      emitZod: false,
      emitIngest: false,
    }),
  ],
  clickhouse: {
    url: process.env.CLICKHOUSE_URL ?? 'http://localhost:8123',
  },
})
```

然后运行 :

```bash
bunx chkit codegen
```

Codegen 之后也会自动运行 `chkit generate` 何时 `runOnGenerate` 启用(默认).

何时 `emitIngest` 被启用,默认情况下生成的摄入式帮助 gzip-compress 请求机构。 过 `{ compressed: false }` 作为禁用特定插入压缩的第三个参数.

## 文档

见 [chkit 文档](https://chkit.obsessiondb.com/)。 。 。 .

## 许可证

[麻省理工学院](https://npmcn.com/package/LICENSE)

## 常见问题

### @chkit/plugin-codegen 是什么？

Chkit 的 TypeScript 类型和 Zod 计划生成插件

### 如何安装 @chkit/plugin-codegen？

在项目目录运行 npm install @chkit/plugin-codegen，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：zod（^4\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @chkit/plugin-codegen 支持 TypeScript 吗？

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

### @chkit/plugin-codegen 支持 ESM 还是 CommonJS？

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

### @chkit/plugin-codegen 可以商用吗？

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

### @chkit/plugin-codegen 的下载量有多少？

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

### @chkit/plugin-codegen 还在维护吗？

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