@compas/code-gen

中文文档
0.28.0发布于 2026/10/02MITTypeScriptES Module构建来源已验证近 30 天下载 7363

生成服务器中各种无聊的部分

中文使用文档
文档目录3 节
  1. 维护模式
  2. 作为服务器
  3. 作为客户

@ compas/ code- gen

Install size CI status badge Codecov status


代码生成器用于路由器,验证器,SQL查询,API客户端等. 拿着 看着 文档。 。 。 .

维护模式

Compas处于维护状态. 软件包将保留给 可预见的未来。 可能增加一些新功能,但有些功能也将删除 有利于其他生态系统可用的图书馆。 请不要开始新的项目 使用Compas.

作为服务器

mainFn(import.meta, main);

async function main() {
  const app = new App();

  const T = new TypeCreator("post");
  const R = T.router("/post");

  app.add(
    new TypeCreator("database")
      .object("post")
      .keys({
        title: T.string().searchable(),
        body: T.string(),
      })
      .enableQueries({ withDates: true }),

    T.crud("/post").entity(T.reference("database", "post")).routes({
      listRoute: true,
      singleRoute: true,
      createRoute: true,
      updateRoute: true,
      deleteRoute: true,
    }),
  );

  await app.generate({
    outputDirectory: "./src/generated/application",
    dumpStructure: true,
    dumpApiStructure: true,
    dumpPostgres: true,
    enabledGenerators: ["validator", "router", "sql", "apiClient"],
  });
}

作为客户

mainFn(import.meta, main);

async function main() {
  const app = new App({ verbose: true });

  const fromRemote = await loadApiStructureFromRemote(
    Axios,
    "https://some.compas.powered.backend",
  );

  app.extend(fromRemote);

  await app.generate({
    outputDirectory: "./src/generated",
    isBrowser: true,
    enabledGenerators: ["type", "apiClient", "reactQuery"],
  });

  await spawn("yarn", ["format"]);
}

版本与发布记录

@compas/code-gen 共发布 225 个版本,首次发布于 2020/12/09;过去 12 个月发布了 13 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.28.0latest2026/10/021 个月前
0.27.02026/09/281 个月前
0.26.02026/09/141 个月前
0.25.02026/09/111 个月前
0.24.02026/08/272 个月前
0.23.22026/06/025 个月前

关于 @compas/code-gen 的常见问题

@compas/code-gen 是什么?

生成服务器中各种无聊的部分

如何安装 @compas/code-gen?

在项目目录运行 npm install @compas/code-gen,或使用 pnpm add / yarn add / bun add。

@compas/code-gen 支持 TypeScript 吗?

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

@compas/code-gen 支持 ESM 还是 CommonJS?

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

@compas/code-gen 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=24。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@compas/code-gen 可以商用吗?

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

@compas/code-gen 的下载量有多少?

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

@compas/code-gen 还在维护吗?

最新版本 0.28.0 发布于 2026/10/02(1 个月前);至今共发布 225 个版本,其中过去 12 个月发布了 13 个;首次发布于 2020/12/09。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。