You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
1
# Rspack
2
2
3
-
## Project Overview
3
+
## Project overview
4
4
5
5
Rspack is a high-performance JavaScript bundler written in Rust that offers strong compatibility with the webpack ecosystem.
6
6
7
-
## Project Architecture
7
+
## Project architecture
8
8
9
9
-**Monorepo** with Rust crates (`crates/`) and JavaScript packages (`packages/`)
10
10
- See [Project Architecture](website/docs/en/contribute/development/project.md) for details
@@ -44,16 +44,16 @@ Depends on what you have modified, you need to rebuild by `pnpm run build:js` or
44
44
-**JavaScript**: Use `--inspect` flag, attach with `Attach JavaScript`
45
45
-**rust-lldb**: `rust-lldb -- node /path/to/rspack build` for panic debugging
46
46
47
-
## Code Quality
47
+
## Code quality
48
48
49
49
-**Linting**: `pnpm run lint:js` (Biome), `pnpm run lint:rs` (cargo check), `pnpm run lint:type` (Rslint)
50
50
-**Formatting**: `pnpm run format:rs` (cargo fmt), `pnpm run format:js` (prettier), `pnpm run format:toml` (taplo)
51
51
-**Rust gate**: After modifying Rust code, ensure both `cargo fmt --all --check` and `cargo lint` pass before commit/PR
52
52
-**Style**: snake_case for Rust, camelCase for JS/TS
53
53
54
-
## Common Tasks
54
+
## Common tasks
55
55
56
-
### Adding a New Feature
56
+
### Adding a new feature
57
57
58
58
1. Create feature branch from `main`
59
59
2. Implement in appropriate crate/package
@@ -63,17 +63,17 @@ Depends on what you have modified, you need to rebuild by `pnpm run build:js` or
63
63
6. Format: `pnpm run format:rs && pnpm run format:js`
64
64
7. Create PR
65
65
66
-
### Modifying Code
66
+
### Modifying code
67
67
68
68
-**Rust**: Core in `crates/rspack_core/`, plugins in `crates/rspack_plugin_*/`, rebuild with `pnpm run build:binding:dev`, test with `pnpm run test:rs`, and ensure `cargo fmt --all --check && cargo lint` passes
69
69
-**JS/TS**: API in `packages/rspack/src/`, CLI in `packages/rspack-cli/src/`, rebuild with `pnpm run build:js`, test with `pnpm run test:unit`
70
70
71
-
### Adding Tests
71
+
### Adding tests
72
72
73
73
-**Rust**: Add `#[test]` functions in same file or `tests/` directory
Copy file name to clipboardExpand all lines: packages/rspack-test-tools/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@
8
8
9
9
Test tools for rspack.
10
10
11
-
## Wasm Tests
11
+
## Wasm tests
12
12
13
13
We expect to reuse the tests for Rspack wasm target as many as possible and we have managed to do it partially. Currently wasm tests should be run with an environment variable `WASM=1` under the following limitations:
0 commit comments