# thim81/openapi-format architecture

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

- Interactive diagram: https://gitdiagram.com/thim81/openapi-format
- Repository: https://github.com/thim81/openapi-format

## Overview

##### Main Components Architecture

**┌─────────────────────────────────────────────────────────────────┐**
- OpenAPI Format System                        │
- ┘

- ┌───────────────────────────────────────────┐
- ▼                     ▼                      ▼
**┌───────────────┐    ┌───────────────┐     ┌───────────────────┐**
- CLI Layer   │    │  Core Engine  │     │  Utility Modules  │
- ┘    └───────────────┘     └───────────────────┘

- ▼                     ▼                      ▼
**┌───────────────┐    ┌───────────────┐     ┌───────────────────┐**
- Configuration  │    │  Processors   │     │    File Handlers  │
- Handler    │    │               │     │                   │
- ┘    └───────────────┘     └───────────────────┘

##### Detailed Component Breakdown

**┌─────────────────────────────────────────────┐**
- Core Engine                    │
- ┤
- ┌─────────────┐  ┌──────────┐  ┌─────────┐ │
- Sorter    │  │  Filter  │  │ Casing  │ │
- ┘  └──────────┘  └─────────┘ │
- ┌─────────────┐  ┌──────────┐  ┌─────────┐ │
- Generator  │  │ Overlay  │  │Converter│ │
- ┘  └──────────┘  └─────────┘ │
- ┘

##### Data Flow Representation

**Input OpenAPI Doc → Parser → Processors → Formatter → Output OpenAPI Doc**

- ┐    ┌─────┘            │        ┌────┘
- ▼    ▼                   ▼        ▼
- [JSON/YAML Parser]    [Processing Pipeline]    [Output Writer]

##### Interaction Flows

- Configuration loading
- Processing pipeline steps
- File operations
- Validation checks

##### External Dependencies

- case-anything (casing library)
- @stoplight/yaml (YAML parser)
- js-yaml (alternative YAML parser)

##### Processing Logic: Display core transformation components

Remember to:
- Use consistent symbols and notation
- Brief descriptions for complex components
- Error handling paths
- Optional processing steps

This system design will help developers understand the tool's architecture and how its components interact to process OpenAPI documents.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph System["OpenAPI Format System"]
        CLI["CLI Layer"]
        Core["Core Engine"]
        Utils["Utility Modules"]
    end

    subgraph ConfigLayer["Configuration Layer"]
        Config["Configuration Handler"]
        DefaultFilter["Default Filter Config"]
        DefaultSort["Default Sort Config"]
        DefaultSortComp["Default Sort Components"]
    end

    subgraph ProcessingLayer["Processing Layer"]
        Sorter["Sorting Engine"]
        Filter["Filtering System"]
        Casing["Casing Formatter"]
        Generator["Generator"]
        Overlay["Overlay Processor"]
        Converter["OpenAPI Converter"]
    end

    subgraph UtilityLayer["Utility Layer"]
        FileOps["File Operations"]
        Logger["Logging System"]
        TypeCheck["Type Checking"]
        TplParser["Template Parser"]
        Split["Split Utility"]
        Types["Type Definitions"]
    end

    CLI --> Core
    CLI --> Config
    Core --> ProcessingLayer
    Core --> UtilityLayer
    Config --> DefaultFilter
    Config --> DefaultSort
    Config --> DefaultSortComp

    %% Component relationships
    ProcessingLayer --> UtilityLayer
    FileOps --> Logger
    TypeCheck --> Types

    %% External Dependencies
    ExternalDeps["External Dependencies"]
    ExternalDeps --> Core

    %% Styling
    classDef default fill:#f9f9f9,stroke:#333,stroke-width:1px
    classDef core fill:#ddf,stroke:#333
    classDef config fill:#ffd,stroke:#333
    classDef processing fill:#dfd,stroke:#333
    classDef utility fill:#fdd,stroke:#333

    class Core,System core
    class ConfigLayer,Config,DefaultFilter,DefaultSort,DefaultSortComp config
    class ProcessingLayer,Sorter,Filter,Casing,Generator,Overlay,Converter processing
    class UtilityLayer,FileOps,Logger,TypeCheck,TplParser,Split,Types utility

    %% Click events
    click CLI "https://github.com/thim81/openapi-format/blob/main/bin/cli.js"
    click Core "https://github.com/thim81/openapi-format/blob/main/openapi-format.js"
    click DefaultFilter "https://github.com/thim81/openapi-format/blob/main/defaultFilter.json"
    click DefaultSort "https://github.com/thim81/openapi-format/blob/main/defaultSort.json"
    click DefaultSortComp "https://github.com/thim81/openapi-format/blob/main/defaultSortComponents.json"
    click Sorter "https://github.com/thim81/openapi-format/blob/main/utils/sorting.js"
    click Filter "https://github.com/thim81/openapi-format/blob/main/utils/filtering.js"
    click Casing "https://github.com/thim81/openapi-format/blob/main/utils/casing.js"
    click Overlay "https://github.com/thim81/openapi-format/blob/main/utils/overlay.js"
    click Converter "https://github.com/thim81/openapi-format/blob/main/utils/convert.js"
    click FileOps "https://github.com/thim81/openapi-format/blob/main/utils/file.js"
    click Logger "https://github.com/thim81/openapi-format/blob/main/utils/logging.js"
    click TypeCheck "https://github.com/thim81/openapi-format/blob/main/utils/types.js"
    click TplParser "https://github.com/thim81/openapi-format/blob/main/utils/parseTpl.js"
    click Split "https://github.com/thim81/openapi-format/blob/main/utils/split.js"
    click Types "https://github.com/thim81/openapi-format/blob/main/types/openapi-format.d.ts"
```
