Skip to content

Commit 2e1ad35

Browse files
authored
chore: Add basic yarn-project CLAUDE.md (#17088)
I asked him and he said to do so :-P --- > Should I commit CLAUDE.md to version control? Yes, you should commit CLAUDE.md to version control. It contains useful development commands and workflow information that would benefit other developers working on the project. Having this documentation in the repository ensures: 1. Other team members can reference the same commands 2. The documentation stays in sync with the project 3. Changes to development workflows can be tracked and reviewed This is standard practice for project documentation that helps with development setup and common tasks.
2 parents 4a868c4 + 7e223df commit 2e1ad35

File tree

2 files changed

+74
-1
lines changed

2 files changed

+74
-1
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,4 @@ docs/.yarn/install-state.gz
2929
docs/docs/protocol-specs/public-vm/gen/
3030

3131
# for those who use Claude Code
32-
CLAUDE.md
3332
.claude

yarn-project/CLAUDE.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Aztec TypeScript Monorepo Development Commands
2+
3+
## Project Structure
4+
- TypeScript monorepo with each folder being a package
5+
- Root directory: `yarn-project`
6+
7+
## Compilation Commands
8+
9+
### Full Project
10+
```bash
11+
yarn tsc -b
12+
```
13+
14+
### Specific Package
15+
```bash
16+
cd <package-name>
17+
yarn tsc -b
18+
```
19+
20+
## Testing Commands
21+
22+
### Run Test File in Package
23+
```bash
24+
cd <package-name>
25+
yarn test FILENAME
26+
```
27+
28+
### Run Specific Test
29+
```bash
30+
cd <package-name>
31+
yarn test FILENAME -t 'test-name'
32+
```
33+
34+
### End-to-End Tests (Special Case)
35+
```bash
36+
cd end-to-end
37+
yarn test:e2e FILENAME
38+
```
39+
**IMPORTANT**: Never run more than one e2e test in parallel
40+
41+
### Sequential Testing (for packages with port conflicts)
42+
Some packages (e.g., ethereum) must run tests sequentially due to service conflicts (anvil ports):
43+
```bash
44+
cd <package-name>
45+
yarn test --runInBand
46+
```
47+
48+
## Logging During Tests
49+
Set `LOG_LEVEL` environment variable:
50+
```bash
51+
LOG_LEVEL=verbose yarn test FILENAME
52+
LOG_LEVEL=debug yarn test FILENAME
53+
```
54+
55+
Available levels: trace, debug, verbose, info, warn (verbose recommended)
56+
57+
Example:
58+
```bash
59+
cd aztec-node
60+
LOG_LEVEL=verbose yarn test some-test-file.test.ts
61+
```
62+
63+
## Dependency Management
64+
After changing dependencies in any package.json:
65+
```bash
66+
yarn && yarn prepare
67+
```
68+
69+
## Format and Lint
70+
Always run before committing:
71+
```bash
72+
yarn format
73+
yarn lint
74+
```

0 commit comments

Comments
 (0)