# 52-entertainment/vite-plugin-oxlint architecture

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

- Interactive diagram: https://gitdiagram.com/52-entertainment/vite-plugin-oxlint
- Repository: https://github.com/52-entertainment/vite-plugin-oxlint

## Overview

##### Main Components

a) Core Components:
- Vite Build Process
- Oxlint Linter Integration
- Plugin Configuration Handler
- File System Interface

b) External Dependencies:
- Oxlint
- Vite
- Optional ESLint Integration

**┌─────────────────────────────────────────────────────┐**
- Vite Build Process                 │
- ┬─────────────────────────────────┘

**┌───────────────────▼─────────────────────────────────┐**
- vite-plugin-oxlint (Plugin)              │
- ┤
- ┌─────────────────┐  ┌──────────────────────────┐  │
- Configuration  │  │     Plugin Pipeline      │  │
- Handler      │──▶│   - Init               │  │
- ┘  │   - Transform           │  │
- Build               │  │
- ┬───────────┘  │

- ┌─────────────────┐  ┌─────────────▼───────────┐  │
- File System   │◀─▶│    Oxlint Engine       │  │
- Interface     │  │                         │  │
- ┘  └─────────────────────────┘  │
- ┘

##### Important Elements to Highlight

a) Configuration Options (from README):
- Config File Handler
- Working Directory Manager
- Ignore Patterns Processor
- Rules Manager (Allow/Deny/Warn)
- Additional Parameters Handler

b) Integration Points:
- Vite Plugin Hook System
- ESLint Integration (optional)
- File System Interface

##### Implementation Details

- Relationship between src/index.ts and src/types.ts
- Compilation output (dist folder)
- Configuration file handling (.oxlintrc.json)

##### Data Flow Indicators

Following flows:

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph ViteBuild["Vite Build Process"]
        ViteCore["Vite Core"]
        BuildHooks["Build Hooks"]
    end

    subgraph Plugin["vite-plugin-oxlint"]
        direction TB
        PluginCore["Plugin Core"]:::core
        ConfigHandler["Configuration Handler"]:::config
        FSInterface["File System Interface"]:::system
        Pipeline["Plugin Pipeline"]:::pipeline
        OxlintEngine["Oxlint Engine"]:::engine
    end

    subgraph External["External Components"]
        direction TB
        ESLint["ESLint Integration"]:::external
        OxlintLib["Oxlint Library"]:::external
    end

    subgraph Config["Configuration"]
        direction TB
        ConfigFile["Config File"]:::config
        WorkingDir["Working Directory"]:::config
        IgnorePatterns["Ignore Patterns"]:::config
        RulesManager["Rules Manager"]:::config
    end

    %% Relationships
    ViteCore --> BuildHooks
    BuildHooks --> PluginCore
    
    PluginCore --> ConfigHandler
    ConfigHandler --> Pipeline
    Pipeline --> FSInterface
    FSInterface --> OxlintEngine
    OxlintEngine --> OxlintLib
    
    ConfigHandler --> Config
    PluginCore -.-> ESLint
    
    %% Styling
    classDef core fill:#2196F3,stroke:#1565C0,color:white
    classDef config fill:#FF9800,stroke:#F57C00,color:white
    classDef system fill:#4CAF50,stroke:#388E3C,color:white
    classDef pipeline fill:#9C27B0,stroke:#7B1FA2,color:white
    classDef engine fill:#E91E63,stroke:#C2185B,color:white
    classDef external fill:#607D8B,stroke:#455A64,color:white

    %% Click Events
    click PluginCore "https://github.com/52-entertainment/vite-plugin-oxlint/blob/main/src/index.ts"
    click ConfigFile "https://github.com/52-entertainment/vite-plugin-oxlint/blob/main/package.json"
    click WorkingDir "https://github.com/52-entertainment/vite-plugin-oxlint/blob/main/tsconfig.json"
    click OxlintEngine "https://github.com/52-entertainment/vite-plugin-oxlint/blob/main/dist/index.mjs"
    click ConfigHandler "https://github.com/52-entertainment/vite-plugin-oxlint/blob/main/dist/index.d.ts"
    click RulesManager "https://github.com/52-entertainment/vite-plugin-oxlint/blob/main/dist/types.d.ts"
    click FSInterface "https://github.com/52-entertainment/vite-plugin-oxlint/blob/main/rename-to-mjs.js"
    click Pipeline "https://github.com/52-entertainment/vite-plugin-oxlint/blob/main/README.md"

    %% Legend
    subgraph Legend
        direction TB
        L1["Core Component"]:::core
        L2["Configuration"]:::config
        L3["System Interface"]:::system
        L4["Pipeline"]:::pipeline
        L5["Engine"]:::engine
        L6["External"]:::external
    end
```
