프로젝트 소개

## 이 저장소의 정체 `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 구성에 있습니다.