这个项目能做什么

## 仓库简介 `flowscripter/template-bun-rust-library` 在其 README 中被描述为“带有 Bun FFI 绑定的 Rust 库项目模板”。它的定位是起点而非最终用户应用程序：开发者通过它搭建新项目，然后将示例代码替换为自己的 Rust 实现和 TypeScript 绑定。 ## 脚手架使用 README 记录了直接从模板创建新 Bun 项目的方法： `bun create @flowscripter/template-bun-rust-library` ## 使用生成的模块 通过 `bun add @flowscripter/template-bun-rust-library` 添加发布的模块，README 的示例导入了一个导出的函数并调用它： ```typescript import { world } from "@flowscripter/template-bun-rust-library"; world(); ``` 这展示了该模板的预期结构：一个通过 Bun 的 FFI 支持向 TypeScript 消费者开放的 Rust 库，并以 `index.ts` 作为 TypeScript 入口点。 ## 开发工作流 README 列出了以下命令： - `bun install` — 安装依赖。 - `bun run build` — 构建输出；根据 README，它为 Node.js 和 TypeScript 消费者生成 `dist/`，而 Bun 直接使用原始源码。 - `cargo test` — 运行 Rust 测试。 - `cargo build --release && bun test` — 构建 Rust 发布产物并运行 Bun 测试套件。 - `bunx oxfmt` — 格式化。 - `cargo fmt && bunx oxlint index.ts src/ tests/` — 对 Rust 和 TypeScript 源码进行 Lint 检查。 - `bunx typedoc index.ts` — 生成 HTML API 文档。 ## 文档 README 包含一个示例 Mermaid 类图 (`Foo <|-- Bar`) 以验证 Markdown 渲染，并提供了指向托管在 GitHub Pages 上的自动生成 API 文档的链接。其他文档链接包括 docs.rs 上的 Rust 文档。 ## 项目元数据 该仓库带有发布版本、构建状态、API 文档、Rust 文档、覆盖率和 MIT 许可证的徽章。许可证声明为 MIT © Flowscripter。 ## 给潜在用户的提示 由于这是一个模板，`world()` 导出和示例图表仅为占位符。其实际价值在于它在 Rust crate 和 Bun/TypeScript 包之间提供的连接，以及随附的构建、测试、Lint、格式化、文档命令和 CI 配置。