Skip to content

Commit 3ec2961

Browse files
akoclaude
andcommitted
docs: clarify generated grammar files are not committed to git
Update the PR checklist and ANTLR4 section to reflect that `mdl/grammar/parser/` is regenerated by `make grammar` at build time and must not be committed. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 8082543 commit 3ec2961

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

CLAUDE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ All executor code must go through the backend abstraction layer — the executor
282282
### Full-stack consistency for MDL features
283283
New MDL commands or language features must be wired through the full pipeline:
284284
- [ ] **Grammar** — rule added to `MDLParser.g4` (and `MDLLexer.g4` if new tokens)
285-
- [ ] **Parser regenerated**`make grammar` run, generated files committed
285+
- [ ] **Parser regenerated**`make grammar` run; generated files in `mdl/grammar/parser/` are **not** committed (they are regenerated by `make` at build time)
286286
- [ ] **AST** — node type added in `mdl/ast/`
287287
- [ ] **Visitor** — ANTLR listener bridges parse tree to AST in `mdl/visitor/`
288288
- [ ] **Executor** — thin handler in `mdl/executor/` dispatches to `ctx.Backend.*`; no BSON in the handler
@@ -418,7 +418,7 @@ The `vscode-mdl` extension provides MDL language support: syntax highlighting, p
418418

419419
### ANTLR4 Parser
420420

421-
Regenerate after modifying `MDLLexer.g4` or `MDLParser.g4`: `make grammar`. See `docs/03-development/MDL_PARSER_ARCHITECTURE.md` for design details.
421+
Regenerate after modifying `MDLLexer.g4`, `MDLParser.g4`, or any `domains/*.g4` file: `make grammar`. Generated files in `mdl/grammar/parser/` are **not** committed to git. See `docs/03-development/MDL_PARSER_ARCHITECTURE.md` for design details.
422422

423423
## IMPORTANT: Before Writing MDL Scripts or Working with Data
424424

0 commit comments

Comments
 (0)