Об этом проекте

## Что представляет собой этот репозиторий `flowscripter/template-bun-rust-library` описывается в файле README как «Шаблон проекта для библиотеки Rust с привязками Bun FFI». Он задуман как отправная точка, а не конечное приложение: разработчики создают на его основе новый проект, а затем заменяют примеры кода собственной реализацией на 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(); ``` Это демонстрирует предполагаемую структуру шаблона: библиотека Rust, доступная потребителям TypeScript через поддержку FFI в Bun, где `index.ts` служит точкой входа TypeScript. ## Рабочий процесс разработки В README перечислены следующие команды: - `bun install` — установка зависимостей. - `bun run build` — сборка результата; согласно README, она создает папку `dist/` для потребителей Node.js и TypeScript, в то время как 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 включает пример диаграммы классов Mermaid (`Foo <|-- Bar`) для проверки рендеринга Markdown, а также ссылки на автоматически сгенерированную документацию API, размещенную на GitHub Pages. Дополнительные ссылки на документацию включают Rust docs на docs.rs. ## Метаданные проекта Репозиторий содержит бейджи версии релиза, статуса сборки, документации API, документации Rust, покрытия тестами и лицензии MIT. Лицензия указана как MIT © Flowscripter. ## Примечания для потенциальных пользователей Поскольку это шаблон, экспорт `world()` и пример диаграммы являются заглушками. Практическая ценность заключается в связке между крейтом Rust и пакетом Bun/TypeScript, а также в сопровождающих командах сборки, тестирования, линтинга, форматирования, документации и конфигурации CI.