# benchristel/audition architecture

> Architecture diagram of the GitHub repository benchristel/audition, 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/benchristel/audition
- Repository: https://github.com/benchristel/audition

## Overview

Main Components to Include:

##### Input Processing Layer
- Three main input file types:
- `.au` files (source files with glosses)
- `lexicon.csv` (word definitions)
- `morphology.yaml` (inflection rules)
- `generator.txt` (word generation rules)

##### Core Processing Components
- Parser System
- PEG.js parsers (gloss-parser, generator-rule-parser, csv-parser)
- Generator System
- Word generation component
- Morphological rules processor
- Translator System
- Lexicon processor
- Inflection engine

##### Output Processing Layer
- Generated conlang text output
- Updated lexicon with generated words

- [Input Files] → [Processing Layer] → [Output Files]

##### Main data flows
- [.au files] ───┐
- [lexicon.csv] ─┼→ [Parser Layer] → [Translator] → [Output Generator] → [Final Text]
- [morphology.yaml] ┘

Key Architectural Elements to Highlight:

##### Parser Components (src/generated/)
- How the PEG.js grammar files are compiled into parsers
- Relationship between source grammars and generated parsers

##### Core Processing Pipeline
- Modular structure reflected in the src/ directory
- How components like expression.ts, generator.ts, and translator.ts interact

##### Library Support Layer (src/lib/)
- Utility modules supporting the main processing pipeline
- Utilities like weighted-random-variable.ts for word generation

##### Testing Infrastructure
- Test directory relationship to main components
- How test-language/ provides example inputs

##### Use rectangles for main processing components
- File reading/writing operations
- Data transformation flows
- Component dependencies

Important Relationships to Emphasize:

##### The pipeline nature of the tool
- Parse → Generate → Transform → Output

##### The bidirectional relationship between the lexicon and generator
- Generator fills in missing translations
- Lexicon provides existing words

##### The hierarchical relationship between components
- Main Application
- Parser System
- Generator System
- Translator System
- Lexicon Processor
- Morphology Processor

Level of Detail:

- Keep the high-level flow clear while showing the key processing steps
- File formats at interaction points
- Error handling paths
- Where configuration options affect processing

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Input
        AU[".au Files"]
        LEX["lexicon.csv"]
        MORPH["morphology.yaml"]
        GEN["generator.txt"]
    end

    subgraph "Parser Layer"
        GP["Gloss Parser"]:::parser
        GRP["Generator Rule Parser"]:::parser
        CSVP["CSV Parser"]:::parser
        PG["Parser Grammars"]:::parser
    end

    subgraph "Core Processing"
        GENS["Generator System"]:::core
        TRANS["Translator System"]:::core
        MORPH_P["Morphology Processor"]:::core
        LEX_P["Lexicon Processor"]:::core
        EXP["Expression Handler"]:::core
        GLOSS_P["Gloss Processor"]:::core
    end

    subgraph "Support Libraries"
        WRV["Word Generation"]:::support
        FO["File Operations"]:::support
        YAML["YAML Processing"]:::support
        TEXT["Text Processing"]:::support
    end

    subgraph "Application Entry"
        MAIN["Main Application"]:::entry
        ARGS["CLI Arguments"]:::entry
    end

    subgraph Output
        OUT_TEXT["Generated Text"]:::output
        OUT_LEX["Updated Lexicon"]:::output
    end

    AU --> GP
    LEX --> CSVP
    MORPH --> YAML
    GEN --> GRP

    GP --> GLOSS_P
    GRP --> GENS
    CSVP --> LEX_P
    PG --> |"Compiles to"| GP
    PG --> |"Compiles to"| GRP
    PG --> |"Compiles to"| CSVP

    GLOSS_P --> TRANS
    GENS --> TRANS
    LEX_P --> TRANS
    MORPH_P --> TRANS
    EXP --> TRANS

    WRV --> GENS
    FO --> MAIN
    YAML --> MORPH_P
    TEXT --> TRANS

    MAIN --> OUT_TEXT
    MAIN --> OUT_LEX

    ARGS --> MAIN

    %% Click events for component mapping
    click AU "https://github.com/benchristel/audition/blob/main/test-language/*.au"
    click LEX "https://github.com/benchristel/audition/blob/main/test-language/lexicon.csv"
    click MORPH "https://github.com/benchristel/audition/blob/main/test-language/morphology.yaml"
    click GEN "https://github.com/benchristel/audition/blob/main/test-language/generator.txt"
    click GP "https://github.com/benchristel/audition/blob/main/src/generated/gloss-parser.js"
    click GRP "https://github.com/benchristel/audition/blob/main/src/generated/generator-rule-parser.js"
    click CSVP "https://github.com/benchristel/audition/blob/main/src/lib/generated/csv-parser.js"
    click PG "https://github.com/benchristel/audition/blob/main/src/gloss.pegjs"
    click GENS "https://github.com/benchristel/audition/blob/main/src/generator.ts"
    click TRANS "https://github.com/benchristel/audition/blob/main/src/translator.ts"
    click MORPH_P "https://github.com/benchristel/audition/blob/main/src/morphology.ts"
    click LEX_P "https://github.com/benchristel/audition/blob/main/src/lexicon.ts"
    click EXP "https://github.com/benchristel/audition/blob/main/src/expression.ts"
    click GLOSS_P "https://github.com/benchristel/audition/blob/main/src/gloss.ts"
    click WRV "https://github.com/benchristel/audition/blob/main/src/lib/weighted-random-variable.ts"
    click FO "https://github.com/benchristel/audition/blob/main/src/lib/files.ts"
    click YAML "https://github.com/benchristel/audition/blob/main/src/lib/yaml.ts"
    click TEXT "https://github.com/benchristel/audition/blob/main/src/text.ts"
    click MAIN "https://github.com/benchristel/audition/blob/main/src/main.ts"
    click ARGS "https://github.com/benchristel/audition/blob/main/src/args.ts"

    %% Styling
    classDef parser fill:#a8d1f0
    classDef core fill:#90EE90
    classDef support fill:#FFB6C1
    classDef entry fill:#DDA0DD
    classDef output fill:#FFA500
```
