How jakobeha/type-sitter works
Main Components
a. Core Libraries (represent as rectangles):
• type-sitter-lib: Core runtime library
• type-sitter-gen: Code generation engine
• type-sitter-proc: Procedural macros interface
• yak-sitter: Optional tree-sitter wrapper
• type-sitter-cli: Command-line interface
b. External Dependencies (represent as hexagons):
• tree-sitter: The underlying parsing system
• Source Grammar Files (node-types.json)
• Query Files (*.scm)
• Grammar/Query files → type-sitter-gen → Generated Code
• Generated Code → type-sitter-lib (runtime usage)
• type-sitter-proc → type-sitter-gen
• type-sitter-cli → type-sitter-gen
• All components → type-sitter-lib
a. Code Generation Stage:
• Input Processing (node-types.json, query files)
• Type Generation
• Code Emission
b. Runtime Stage:
• Parser Integration
• Type-safe Node Handling
• Query Execution
Specific Implementation Details
a. type-sitter-gen:
• Node Type Generation
• Query Generation
• Custom Supertype Generation
b. type-sitter-lib:
• Typed Node Wrappers
• Query Execution
• Error Handling
a. Build-time Path:
• Build Script → type-sitter-gen → Generated Code
b. Macro Path:
• Procedural Macros → type-sitter-gen → Generated Code
c. CLI Path:
• CLI Tool → type-sitter-gen → Generated Code
□ Core Library Component
⬡ External Dependency
◇ Generated Code
○ Processing Stage
→ Data Flow
⇢ Dependency
⇉ Usage Path
Blue: Core Components
Green: Input Sources
Orange: Generated Code
Purple: External Dependencies
Gray: Optional Components
Additional Notes
• Version compatibility information (tree-sitter v0.24)
• Three different usage methods as separate paths
• Optional yak-sitter integration points
• Error handling flow
• File generation paths
Remember to include notes about the large code generation aspect (31K+ LOC for nodes, 6K+ for queries) as it's a significant characteristic of the system.