@ chkit/ plugin- codegen

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

部分 齐克特 单相机 此插件扩展 chkit 带有 TypeScript 代码生成的 CLI.

安装

bun add -d @chkit/plugin-codegen zod

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

使用量

在配置中注册插件 :

// 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',
  },
})

然后运行 :

bunx chkit codegen

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

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

文档

见 chkit 文档。 。 。 .

许可证

麻省理工学院