Skip to content

docs: add native architecture guidance #265

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chenjiahan merged 1 commit into from
Aug 9, 2026
Merged

docs: add native architecture guidance #265

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
- Use repo Node.js/pnpm versions (`package.json`)
- `pnpm` workspace; shared deps in `pnpm-workspace.yaml` catalogs
- TypeScript, Rsbuild/Rslib/Rstest/Rslint, Prettier
- Rust/Cargo workspace with a NAPI-RS binding under `crates/`

## Commands

Expand All @@ -24,12 +25,19 @@ pnpm check:spell

# focused work
pnpm --filter rstack build
pnpm --filter rstack build:native
pnpm --filter rstack test
```

## Testing

- Run `pnpm build` once before `pnpm test` command
- Run `pnpm build` and `pnpm --filter rstack build:native` before `pnpm test`

## Native

- Follow `crates/AGENTS.md` for Rust changes
- Keep the JS bridge lazy; use the generated loader directly
- Regenerate binding files with `build:native`

## Documentation

Expand All @@ -39,7 +47,8 @@ pnpm --filter rstack test
## Project structure

```text
packages/rstack/ # CLI package
examples/* # example projects
scripts/ # repo tooling
crates/ # Rust crates
packages/rstack/ # CLI package and private native bridge
examples/* # example projects
scripts/ # repo tooling
```
18 changes: 18 additions & 0 deletions crates/AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# AGENTS.md

## Architecture

- Keep `rstack-binding` a thin Node/NAPI adapter
- Put reusable or domain logic in separate crates
- Coordinate binding changes with the private JS loader and its Rstest coverage

## Checks

Run from the repository root:

```bash
cargo fmt --all -- --check
cargo clippy --workspace --all-targets --locked -- -D warnings
cargo test --workspace --locked
pnpm --filter rstack build:native
```
1 change: 1 addition & 0 deletions scripts/dictionary.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Custom Dictionary Words
applypatch
clippy
dirents
errexit
extglob
Expand Down