template-bun-rust-library

## Nature de ce dépôt `flowscripter/template-bun-rust-library` est décrit dans son README comme un "Modèle de projet pour une bibliothèque Rust avec des liaisons Bun FFI". Il est conçu comme un point de départ plutôt que comme une application finale : les développeurs génèrent un nouveau projet à partir de celui-ci, puis remplacent le code d'exemple par leur propre implémentation Rust et leurs liaisons TypeScript. ## Utilisation du scaffolding Le README documente la création d'un nouveau projet Bun directement à partir du modèle : `bun create @flowscripter/template-bun-rust-library` ## Consommation du module généré Le module publié est ajouté avec `bun add @flowscripter/template-bun-rust-library`, et l'exemple du README importe une seule fonction exportée et l'invoque : ```typescript import { world } from "@flowscripter/template-bun-rust-library"; world(); ``` Ceci démontre la structure prévue du modèle : une bibliothèque Rust rendue accessible aux consommateurs TypeScript via le support FFI de Bun, avec `index.ts` comme point d'entrée TypeScript. ## Flux de travail de développement Le README liste les commandes suivantes : - `bun install` — installer les dépendances. - `bun run build` — construire la sortie ; selon le README, cela produit `dist/` pour les consommateurs Node.js et TypeScript, tandis que Bun utilise directement la source brute. - `cargo test` — exécuter les tests Rust. - `cargo build --release && bun test` — construire les artefacts de release Rust et exécuter la suite de tests Bun. - `bunx oxfmt` — formater. - `cargo fmt && bunx oxlint index.ts src/ tests/` — linting des sources Rust et TypeScript. - `bunx typedoc index.ts` — générer la documentation API HTML. ## Documentation Le README inclut un exemple de diagramme de classes Mermaid (`Foo <|-- Bar`) pour vérifier le rendu Markdown, et des liens vers la documentation API auto-générée hébergée sur GitHub Pages. Des liens de documentation supplémentaires incluent les docs Rust sur docs.rs. ## Métadonnées du projet Le dépôt comporte des badges pour la version de release, l'état du build, la doc API, la doc Rust, la couverture et une licence MIT. La licence est indiquée comme MIT © Flowscripter. ## Notes pour les utilisateurs potentiels Comme il s'agit d'un modèle, l'export `world()` et le diagramme d'exemple sont des espaces réservés. La valeur pratique réside dans le câblage qu'il fournit entre un crate Rust et un package Bun/TypeScript, ainsi que dans les commandes d'accompagnement pour le build, les tests, le linting, le formatage, la documentation et la configuration CI.