# mozilla/readability architecture

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

- Interactive diagram: https://gitdiagram.com/mozilla/readability
- Repository: https://github.com/mozilla/readability

## Overview

##### Main Components

a) Core Processing Components:
- Parser Engine (Readability Class)
- DOM Processor
- Content Extractor
- Metadata Extractor
- Scoring System

b) Input/Output Components:
- Input DOM Document
- Output Article Object
- Serialization Layer

c) Utility Components:
- Validation System (isProbablyReaderable)
- Debug Logger
- Configuration Manager

**[Input DOM Document] → [Readability Core]**
- ↓
**[Configuration] →    [Processing Pipeline]    ← [Debug Logger]**
- ↓
- [Output Processing] → [Article Object]

##### Component Relationships

**Input Layer:**
**DOM Document → DOM Processor → Content Analysis**
- ↓
**Processing Layer:**
**[Content Scoring] ← → [Node Filtering] ← → [Metadata Extraction]**
- ↓                   ↓                     ↓
**[Content Cleaning] → [Article Assembly] ← [Metadata Assembly]**
- ↓
**Output Layer:**
**[Serialization] → [Final Article Object]**

##### Implementation Details to Highlight

- Configuration Options
- Article Object Structure
- Supported Metadata Fields
- Security Considerations

##### External Integration Points

Integration with:
- DOM Libraries (e.g., jsdom)
- Sanitization Tools (e.g., DOMPurify)
- CSP Implementation

##### The validation flow through isProbablyReaderable

- Configuration options
- Document flow direction (left to right)
- Component interaction types
- Security checkpoints
- Optional processing steps

This system design should be created using a tool that supports:
- Clear hierarchical relationships
- Proper component grouping
- Detailed annotations
- Multiple connection types
- Expandable sections for detail views

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Input
        DOM[Input DOM Document]
        Config[Configuration Manager]
    end

    subgraph Core["Core Processing Layer"]
        Parser["Parser Engine"]:::core
        DOMProc["DOM Processor"]:::core
        ContentExt["Content Extractor"]
        MetaExt["Metadata Extractor"]
        Score["Scoring System"]
    end

    subgraph Processing["Processing Pipeline"]
        ContentScore["Content Scoring"]
        NodeFilter["Node Filtering"]
        MetaAssembly["Metadata Assembly"]
        ContentClean["Content Cleaning"]
        ArticleAssembly["Article Assembly"]
    end

    subgraph Validation
        Valid["Validation System"]:::validation
        Security["Security Checks"]
    end

    subgraph Output
        Serial["Serialization Layer"]
        Article["Article Object"]
        Types["Type Definitions"]:::types
    end

    subgraph Utilities
        Debug["Debug Logger"]:::debug
        TestGen["Test Generator"]:::test
        TestSuite["Test Suite"]:::test
    end

    DOM --> Parser
    Config --> Parser
    Parser --> DOMProc
    DOMProc --> Valid
    Valid --> ContentExt
    ContentExt --> Score
    Score --> ContentScore
    ContentScore --> NodeFilter
    NodeFilter --> MetaExt
    MetaExt --> MetaAssembly
    NodeFilter --> ContentClean
    ContentClean --> ArticleAssembly
    MetaAssembly --> ArticleAssembly
    ArticleAssembly --> Serial
    Serial --> Article
    Debug --> Processing
    Security --> Processing

    classDef core fill:#a8e6cf
    classDef validation fill:#dcedc1
    classDef types fill:#ffd3b6
    classDef debug fill:#ffaaa5
    classDef test fill:#ff8b94

    click Parser "https://github.com/mozilla/readability/blob/main/Readability.js"
    click DOMProc "https://github.com/mozilla/readability/blob/main/JSDOMParser.js"
    click Valid "https://github.com/mozilla/readability/blob/main/Readability-readerable.js"
    click Types "https://github.com/mozilla/readability/blob/main/index.d.ts"
    click Debug "https://github.com/mozilla/readability/blob/main/test/debug-testcase.js"
    click TestGen "https://github.com/mozilla/readability/blob/main/test/generate-testcase.js"
    click TestSuite "https://github.com/mozilla/readability/blob/main/test/test-readability.js"

    %% Legend
    classDef legendClass fill:#f9f9f9,stroke:#333,stroke-width:1px
    subgraph Legend
        L1[Core Components]:::core
        L2[Validation Components]:::validation
        L3[Type Definitions]:::types
        L4[Debug Tools]:::debug
        L5[Test Components]:::test
    end
```
