# bherrero/gulp-sitemap architecture

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

- Interactive diagram: https://gitdiagram.com/bherrero/gulp-sitemap
- Repository: https://github.com/bherrero/gulp-sitemap

## Overview

##### Component Relationships

**Input Stream → File Processing → XML Generation → Output Stream**

Use these specific elements:

a) Primary Components (Use rectangles):
- Gulp Input Stream
- File Processor
- Sitemap Generator
- XML Builder
- Gulp Output Stream

b) Configuration Components (Use hexagons):
- Site URL Configuration
- Mapping Rules
- Global Options

c) Processing Steps (Use rounded rectangles):
- File Path Extraction
- lastmod Calculation
- Priority Assignment
- changefreq Assignment
- hreflang Processing
- Image Processing (when enabled)

##### Technical Details

Annotations for:
- Node.js environment
- Gulp plugin system
- XML output format
- File system interactions

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Input
        GI[Gulp Input Stream]
        FC[File Configuration]:::config
        SC["Site URL Config"]:::config
        MR["Mapping Rules"]:::config
        GO["Global Options"]:::config
    end

    subgraph Processing
        FP["File Processor"]
        SG["Sitemap Generator"]:::core
        FF["File Filter"]:::filter
        MP["Mapping Processor"]
        IP["Image Processor"]
        
        subgraph Validation
            NI["noindex Detection"]:::filter
            FD["404 Detection"]:::filter
        end
        
        subgraph Generation
            PE["Path Extraction"]
            LC["lastmod Calculation"]
            PA["Priority Assignment"]
            CF["changefreq Assignment"]
            HL["hreflang Processing"]
        end
    end

    subgraph Output
        XB["XML Builder"]
        GO["Gulp Output Stream"]
        XF["sitemap.xml"]
    end

    %% Relationships
    GI --> FP
    FC -.-> FP
    SC -.-> SG
    MR -.-> MP
    GO -.-> SG
    
    FP --> FF
    FF --> NI
    FF --> FD
    FF --> MP
    MP --> IP
    MP --> SG
    
    SG --> PE
    PE --> LC
    LC --> PA
    PA --> CF
    CF --> HL
    HL --> XB
    XB --> XF
    XB --> GO

    %% Styles
    classDef default fill:#ddd,stroke:#000,stroke-width:1px
    classDef config fill:#FFA500,stroke:#000,stroke-width:1px
    classDef core fill:#90EE90,stroke:#000,stroke-width:1px
    classDef filter fill:#FFB6C1,stroke:#000,stroke-width:1px
    classDef io fill:#87CEEB,stroke:#000,stroke-width:1px

    %% Click Events
    click SG "https://github.com/bherrero/gulp-sitemap/blob/master/lib/sitemap.js"
    click GI "https://github.com/bherrero/gulp-sitemap/blob/master/gulpfile.js"
    click FP "https://github.com/bherrero/gulp-sitemap/blob/master/test/general.spec.js"
    click MP "https://github.com/bherrero/gulp-sitemap/blob/master/test/mappings.spec.js"
    click FD "https://github.com/bherrero/gulp-sitemap/blob/master/test/fixtures/nested/404.html"
    click NI "https://github.com/bherrero/gulp-sitemap/blob/master/test/fixtures/noindex.html"
    click IP "https://github.com/bherrero/gulp-sitemap/blob/master/test/fixtures/images.html"
    click XF "https://github.com/bherrero/gulp-sitemap/blob/master/sitemap.xml"
    click FC "https://github.com/bherrero/gulp-sitemap/blob/master/package.json"

    %% Legend
    subgraph Legend
        L1["Standard Component"]:::default
        L2["Configuration"]:::config
        L3["Core Processing"]:::core
        L4["Filtering"]:::filter
        L5["Input/Output"]:::io
    end
```
