template-bun-rust-library

## このリポジトリについて `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ソースのリンティング。 - `bunx typedoc index.ts` — HTML形式のAPIドキュメントを生成。 ## ドキュメント READMEには、Markdownのレンダリングを確認するためのサンプルMermaidクラス図 (`Foo <|-- Bar`) が含まれており、GitHub Pagesでホストされている自動生成APIドキュメントへのリンクがあります。また、docs.rs上のRustドキュメントへのリンクも含まれています。 ## プロジェクトメタデータ リポジトリには、リリースバージョン、ビルドステータス、APIドキュメント、Rustドキュメント、カバレッジ、およびMITライセンスのバッジが付いています。ライセンスは MIT © Flowscripter と明記されています。 ## 利用検討者への注意点 これはテンプレートであるため、`world()` エクスポートや例示された図はプレースホルダーです。実用的な価値は、RustクレートとBun/TypeScriptパッケージ間の連携設定、およびそれに付随するビルド、テスト、リンティング、フォーマット、ドキュメント作成コマンド、およびCI設定にあります。