@git-stunts/trailer-codec

中文文档
4.0.0发布于 2026/07/30Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 7057

Robust encoder/decoder for structured metadata in Git commit messages

原始使用文档
文档目录7 节
  1. 📦 Key Features
  2. 🚀 Quick Start
  3. Basic Encoding
  4. Basic Decoding
  5. 📖 Documentation
  6. 🛠️ Validation Rules
  7. 📄 License

@git-stunts/trailer-codec

npm version License CI

Robust, Async-First Metadata Encoding for Git Commits.

@git-stunts/trailer-codec is a professional-grade encoder/decoder for structured metadata (trailers) within Git commit messages. It follows the standard Git trailer convention (RFC 822 / Email headers) while providing industrial safety features and a type-safe domain model.

📦 Key Features

  • Async-First API: Modernized for v1.0, support for non-blocking encoding/decoding.
  • DoS Protection: Built-in 5MB message size limit and ReDoS-hardened regex.
  • Structured Domain: Formalized Entities and Value Objects (GitCommitMessage, GitTrailer).
  • Zod Validation: Schema-driven validation with diagnostic error objects.
  • Pure Domain Logic: Zero I/O, zero subprocesses. Safe for any runtime (Node, Bun, Deno, Web).
  • Case Normalization: Automatic normalization of trailer keys for consistent querying.

🚀 Quick Start

Basic Encoding

import { createDefaultTrailerCodec } from '@git-stunts/trailer-codec';

const codec = createDefaultTrailerCodec();

const message = await codec.encode({
  title: 'feat: add user authentication',
  body: 'Implemented OAuth2 flow with JWT tokens.',
  trailers: {
    'Signed-off-by': 'James Ross',
    'Reviewed-by': 'Alice Smith'
  }
});

Basic Decoding

const payload = await codec.decode(message);

console.log(payload.title);    // "feat: add user authentication"
console.log(payload.trailers); // { "signed-off-by": "James Ross", ... }

📖 Documentation

🛠️ Validation Rules

RuleConstraintThrown Error
Message Size≤ 5MBTrailerTooLargeError
Trailer KeyAlphanumeric, hyphens, underscoresTrailerInvalidError
Trailer ValueNo line breaks, non-emptyTrailerValueInvalidError
StructureBlank line must separate body from trailersTrailerNoSeparatorError

📄 License

Apache-2.0

版本与发布记录

@git-stunts/trailer-codec 共发布 4 个版本,首次发布于 2026/01/12;过去 12 个月发布了 4 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
4.0.0latest2026/07/303 个月前
3.0.42026/07/303 个月前
2.1.12026/01/1210 个月前
2.1.02026/01/1210 个月前

关于 @git-stunts/trailer-codec 的常见问题

@git-stunts/trailer-codec 是什么?

Robust encoder/decoder for structured metadata in Git commit messages

如何安装 @git-stunts/trailer-codec?

在项目目录运行 npm install @git-stunts/trailer-codec,或使用 pnpm add / yarn add / bun add。

@git-stunts/trailer-codec 支持 TypeScript 吗?

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

@git-stunts/trailer-codec 支持 ESM 还是 CommonJS?

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

@git-stunts/trailer-codec 需要什么版本的 Node.js?

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

@git-stunts/trailer-codec 可以商用吗?

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

@git-stunts/trailer-codec 的下载量有多少?

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

@git-stunts/trailer-codec 还在维护吗?

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