# lingui/js-lingui architecture

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

- Interactive diagram: https://gitdiagram.com/lingui/js-lingui
- Repository: https://github.com/lingui/js-lingui

## Overview

##### Main Components Overview

a) Core Components:
- @lingui/core (Core i18n functionality)
- @lingui/react (React integration layer)
- Message Catalog System
- CLI Tools & Build Pipeline

b) Integration Components:
- Vite Plugin
- Webpack Loader
- Metro Transformer
- SWC Plugin
- Format Handlers (PO, JSON, CSV)

##### Architecture Layers

**┌─────────────────────────────────────────────┐**
- Application Layer              │
- (React, React Native, JavaScript Apps)     │
- ┤
- Integration Layer              │
- (Vite, Webpack, Metro, SWC Integration)    │
- ┤
- Runtime Layer                 │
- (@lingui/react, React Components)          │
- ┤
- Core Layer                   │
- (@lingui/core, Message Format Engine)      │
- ┤
- Build-time Layer               │
- (CLI, Extraction, Compilation)             │
- ┘

##### Data Flow Representation

- Message extraction flow
- Compilation process
- Runtime message loading
- Translation rendering pipeline

**[Source Code] → [Extraction] → [Translation Files] → [Compilation] → [Runtime Messages]**

**[Application] → [@lingui/react] → [@lingui/core] → [Formatted Output]**

##### Component Relationships

Interactions between:
- CLI tools and message catalogs
- Build plugins and compilation process
- React components and core formatting engine
- Format handlers and message storage

##### Optimization Features

Highlight:
- 3kb core bundle size
- Compilation optimization
- Dynamic loading capabilities
- Server-side rendering support

- Universal usage across platforms
- Clean developer experience
- Powerful tooling integration
- Optimized runtime performance

## Diagram (Mermaid)

```mermaid
graph TB
    %% Style Definitions
    classDef application fill:#f9f,stroke:#333
    classDef integration fill:#afd,stroke:#333
    classDef runtime fill:#9cf,stroke:#333
    classDef core fill:#fcf,stroke:#333
    classDef buildtime fill:#ff9,stroke:#333
    classDef storage fill:#c9f,stroke:#333

    subgraph Application["Application Layer"]
        APP["React/React Native Apps"]:::application
    end

    subgraph Integration["Integration Layer"]
        VITE["Vite Plugin"]:::integration
        WEBPACK["Webpack Loader"]:::integration
        METRO["Metro Transformer"]:::integration
        SWC["SWC Plugin"]:::integration
    end

    subgraph Runtime["Runtime Layer"]
        REACT["@lingui/react"]:::runtime
        COMPONENTS["React Components"]:::runtime
        SSR["Server Components"]:::runtime
    end

    subgraph Core["Core Layer"]
        CORE["@lingui/core"]:::core
        ICU["ICU MessageFormat"]:::core
        PLURAL["Plural/Select/Ordinal"]:::core
        RICH["Rich Text Handler"]:::core
    end

    subgraph BuildTime["Build-time Layer"]
        CLI["CLI Tools"]:::buildtime
        EXTRACT["Message Extraction"]:::buildtime
        COMPILE["Compilation"]:::buildtime
        FORMATS["Format Handlers"]:::buildtime
        CONFIG["Configuration"]:::buildtime
        BABEL["Babel Plugins"]:::buildtime
        LOCALE["Locale Detection"]:::buildtime
    end

    subgraph Storage["Message Storage"]
        PO["PO Format"]:::storage
        JSON["JSON Format"]:::storage
        CSV["CSV Format"]:::storage
    end

    %% Relationships
    APP --> REACT
    REACT --> CORE
    CORE --> ICU
    ICU --> PLURAL
    ICU --> RICH

    CLI --> EXTRACT
    EXTRACT --> FORMATS
    FORMATS --> |Store| Storage
    Storage --> COMPILE
    COMPILE --> CORE

    VITE & WEBPACK & METRO & SWC --> COMPILE
    CONFIG --> CLI
    BABEL --> EXTRACT
    LOCALE --> APP

    %% Click Events
    click CORE "https://github.com/lingui/js-lingui/tree/main/packages/core/"
    click REACT "https://github.com/lingui/js-lingui/tree/main/packages/react/"
    click CLI "https://github.com/lingui/js-lingui/tree/main/packages/cli/"
    click PO "https://github.com/lingui/js-lingui/tree/main/packages/format-po/"
    click JSON "https://github.com/lingui/js-lingui/tree/main/packages/format-json/"
    click CSV "https://github.com/lingui/js-lingui/tree/main/packages/format-csv/"
    click VITE "https://github.com/lingui/js-lingui/tree/main/packages/vite-plugin/"
    click WEBPACK "https://github.com/lingui/js-lingui/tree/main/packages/loader/"
    click METRO "https://github.com/lingui/js-lingui/tree/main/packages/metro-transformer/"
    click CONFIG "https://github.com/lingui/js-lingui/tree/main/packages/conf/"
    click BABEL "https://github.com/lingui/js-lingui/tree/main/packages/babel-plugin-extract-messages/"
    click LOCALE "https://github.com/lingui/js-lingui/tree/main/packages/detect-locale/"

    %% Legend
    subgraph Legend
        L1["Application Components"]:::application
        L2["Integration Plugins"]:::integration
        L3["Runtime Components"]:::runtime
        L4["Core Components"]:::core
        L5["Build-time Tools"]:::buildtime
        L6["Storage Components"]:::storage
    end
```
