# v217/tree-sitter-conl architecture

> Architecture diagram of the GitHub repository v217/tree-sitter-conl, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/v217/tree-sitter-conl
- Repository: https://github.com/v217/tree-sitter-conl

## Overview

##### Project Type Analysis
This is a language parser/grammar project built using Tree-sitter, with multiple language bindings. It's primarily focused on providing syntax highlighting and parsing capabilities for the CONL configuration language.

##### Main Components

Core Components:
- Grammar Definition (JavaScript-based)
- Generated Parser (C implementation)
- Scanner Implementation
- Language Bindings
- Query System

A. Central Components Layer:
- It to the Grammar Definition (grammar.js)
- Link to the Scanner Implementation (src/scanner.c)

B. Bindings Layer (arrange in a circular pattern around the core):
- C Bindings
- Python Bindings
- Node.js Bindings
- Rust Bindings
- Go Bindings
- Swift Bindings

C. Query System Layer:
- Queries
- Injection Queries

Use the following visual elements:

##### Component Representations
- Use rectangles for core components
- Use hexagons for language bindings
- Use ovals for query systems
- Use diamonds for generated artifacts

##### Specific Implementation Details

- [Grammar Definition (grammar.js)]
- ↓ (generates)
- [Parser (src/parser.c)] ←→ [Scanner (src/scanner.c)]
- ↓
- [Language Bindings]
- C
- Python
- Node.js
- Rust
- Go
- Swift
- ↓
- [Query System]
- Highlights
- Injections

##### Additional Elements
- Test corpus relationship to components

##### Important Notes
- Grammar.js as the source of truth
- How the generated parser.c is used by all bindings
- Relationship between queries and the parser
- Test corpus feedback loops

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Core
        GrammarDef["Grammar Definition"]:::core
        Parser["Generated Parser"]:::core
        Scanner["Scanner Implementation"]:::core
        Types["Generated Types"]:::core
        GrammarJSON["Grammar JSON"]:::core
        ParserHeader["Parser Header"]:::core
    end

    subgraph Bindings
        CBindings["C Bindings"]:::binding
        PythonBindings["Python Bindings"]:::binding
        NodeBindings["Node.js Bindings"]:::binding
        RustBindings["Rust Bindings"]:::binding
        GoBindings["Go Bindings"]:::binding
        SwiftBindings["Swift Bindings"]:::binding
    end

    subgraph "Query System"
        Highlights["Highlight Queries"]:::query
        Injections["Injection Queries"]:::query
    end

    subgraph "Test Components"
        TestCorpus["Test Corpus"]:::test
        PythonTests["Python Tests"]:::test
        NodeTests["Node.js Tests"]:::test
        GoTests["Go Tests"]:::test
        SwiftTests["Swift Tests"]:::test
    end

    %% Core relationships
    GrammarDef --> Parser
    GrammarDef --> GrammarJSON
    GrammarDef --> Types
    Parser <--> Scanner
    Parser --- ParserHeader

    %% Binding relationships
    Parser --> CBindings
    Parser --> PythonBindings
    Parser --> NodeBindings
    Parser --> RustBindings
    Parser --> GoBindings
    Parser --> SwiftBindings

    %% Query relationships
    Parser --> Highlights
    Parser --> Injections

    %% Test relationships
    TestCorpus --> Parser
    PythonTests --> PythonBindings
    NodeTests --> NodeBindings
    GoTests --> GoBindings
    SwiftTests --> SwiftBindings

    %% Click events
    click GrammarDef "https://github.com/v217/tree-sitter-conl/blob/main/grammar.js"
    click Parser "https://github.com/v217/tree-sitter-conl/blob/main/src/parser.c"
    click Scanner "https://github.com/v217/tree-sitter-conl/blob/main/src/scanner.c"
    click Types "https://github.com/v217/tree-sitter-conl/blob/main/src/node-types.json"
    click GrammarJSON "https://github.com/v217/tree-sitter-conl/blob/main/src/grammar.json"
    click ParserHeader "https://github.com/v217/tree-sitter-conl/blob/main/src/tree_sitter/parser.h"
    click CBindings "https://github.com/v217/tree-sitter-conl/blob/main/bindings/c/tree-sitter-conl.h"
    click PythonBindings "https://github.com/v217/tree-sitter-conl/blob/main/bindings/python/tree_sitter_conl/binding.c"
    click NodeBindings "https://github.com/v217/tree-sitter-conl/blob/main/bindings/node/binding.cc"
    click RustBindings "https://github.com/v217/tree-sitter-conl/blob/main/bindings/rust/lib.rs"
    click GoBindings "https://github.com/v217/tree-sitter-conl/blob/main/bindings/go/binding.go"
    click SwiftBindings "https://github.com/v217/tree-sitter-conl/blob/main/bindings/swift/TreeSitterConl/conl.h"
    click Highlights "https://github.com/v217/tree-sitter-conl/blob/main/queries/highlights.scm"
    click Injections "https://github.com/v217/tree-sitter-conl/blob/main/queries/injections.scm"
    click TestCorpus "https://github.com/v217/tree-sitter-conl/tree/main/test/corpus"
    click PythonTests "https://github.com/v217/tree-sitter-conl/blob/main/bindings/python/tests/test_binding.py"
    click NodeTests "https://github.com/v217/tree-sitter-conl/blob/main/bindings/node/binding_test.js"
    click GoTests "https://github.com/v217/tree-sitter-conl/blob/main/bindings/go/binding_test.go"
    click SwiftTests "https://github.com/v217/tree-sitter-conl/blob/main/bindings/swift/TreeSitterConlTests/TreeSitterConlTests.swift"

    %% Styling
    classDef core fill:#a2d2ff,stroke:#333,stroke-width:2px
    classDef binding fill:#bde0fe,stroke:#333,stroke-width:2px
    classDef query fill:#ffafcc,stroke:#333,stroke-width:2px
    classDef test fill:#ffc8dd,stroke:#333,stroke-width:2px

    %% Legend
    subgraph Legend
        CoreComp["Core Component"]:::core
        BindingComp["Language Binding"]:::binding
        QueryComp["Query Component"]:::query
        TestComp["Test Component"]:::test
    end
```
