# @arrirpc/codegen-utils 中文文档

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

版本：0\.85\.0
npm 元数据更新时间：2026-10-03T04:03:52.921Z
中文译文更新时间：2026-11-06T20:22:00.641Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40arrirpc/codegen-utils
原文对照：https://npmcn.com/package/%40arrirpc/codegen-utils/?lang=original
项目主页：https://github.com/modiimedia/arri#readme
源码仓库：https://github.com/modiimedia/arri

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

- 包体积（解压后）：11.6 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2024-05-14T04:35:21.953Z
- 最新版本发布：2026-10-03T04:03:52.720Z
- 近 30 天下载量：4638（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：91（近 12 个月 11 个）

## 中文简介

该图书馆载有一些公用事业,协助为Arri RPC创建发电机。 查看更完整的用法实例, 检查一个官方的 arri 客户端生成器 .

## 安装

```sh
npm install @arrirpc/codegen-utils
```

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

## README

# @ arrirpc/ codegen- utils

该图书馆载有一些公用事业,协助为Arri RPC创建发电机。 查看更完整的用法实例, 检查一个官方的 arri 客户端生成器 .

## 创建生成器插件

```ts
import { defineGeneratorPlugin } from "@arrirpc/codegen-utils";

// add any options needed for your plugin here
export interface MyPluginOptions {
    a: string;
    b: string;
}

export default defineGeneratorPlugin((options: MyPluginOptions) => {
    return {
        options,
        run: async (appDef, isDevServer) => {
            // generate something using the app definition and the specified options
        },
    };
});
```

## 其他公用事业

```ts
// type guards
isAppDefinition(input);
isRpcDefinition(input);
isServiceDefinition(input);
isSchema(input);
isSchemaFormEmpty(input);
isSchemaFormType(input);
isSchemaFormEnum(input);
isSchemaFormElements(inputs);
isSchemaFormProperties(input);
isSchemaFormValues(input);
isSchemaFormDiscriminator(input);
isSchemaFormRef(input);

unflattenProcedures({
    "v1.users.getUser": {
        transport: "http",
        path: "/v1/users/get-user",
        method: "get",
    },
    "v1.users.createUser": {
        transport: "http",
        path: "/v1/users/create-user",
        method: "post",
    },
});
/**
 * outputs the following
 * {
 *   v1: {
 *     users: {
 *       getUser: {
 *         transport: "http",
 *         path: "/v1/users/get-user",
 *         method: "get",
 *       },
 *       createUser: {
 *          transport: "http",
 *          path: "/v1/users/create-user",
 *          method: "post",
 *       }
 *     }
 *   }
 * }
 */

removeDisallowedChars(input, disallowedChars);
camelCase(input, opts);
kebabCase(input);
pascalCase(input, opts);
snakeCase(input, opts);
titleCase(input, opts);
flatCase(input, opts);
upperFirst(input);
lowerFirst(input);
isUppercase(input);
```

## 发展

### 大楼

运行 `pnpm nx build codegen-utils` 来建造图书馆.

### 运行单元测试

运行 `pnpm nx test codegen-utils` 通过 [维特](https://vitest.dev/)。 。 。 .

## 常见问题

### @arrirpc/codegen-utils 是什么？

该图书馆载有一些公用事业,协助为Arri RPC创建发电机。 查看更完整的用法实例, 检查一个官方的 arri 客户端生成器 \.

### 如何安装 @arrirpc/codegen-utils？

在项目目录运行 npm install @arrirpc/codegen-utils，或使用 pnpm add / yarn add / bun add。

### @arrirpc/codegen-utils 支持 TypeScript 吗？

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

### @arrirpc/codegen-utils 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @arrirpc/codegen-utils 可以商用吗？

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

### @arrirpc/codegen-utils 的下载量有多少？

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

### @arrirpc/codegen-utils 还在维护吗？

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