# dagrejs/graphlib-dot architecture

> Architecture diagram of the GitHub repository dagrejs/graphlib-dot, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/dagrejs/graphlib-dot
- Repository: https://github.com/dagrejs/graphlib-dot

## Overview

##### Project type and purpose
- This is an open-source JavaScript library (“graphlib-dot”) that parses and writes GraphViz DOT files into/from graphlib Graph objects.
- It is not a web app or microservice; it’s a utility library for node/browser that exposes a CLI/API for DOT ↔ graphlib conversion.

##### File structure
- Top-level files:
- index.js                → main entry point
- browser.js              → browser/browserify entry
- dist/graphlib-dot.js    → prebuilt bundle
- lib/*.js                → core implementation modules
- src/dot-grammar.pegjs   → PEG.js grammar source
- src/release/…           → release automation scripts
- test/*.js               → unit tests
- package.json, bower.json, Makefile, CI config
- Key directories:
- lib/    – actual parser/writer logic
- src/    – grammar definition and release utilities
- test/   – mocha/karma tests
- dist/   – build artifacts for distribution

##### README for additional insights
- Confirms: “A DOT language parser/writer for graphlib.”

##### Final advice
- Version/release step if relevant
Layer 1: User/API → Layer 2: Parser/Builder/Serializer → Layer 3: External Graphlib → Layer 4: Distribution/CI
- Aim for clarity: every module and its role should be immediately obvious.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% User/API Layer
    subgraph "User API Layer"
        readOne["readOne()"]:::runtime
        readMany["readMany()"]:::runtime
        indexLib["index.js"]:::runtime
        libVersion["version.js"]:::runtime
    end

    %% Core Modules
    subgraph "Core Modules"
        parserEngine["Parser Engine\nlib/dot-grammar.js"]:::runtime
        builder["Graph Builder\nlib/build-graph.js"]:::runtime
        serializer["Serializer\nlib/write-one.js"]:::runtime
    end

    %% External Dependency
    graphlib["graphlib\n(external)"]:::external

    %% Distribution & Packaging
    subgraph "Distribution & Packaging"
        browserJs["browser.js"]:::dist
        distBundle["dist/graphlib-dot.js"]:::dist
        packageJson["package.json"]:::dist
        bowerJson["bower.json"]:::dist
    end

    %% Release & CI
    subgraph "Release & CI"
        bump["bump-version.js"]:::build
        check["check-version.js"]:::build
        makeBower["make-bower.json.js"]:::build
        makeVersion["make-version.js"]:::build
        releaseSh["release.sh"]:::build
        makefile["Makefile"]:::build
        ciWorkflow["build.yml"]:::build
        karmaConf["karma.conf.js"]:::build
        karmaCore["karma.core.conf.js"]:::build
    end

    %% Tests
    subgraph "Tests"
        tReadOne["read-one-test.js"]:::test
        tReadMany["read-many-test.js"]:::test
        tWrite["write-test.js"]:::test
        tVersion["version-test.js"]:::test
        tBundle["bundle-test.js"]:::test
        tChai["chai.js"]:::test
    end

    %% Data Flow
    readOne -->|"parseDot()"| parserEngine
    readMany -->|"parseDot()"| parserEngine
    indexLib -->|"exposes API"| readOne
    indexLib -->|"exposes API"| readMany
    indexLib -->|"exposes API"| serializer

    parserEngine -->|"buildAST()"| builder
    builder -->|"toGraph()"| graphlib
    graphlib -->|"writeDot()"| serializer

    %% Packaging and Release
    browserJs --> distBundle
    packageJson --> distBundle
    bowerJson --> distBundle
    bump --> makeVersion
    check --> makeBower
    makeBower --> releaseSh
    makeVersion --> releaseSh
    makefile --> releaseSh
    ciWorkflow --> tests
    karmaConf --> tests
    karmaCore --> tests

    %% Testing relationships
    tReadOne --> readOne
    tReadMany --> readMany
    tWrite --> serializer
    tVersion --> libVersion
    tBundle --> distBundle
    tChai --> tReadOne
    tChai --> tReadMany
    tChai --> tWrite

    %% Click Events
    click parserEngine "https://github.com/dagrejs/graphlib-dot/blob/master/lib/dot-grammar.js"
    click builder "https://github.com/dagrejs/graphlib-dot/blob/master/lib/build-graph.js"
    click serializer "https://github.com/dagrejs/graphlib-dot/blob/master/lib/write-one.js"
    click readOne "https://github.com/dagrejs/graphlib-dot/blob/master/lib/read-one.js"
    click readMany "https://github.com/dagrejs/graphlib-dot/blob/master/lib/read-many.js"
    click indexLib "https://github.com/dagrejs/graphlib-dot/blob/master/lib/index.js"
    click browserJs "https://github.com/dagrejs/graphlib-dot/blob/master/browser.js"
    click distBundle "https://github.com/dagrejs/graphlib-dot/blob/master/dist/graphlib-dot.js"
    click packageJson "https://github.com/dagrejs/graphlib-dot/blob/master/package.json"
    click bowerJson "https://github.com/dagrejs/graphlib-dot/blob/master/bower.json"
    click bump "https://github.com/dagrejs/graphlib-dot/blob/master/src/release/bump-version.js"
    click check "https://github.com/dagrejs/graphlib-dot/blob/master/src/release/check-version.js"
    click makeBower "https://github.com/dagrejs/graphlib-dot/blob/master/src/release/make-bower.json.js"
    click makeVersion "https://github.com/dagrejs/graphlib-dot/blob/master/src/release/make-version.js"
    click releaseSh "https://github.com/dagrejs/graphlib-dot/blob/master/src/release/release.sh"
    click makefile "https://github.com/dagrejs/graphlib-dot/tree/master/Makefile"
    click ciWorkflow "https://github.com/dagrejs/graphlib-dot/blob/master/.github/workflows/build.yml"
    click karmaConf "https://github.com/dagrejs/graphlib-dot/blob/master/karma.conf.js"
    click karmaCore "https://github.com/dagrejs/graphlib-dot/blob/master/karma.core.conf.js"
    click tReadOne "https://github.com/dagrejs/graphlib-dot/blob/master/test/read-one-test.js"
    click tReadMany "https://github.com/dagrejs/graphlib-dot/blob/master/test/read-many-test.js"
    click tWrite "https://github.com/dagrejs/graphlib-dot/blob/master/test/write-test.js"
    click tVersion "https://github.com/dagrejs/graphlib-dot/blob/master/test/version-test.js"
    click tBundle "https://github.com/dagrejs/graphlib-dot/blob/master/test/bundle-test.js"
    click tChai "https://github.com/dagrejs/graphlib-dot/blob/master/test/chai.js"

    %% Styles
    classDef runtime fill:#cfe2f3,stroke:#333,stroke-width:1px
    classDef build fill:#d9ead3,stroke:#333,stroke-width:1px
    classDef test fill:#f9cb9c,stroke:#333,stroke-width:1px
    classDef dist fill:#d9d2e9,stroke:#333,stroke-width:1px
    classDef external fill:#ececec,stroke:#333,stroke-width:1px
```
