Agent Skills
› synthetic-sciences/openscience
› bun-file-io
bun-file-io
GitHub指导在backend/cli中处理文件读写、扫描及目录操作，推荐优先使用Bun专属API（如Bun.file、Bun.write），仅在涉及目录时使用node:fs，并遵循仓库特定的路径处理和错误捕获模式。
触发场景
编辑或扫描backend/cli中的文件I/O逻辑
执行目录创建、读取等目录操作
需要高效读写大文件或二进制数据
安装
npx skills add synthetic-sciences/openscience --skill bun-file-io -g -y
SKILL.md
Frontmatter
{
"name": "bun-file-io",
"description": "Use this when you are working on file operations like reading, writing, scanning, or deleting files. It summarizes the preferred file APIs and patterns used in this repo. It also notes when to use filesystem helpers for directories."
}
Use this when
- Editing file I/O or scans in
backend/cli(the OpenScience CLI package) - Handling directory operations or external tools
Bun file APIs (from Bun docs)
Bun.file(path)is lazy; calltext,json,stream,arrayBuffer,bytes,existsto read.- Metadata:
file.size,file.type,file.name. Bun.write(dest, input)writes strings, buffers, Blobs, Responses, or files.Bun.file(...).delete()deletes a file.file.writer()returns a FileSink for incremental writes.Bun.Glob+Array.fromAsync(glob.scan({ cwd, absolute, onlyFiles, dot }))for scans.- Use
Bun.whichto find a binary, thenBun.spawnto run it. Bun.readableStreamToText/Bytes/JSONfor stream output.
When to use node:fs
- Use
node:fs/promisesfor directories (mkdir,readdir, recursive operations).
Repo patterns
- Prefer Bun APIs over Node
fsfor file access. - Check
Bun.file(...).exists()before reading. - For binary/large files use
arrayBuffer()and MIME checks viafile.type. - Use
Bun.Glob+Array.fromAsyncfor scans. - Decode tool stderr with
Bun.readableStreamToText. - For large writes, use
Bun.write(Bun.file(path), text).
Quick checklist
- Use Bun APIs first.
- Use
path.join/path.resolvefor paths. - Prefer promise
.catch(...)overtry/catchwhen possible.
版本历史
- e9844a4 当前 2026-07-11 17:18
