@bufbuild/protocompile

中文文档
0.0.1发布于 2024/10/11Apache-2.0TypeScriptESM + CJS近 30 天下载 2.2万

在苍蝇上编译Protobuf供测试

中文使用文档

@ bufbuilding/ protocompile (英语)

这个工具在苍蝇上从Protobuf编译了描述符.

测试时需要留言吗? 与 compileMessage 函数,您可以将 Protobuf 源编译为信件描述符 :

import { compileMessage } from "@bufbuild/protocompile";
import { redact } from "./redact.js";

describe("redact", () => {
  it("should redact string field", () => {
    const schema = compileMessage(`
      syntax = "proto3";
      message Example {
        string foo = 1 [ debug_redact = true ];
      }
    `);
    const message: Message & Record<string, unknown> = create(schema, {
      foo: "abc",
    });
    redact(message);
    expect(message.foo).toBe("");
  });
});

该套件还输出功能来编译所有其他类型的Protobuf描述符,例如点数和服务.

在引擎盖下,功能外壳到 buf build 命令。 惠璶 @ bufbuilding/ buf 作为使用它们的同伴依赖.

注意这些函数返回匿名描述符 。 它们与生成的描述符在功能上完全相同,但没有生成附加的种类信息.

版本与发布记录

@bufbuild/protocompile 共发布 1 个版本,首次发布于 2024/10/11;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.0.1latest2024/10/112 年前

关于 @bufbuild/protocompile 的常见问题

@bufbuild/protocompile 是什么?

在苍蝇上编译Protobuf供测试

如何安装 @bufbuild/protocompile?

在项目目录运行 npm install @bufbuild/protocompile,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@bufbuild/buf(^1.22.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@bufbuild/protocompile 支持 TypeScript 吗?

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

@bufbuild/protocompile 支持 ESM 还是 CommonJS?

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

@bufbuild/protocompile 可以商用吗?

@bufbuild/protocompile 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@bufbuild/protocompile 的下载量有多少?

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

@bufbuild/protocompile 还在维护吗?

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