template-bun-rust-library

## O que é este repositório `flowscripter/template-bun-rust-library` é descrito em seu README como um "Template de projeto para uma biblioteca Rust com bindings Bun FFI". Ele é pretendido como um ponto de partida em vez de uma aplicação para o usuário final: desenvolvedores criam a estrutura de um novo projeto a partir dele e então substituem o código de exemplo por sua própria implementação em Rust e bindings em TypeScript. ## Uso de scaffolding O README documenta a criação de um novo projeto Bun diretamente do template: `bun create @flowscripter/template-bun-rust-library` ## Consumindo o módulo gerado O módulo publicado é adicionado com `bun add @flowscripter/template-bun-rust-library`, e o exemplo do README importa uma única função exportada e a invoca: ```typescript import { world } from "@flowscripter/template-bun-rust-library"; world(); ``` Isso demonstra a forma pretendida do template: uma biblioteca Rust disponibilizada para consumidores TypeScript através do suporte FFI do Bun, com `index.ts` como o ponto de entrada TypeScript. ## Fluxo de desenvolvimento O README lista os seguintes comandos: - `bun install` — instala dependências. - `bun run build` — gera a saída; de acordo com o README, produz `dist/` para consumidores Node.js e TypeScript, enquanto o Bun usa o código-fonte bruto diretamente. - `cargo test` — executa os testes Rust. - `cargo build --release && bun test` — constrói os artefatos de release do Rust e executa a suíte de testes do Bun. - `bunx oxfmt` — formatação. - `cargo fmt && bunx oxlint index.ts src/ tests/` — lint dos fontes Rust e TypeScript. - `bunx typedoc index.ts` — gera documentação de API em HTML. ## Documentação O README inclui um exemplo de diagrama de classe Mermaid (`Foo <|-- Bar`) para verificar a renderização de Markdown, e links para a documentação de API autogerada hospedada no GitHub Pages. Links de documentação adicionais incluem docs de Rust no docs.rs. ## Metadados do projeto O repositório possui badges para versão de release, status de build, docs de API, docs de Rust, cobertura e uma licença MIT. A licença é declarada como MIT © Flowscripter. ## Notas para potenciais usuários Como este é um template, a exportação `world()` e o diagrama de exemplo são placeholders. O valor prático é a conexão que ele fornece entre um crate Rust e um pacote Bun/TypeScript, juntamente com os comandos acompanhantes de build, teste, lint, formatação e documentação, além da configuração de CI.