@ git- stunts/ 发声
基建子系统工业基金会.
@git-stunts/plumbing 是一个低水平,环境不可知的Git管道库,为现代JavaScript生态系统所设计. 建造在 六边形建筑 财务报告和审定财务报表 域驱动设计( DDD) 原理,它为 Git 操作提供了安全、流畅、第一和类型安全的接口 节点Js、Bun和德诺。 。 。 .
为什么是水管?
大多数Git库要么是泄露执行细节的高层次包装,要么是被运行时锁定的低层次绑定. plumbing 把吉特当作一个 正式子系统,将您的应用与弹壳执行、运行时间差异和安全风险的复杂性隔离开来.
- 环境不可知论:一个API用于节点,邦和德诺.
- Async- 第一架构: 为v3.0而实现现代化,每个初始化和执行路径都是同步而非阻塞.
- 默认流: 使用统一流对所有运行时间进行内存高效数据处理.
- 防御工程:已建入OOM保护,论证消毒,并锁取回取.
- 数学完整性: 电源 佐德语Name 验证以确保每个SHA,Ref,和Object在被触摸到磁盘之前结构上的声音.
安全性: Docker任务
为了保护你的主机系统免受意外腐败 并确保可复制的处决, 严格禁止执行主机. 这个项目使用 @git-stunts/docker-guard 强制隔离.
# Run the industrial test suite
docker-compose run --rm node-test
* 安装
npm install @git-stunts/plumbing
QQ 快速启动
启动
现代 Git管道需要同步初始化,以安全地验证环境和工作目录.
import GitPlumbing from '@git-stunts/plumbing';
// Safely open a repository (Async factory)
const git = await GitPlumbing.createRepository({ cwd: './my-assets' });
// Execute a command with full telemetry and OOM protection
const status = await git.execute({ args: ['rev-parse', '--is-inside-work-tree'] });
console.log(`Ready: ${status}`);
原子提交流量
创建blobs, 树, 并按程序执行, 而不受手动外壳脚本的脆弱性 .
import GitPlumbing, { GitSha } from '@git-stunts/plumbing';
const git = await GitPlumbing.createRepository({ cwd: './my-repo' });
const commitSha = await git.createCommitFromFiles({
branch: 'refs/heads/main',
message: 'Feat: immutable asset storage',
author: { name: 'James Ross', email: '[email protected]' },
committer: { name: 'James Ross', email: '[email protected]' },
parents: [GitSha.from(await git.revParse({ revision: 'HEAD' }))],
files: [
{ path: 'manifest.json', content: JSON.stringify({ version: '1.0' }) },
{ path: 'data.bin', content: new Uint8Array([0xde, 0xad, 0xbe, 0xef]) },
],
});
不混合的泥浆检查
流出 Git 认为比 Canonial UTC 年长的松散无法到达的对象
断取. 这个API总是引用 Git 的 --dry-run --no-progress· ;
非限制性 git prune 仍由指挥部消毒器禁止.
const plumbing = await GitPlumbing.createDefault({ cwd: './my-repo' });
const stream = await plumbing.inspectPrunableObjects({
expiresBefore: '2026-07-01T00:00:00.000Z',
});
for await (const chunk of stream) {
// Parse Git's `<object-id> <type>` records incrementally.
}
await stream.finished;
持久性 Git 协议会话
重复的对象操作可以共享一个 stock Git 进程. 键入会话 包装器处理协议框架,同时保留明确的生命周期所有权:
const plumbing = await GitPlumbing.createDefault({ cwd: './my-repo' });
const objects = await plumbing.openCatFileSession();
try {
const metadata = await objects.infoMany([firstOid, secondOid]);
const values = await objects.readMany([firstOid, secondOid], {
maxBytes: 8 * 1024 * 1024,
});
for (const { oid, type, content } of values) {
consume(oid, type, content);
}
} finally {
await objects.close();
}
maxBytes 是一个累积的内容预算 readMany(). 反应
超过剩余预算,不保留,操作
失败 OBJECT_BUFFER_LIMIT_EXCEEDED,本届会议仍与
后请. 默认预算为10 MiB.
可通过 openMktreeSession() 财务报告和审定财务报表
openFastImportSession(). 供应给 write() 仍然可以持续
或连结而成河,而不筑起一整棵树
缓冲. writeMany() 组装最多为 256 个边框的书写
独立树,而 writeBlobs() 组装一个边框协议写入
最多256个blobs 在一个可调用内容选择的预算 上限为64米B.
infoMany() 在64 KiB命令预算下接受最多1000个对象名称。 全体
批量结果保存输入顺序.
openUpdateRefSession() 重用一个 git update-ref --stdin 跨进程
明确更新-ref交易。 内容 update() 方法执行一个
无条件更新当 expectedOldOid 实值 undefined· ; null 表示
只创建和 OID 表示比较和扫描。 它验证了吉特的命令
开始/准备/承诺确认。 被拒绝或不当的交易
毒害会议.
noDeref (b) 消费者必须保留任何
需要单独进行象征性的安全检查.
会话没有隐含的超时. 他们的主人必须打电话 close() 用于有序
完成或替换 terminate()编号 :abort() 放弃工作的时候 水管拥有
进程和只使用 Git 协议机制; 调用器, 如 @git-stunts/git-cas
拥有集合,分块,缓存,留置,驱逐政策.
仅多克的微分基准将一次性操作与定界操作进行比较 批量窗口或针对新 SHA-256 存储器的连续反读会话. 它记录了时间流逝, Git 进程地形学, stdin 写数,和精确 对象识别证人:
docker compose run --build --rm node-test npm run benchmark:protocol-sessions
深潜
许可证
阿帕奇 - 2.0