1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
# CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
## Project Overview
This is the CUE language repository. CUE (Configure, Unify, Execute) is a general-purpose, strongly typed constraint-based language for data templating, validation, code generation, and scripting.
## Common Development Commands
### Building
```bash
# Build and install the cue command
go install ./cmd/cue
# Build without installing
go build ./cmd/cue
```
### Testing
```bash
# Run all tests
# Any change to the repo should run all tests to ensure correctness.
go test ./...
# Run tests for a specific package
go test ./internal/core/adt
# Run a specific test function
go test -run TestEvalV2 ./internal/core/adt
# Run a specific testscript test
go test -run TestScript/eval_concrete ./cmd/cue/cmd
# Update golden test files (when output changes are expected)
CUE_UPDATE=1 go test ./...
# Run tests with race detector
go test -race ./...
```
### Code Quality
```bash
# Run go vet (catches common mistakes)
go vet ./...
# Run staticcheck (more comprehensive static analysis)
go tool -modfile=internal/tools.mod staticcheck ./...
# Format code (CUE uses standard Go formatting)
go fmt ./...
```
## Code Architecture
### Core Language Implementation
- `/cue/` - Core CUE language implementation
- `ast/` - Abstract Syntax Tree
- `parser/` - Language parser
- `load/` - Package loading and imports
- `format/` - Code formatting
- `/internal/core/` - Core evaluation engine
- `adt/` - Core data structures and algorithms
- `compile/` - Compilation logic
- `dep/` - Dependency analysis
- `export/` - Export functionality
### Command-Line Tool
- `/cmd/cue/` - CLI implementation for all CUE commands (eval, export, import, fmt, vet, mod, etc.)
### Standard Library
- `/pkg/` - Built-in packages (crypto, encoding, math, net, path, strings, etc.)
### Format Support
- `/encoding/` - Encoders/decoders for JSON, YAML, TOML, Protobuf, OpenAPI, JSON Schema
### Testing Infrastructure
- **Test Format**: Uses `.txtar` (text archive) files containing input files and expected outputs
- **Test Organization**: Unit tests alongside code (`*_test.go`), integration tests in `testdata/` directories
- **Testscript Framework**: Command-line integration tests in `/cmd/cue/cmd/testdata/script/`
## Key Development Patterns
### Working with Tests
- Tests use the `.txtar` format which contains both input and expected output in a single file
- Use `TestX` functions in test files for debugging individual test cases
- The `CUE_UPDATE=1` environment variable updates golden files with actual output
### Contribution Model
- Single commit per PR/CL model
- Uses `git codereview` workflow for managing changes
- Requires DCO (Developer Certificate of Origin) sign-off
- Do not add "Co-Authored-By: Claude <noreply@anthropic.com>" as this confuses our DCO check.
- Both GitHub PRs and GerritHub CLs are supported
- Changes should be linked to a GitHub issue (except trivial changes)
### Module Information
- Module: `cuelang.org/go`
- Requires Go 1.23 or later
- Uses Go modules for dependency management
### Important Conventions
- Don't update copyright years in existing files
- Follow existing code style and patterns in the package you're modifying
- Check neighboring files for framework choices and conventions
- Use existing libraries and utilities rather than assuming new dependencies
|
