git 备案工具
这是一个处理 git 文件的小型库 。 目前只提供
RepositoryFileCache 这是单个分支的读取缓存。 因为
这个库使用 GIT 数据 API, 它可以获取最大100 MB 大小的文件 .
安装
npm i @google-automations/git-file-utils
获取文件
import {Octokit} from '@octokit/rest';
import {
FileNotFoundError,
RepositoryFileCache
} from '@google-automations/git-file-utils';
const octokit = new Octokit();
const cache = new RepositoryFileCache(
octokit,
{
owner: "googleapis",
repo: "repo-automation-bots",
});
try {
const contents = await cache.getFileContents("README.md", "main");
console.log(`content: ${contents.parsedContent}`);
} catch (e) {
if (e instanceof FileNotFoundError) {
console.log(`file not found`);
} else {
// rethrow
throw e;
}
}
关于 @google-automations/git-file-utils 的常见问题
@google-automations/git-file-utils 是什么?
Github 文件操作工具
如何安装 @google-automations/git-file-utils?
在项目目录运行 npm install @google-automations/git-file-utils,或使用 pnpm add / yarn add / bun add。
@google-automations/git-file-utils 支持 TypeScript 吗?
支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。
@google-automations/git-file-utils 支持 ESM 还是 CommonJS?
以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。
@google-automations/git-file-utils 需要什么版本的 Node.js?
package.json 的 engines 字段要求 Node.js >= 22。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。
@google-automations/git-file-utils 可以商用吗?
@google-automations/git-file-utils 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。
@google-automations/git-file-utils 的下载量有多少?
根据 npm 官方下载统计,@google-automations/git-file-utils 在 2026/10/17 – 2026/11/15 这 30 天内被下载 1,749,330 次,日均约 58,311 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。
@google-automations/git-file-utils 还在维护吗?
最新版本 3.2.1 发布于 2026/09/16(2 个月前);至今共发布 15 个版本,其中过去 12 个月发布了 4 个;首次发布于 2022/08/11。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。