yaoxiang check

Performs static checks (type checking, ownership checking) on YaoXiang source code without generating any code.

Usage

yaoxiang check [OPTIONS] [PATH]...

Arguments

Argument	Description
PATH	One or more file or directory paths. Defaults to checking the current project if not specified.

Options

Option	Description	Default
--json	Output diagnostics in JSON format	No
-w, --watch	Watch for file changes and automatically re-check	No
--color <MODE>	Color output mode: auto, always, never	auto
--exclude <PATH>	Exclude the specified path (can be used multiple times)	None
--no-progress	Suppress progress and summary messages	No

Exit Codes

Exit Code	Description
0	No errors
1	Errors found during check
2	No .yx files found

Cross-File Analysis

yaoxiang check supports cross-file type checking. When checking multiple files:

1. Parse all .yx files in parallel
2. Build module dependency graph
3. Detect circular dependencies (reports error)
4. Check in topological sort order
5. Use shared type environment to correctly detect cross-file references

# Check entire project (auto-detect cross-file references)
yaoxiang check src/

# Check specific files
yaoxiang check src/main.yx src/lib.yx

Incremental Checking (Watch Mode)

Use -w or --watch to enable file watching mode. Automatically re-checks when files change.

yaoxiang check --watch

JSON Output Format

When using --json, the output format is:

{
  "error_count": 0,
  "warning_count": 0,
  "diagnostics": [
    {
      "file": "src/main.yx",
      "severity": "error",
      "code": "E1001",
      "message": "Unknown variable: 'x'",
      "line": 5,
      "column": 3,
      "end_line": 5,
      "end_column": 4,
      "lsp": { ... }
    }
  ]
}

Examples

# Check current project
yaoxiang check

# Check specific files
yaoxiang check src/main.yx

# Check directory and output JSON
yaoxiang check src/ --json

# Watch mode
yaoxiang check --watch

# CI mode (no colors, no progress)
yaoxiang check --color never --no-progress

# Exclude test directory
yaoxiang check src/ --exclude tests/

CI Integration

# GitHub Actions
- name: Type check
  run: yaoxiang check --color never --no-progress

For detailed CI configuration, see the CI Integration Guide.

See Also

• yaoxiang format -- Code formatting
• Error Codes Reference -- Complete error code list
• CI Integration Guide -- CI/CD integration
• Diagnostic System Design -- Architecture design document