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
Start from the `crates/` directory when exploring the codebase.
31
+
32
+
Sub-directories named `generated` are code generated, do not edit files in these directories.
33
+
34
+
30
35
### Important Crates Overview
31
36
32
37
-**`oxc_parser`** - JavaScript/TypeScript parser
@@ -56,34 +61,39 @@ The project uses several tools for development:
56
61
The project uses `just` as the primary command runner. Key commands include:
57
62
58
63
```bash
59
-
#Initialize development environment
60
-
just init
64
+
#List available commands
65
+
just --list
61
66
62
-
# Run all checks (the "ready" command)
67
+
# Run all checks
63
68
just ready
64
69
65
70
# Individual commands
66
-
just fmt # Format code
71
+
just fmt # Format code. Run after any code modifications.
67
72
just check # Check code without building
68
73
just test# Run tests
69
74
just lint # Run linting
70
75
just doc # Generate documentation
71
-
just ast # When directory `crates/oxc_ast` changes
76
+
just ast # Update generated files. Run when directory `crates/oxc_ast` changes
77
+
just conformance # Run conformance tests. Run when any Rust code changes.
72
78
```
73
79
74
80
### Building and Testing
75
81
82
+
`just init` has already been run, all tools (`watchexec-cli`, `cargo-insta`, `typos-cli`, `cargo-shear`, `dprint`) are already installed, do not run `just init`.
83
+
84
+
Rust and `cargo` components `clippy`, `rust-docs` and `rustfmt` has already been installed, do not install them.
0 commit comments