Sobre el proyecto

## Qué es este repositorio `flowscripter/template-bun-rust-library` se describe en su README como una "Plantilla de proyecto para una librería de Rust con Bun FFI bindings". Está concebido como un punto de partida en lugar de una aplicación para el usuario final: los desarrolladores crean un nuevo proyecto a partir de ella y luego reemplazan el código de ejemplo con su propia implementación de Rust y bindings de TypeScript. ## Uso del andamiaje (Scaffolding) El README documenta la creación de un nuevo proyecto de Bun directamente desde la plantilla: `bun create @flowscripter/template-bun-rust-library` ## Consumo del módulo generado El módulo publicado se añade con `bun add @flowscripter/template-bun-rust-library`, y el ejemplo del README importa una única función exportada y la invoca: ```typescript import { world } from "@flowscripter/template-bun-rust-library"; world(); ``` Esto demuestra la estructura prevista de la plantilla: una librería de Rust expuesta a consumidores de TypeScript a través del soporte FFI de Bun, con `index.ts` como punto de entrada de TypeScript. ## Flujo de trabajo de desarrollo El README enumera los siguientes comandos: - `bun install` — instalar dependencias. - `bun run build` — compilar la salida; según el README, produce `dist/` para consumidores de Node.js y TypeScript, mientras que Bun utiliza el código fuente directamente. - `cargo test` — ejecutar las pruebas de Rust. - `cargo build --release && bun test` — compilar los artefactos de lanzamiento de Rust y ejecutar la suite de pruebas de Bun. - `bunx oxfmt` — formatear. - `cargo fmt && bunx oxlint index.ts src/ tests/` — linting de las fuentes de Rust y TypeScript. - `bunx typedoc index.ts` — generar documentación de API en HTML. ## Documentación El README incluye un diagrama de clases de Mermaid de ejemplo (`Foo <|-- Bar`) para verificar el renderizado de Markdown, y enlaces a la documentación de la API autogenerada alojada en GitHub Pages. Los enlaces de documentación adicionales incluyen los docs de Rust en docs.rs. ## Metadatos del proyecto El repositorio contiene insignias para la versión de lanzamiento, el estado de la compilación, la documentación de la API, la documentación de Rust, la cobertura y una licencia MIT. La licencia se indica como MIT © Flowscripter. ## Notas para futuros usuarios Dado que se trata de una plantilla, la exportación `world()` y el diagrama de ejemplo son marcadores de posición. El valor práctico es la conexión que proporciona entre un crate de Rust y un paquete de Bun/TypeScript, junto con los comandos acompañantes de compilación, prueba, linting, formateo y documentación, así como la configuración de CI.