# nfrasser/linkifyjs architecture

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

- Interactive diagram: https://gitdiagram.com/nfrasser/linkifyjs
- Repository: https://github.com/nfrasser/linkifyjs

## Overview

##### Main Components

Core Library Components (Central):
- Scanner Module (text parsing)
- Parser Module (link detection)
- FSM (Finite State Machine)
- Options Handler
- Multi-language Support
- Text Processor

Interface Adapters (Surrounding the core):
- HTML Interface (linkify-html)
- React Interface (linkify-react)
- jQuery Interface (linkify-jquery)
- String Interface (linkify-string)
- DOM Element Interface (linkify-element)

Plugin System (Extensions):
- Hashtag Plugin
- Mention Plugin
- IP Plugin
- Ticket Plugin
- Keyword Plugin

##### Important Elements to Highlight

- Text Processing Flow:
- Input Text -> Scanner -> Parser -> Interface Adapter -> Output

- Plugin Integration Points:
How plugins extend the core functionality

- Configuration Flow:
Demonstrate how options propagate through the system

##### Additional Details

- Component types
- Integration points
- Build/package relationships

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Core Components
    subgraph Core
        Scanner["Scanner"]:::core
        Parser["Parser"]:::core
        FSM["FSM"]:::core
        Options["Options Handler"]:::core
        Multi["Multi-language"]:::core
        TextProc["Text Processor"]:::core
        
        Scanner --> Parser
        Parser --> FSM
        FSM --> Options
        Options --> Multi
        Multi --> TextProc
        TextProc --> Scanner
    end

    %% Interface Layer
    subgraph Interfaces
        HTML["HTML Interface"]:::interface
        React["React Interface"]:::interface
        jQuery["jQuery Interface"]:::interface
        String["String Interface"]:::interface
        DOM["DOM Element Interface"]:::interface
    end

    %% Plugin Layer
    subgraph Plugins
        Hashtag["Hashtag Plugin"]:::plugin
        Mention["Mention Plugin"]:::plugin
        IP["IP Plugin"]:::plugin
        Ticket["Ticket Plugin"]:::plugin
        Keyword["Keyword Plugin"]:::plugin
    end

    %% Connections
    Core --> HTML
    Core --> React
    Core --> jQuery
    Core --> String
    Core --> DOM

    Hashtag -.-> Parser
    Mention -.-> Parser
    IP -.-> Parser
    Ticket -.-> Parser
    Keyword -.-> Parser

    %% Styling
    classDef core fill:#a8d1f0,stroke:#333
    classDef interface fill:#90EE90,stroke:#333
    classDef plugin fill:#FFB347,stroke:#333

    %% Click Events
    click Scanner "https://github.com/nfrasser/linkifyjs/blob/main/packages/linkifyjs/src/scanner.mjs"
    click Parser "https://github.com/nfrasser/linkifyjs/blob/main/packages/linkifyjs/src/parser.mjs"
    click FSM "https://github.com/nfrasser/linkifyjs/blob/main/packages/linkifyjs/src/fsm.mjs"
    click Options "https://github.com/nfrasser/linkifyjs/blob/main/packages/linkifyjs/src/options.mjs"
    click Multi "https://github.com/nfrasser/linkifyjs/blob/main/packages/linkifyjs/src/multi.mjs"
    click TextProc "https://github.com/nfrasser/linkifyjs/blob/main/packages/linkifyjs/src/text.mjs"
    click HTML "https://github.com/nfrasser/linkifyjs/blob/main/packages/linkify-html/src/linkify-html.mjs"
    click React "https://github.com/nfrasser/linkifyjs/blob/main/packages/linkify-react/src/linkify-react.mjs"
    click jQuery "https://github.com/nfrasser/linkifyjs/blob/main/packages/linkify-jquery/src/linkify-jquery.mjs"
    click String "https://github.com/nfrasser/linkifyjs/blob/main/packages/linkify-string/src/linkify-string.mjs"
    click DOM "https://github.com/nfrasser/linkifyjs/blob/main/packages/linkify-element/src/linkify-element.mjs"
    click Hashtag "https://github.com/nfrasser/linkifyjs/blob/main/packages/linkify-plugin-hashtag/src/hashtag.mjs"
    click Mention "https://github.com/nfrasser/linkifyjs/blob/main/packages/linkify-plugin-mention/src/mention.mjs"
    click IP "https://github.com/nfrasser/linkifyjs/blob/main/packages/linkify-plugin-ip/src/ip.mjs"
    click Ticket "https://github.com/nfrasser/linkifyjs/blob/main/packages/linkify-plugin-ticket/src/ticket.mjs"
    click Keyword "https://github.com/nfrasser/linkifyjs/blob/main/packages/linkify-plugin-keyword/src/keyword.mjs"
```
