@git-stunts/拖车编码c
强力, Git Commissions 的 Async- First 元数据编码 .
@git-stunts/trailer-codec 是一个专业级编码器/解码器,用于 Git 传输信件中的结构化元数据(拖车)。 它遵循了标准的Git拖车公约(RFC 822 / Email headers),同时提供工业安全特性和类型安全域模型.
关键特性
- Async- 第一个 API: 为v1.0实现现代化,支持非屏蔽编码/解码.
- DoS 保护:内建5MB消息尺寸限制和ReDoS-hardened regex.
- 结构化域: 正规实体和价值对象(GitCommitMessage, GitTrailer).
- Zod 验证: 有诊断错误对象的Schema驱动验证.
- 纯域逻辑:零 I/O,零子进程. 任何运行时间(节点、Bun、Deno、Web)的安全.
- 大小写规范化: 拖车密钥自动正常化,用于一致查询.
QQ 快速启动
基本编码
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'
}
});
基本解码
const payload = await codec.decode(message);
console.log(payload.title); // "feat: add user authentication"
console.log(payload.trailers); // { "signed-off-by": "James Ross", ... }
页:1
审定规则
| 规则 | 约束 | 抛出错误 |
|---|---|---|
| 信件大小 | • 5MB | TrailerTooLargeError |
| 拖车键 | 字母、连字符、下划线 | TrailerInvalidError |
| 拖车价值 | 无换行, 无空 | TrailerValueInvalidError |
| 结构 | 空行必须把车和拖车分开 | TrailerNoSeparatorError |
许可证
阿帕奇 - 2.0