# samualtnorman/hackmud-script-manager architecture

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

- Interactive diagram: https://gitdiagram.com/samualtnorman/hackmud-script-manager
- Repository: https://github.com/samualtnorman/hackmud-script-manager

## Overview

##### Main Components

a. Input Processing Layer
- Source Script Files (.src.js)
- Configuration & Environment Settings
- TypeScript Definitions

b. Core Processing Pipeline
- Preprocessing Stage
- Transformation Stage
- Minification Stage
- Postprocessing Stage

c. Command Line Interface
- Script Management Commands
- Watch Mode System
- Push/Pull Operations

##### Key Relationships to Highlight

**Input Files → Processing Pipeline → Output Files**

##### Specific Implementation Details

A. Input Handler
- Environment Configuration
- File Watchers
- TypeScript Declarations

B. Processing Pipeline (Core)
- Preprocessor
- Seclevel Verification
- Global Variable Detection
- Import Resolution
- Transformer
- Syntax Modernization
- TypeScript Stripping
- Special Variable Replacement
- Minifier
- Code Optimization
- Quine Cheating
- Variable Aliasing
- Postprocessor
- Safety Checks
- Illegal String Prevention
- Final Validation

C. Output Handler
- File Generation
- Game Integration
- Error Reporting

##### Important Flows

- File processing flow:
- Source File → Preprocessing → Transform → Minify → Postprocess → Output File
- Watch mode flow:
- File Change → Processing Pipeline → Auto-update
- Push/Pull operations:
- Local Files ↔ Game Server

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Input
        SF["Source Files (.src.js)"]
        EC["Environment Config"]:::config
        TD["TypeScript Definitions"]:::types
    end

    subgraph CLI["Command Line Interface"]
        CMD["HSM CLI"]:::cli
        WM["Watch Mode"]:::watch
        PP["Push/Pull Operations"]:::ops
    end

    subgraph Pipeline["Core Processing Pipeline"]
        direction TB
        PRE["Preprocessor"]:::pre
        TRF["Transformer"]:::transform
        MIN["Minifier"]:::minify
        POST["Postprocessor"]:::post
        
        PRE --> TRF
        TRF --> MIN
        MIN --> POST
    end

    subgraph ProcessingDetails["Processing Details"]
        direction TB
        PD1["Seclevel Verification"]
        PD2["Global Variable Detection"]
        PD3["Import Resolution"]
        PD4["Syntax Modernization"]
        PD5["TypeScript Stripping"]
        PD6["Variable Aliasing"]
        PD7["Safety Checks"]
        PD8["Final Validation"]
    end

    subgraph Output
        OF["Output Files"]
        GI["Game Integration"]
        ER["Error Reporting"]
    end

    SF --> CMD
    EC --> CMD
    TD --> CMD

    CMD --> Pipeline
    WM --> Pipeline
    PP --> Pipeline

    Pipeline --> OF
    Pipeline --> GI
    Pipeline --> ER

    %% Component Mappings
    click CMD "https://github.com/samualtnorman/hackmud-script-manager/blob/main/src/bin/hsm.ts"
    click WM "https://github.com/samualtnorman/hackmud-script-manager/blob/main/src/watch.ts"
    click PP "https://github.com/samualtnorman/hackmud-script-manager/blob/main/src/push.ts"
    click PRE "https://github.com/samualtnorman/hackmud-script-manager/blob/main/src/processScript/preprocess.ts"
    click TRF "https://github.com/samualtnorman/hackmud-script-manager/blob/main/src/processScript/transform.ts"
    click MIN "https://github.com/samualtnorman/hackmud-script-manager/blob/main/src/processScript/minify.ts"
    click POST "https://github.com/samualtnorman/hackmud-script-manager/blob/main/src/processScript/postprocess.ts"
    click Pipeline "https://github.com/samualtnorman/hackmud-script-manager/tree/main/src/processScript/"
    click TD "https://github.com/samualtnorman/hackmud-script-manager/blob/main/env.d.ts"
    click EC "https://github.com/samualtnorman/hackmud-script-manager/blob/main/tsconfig.json"

    %% Styling
    classDef config fill:#f9f,stroke:#333
    classDef types fill:#ff9,stroke:#333
    classDef cli fill:#9ff,stroke:#333
    classDef watch fill:#f99,stroke:#333
    classDef ops fill:#9f9,stroke:#333
    classDef pre fill:#99f,stroke:#333
    classDef transform fill:#f9f,stroke:#333
    classDef minify fill:#ff9,stroke:#333
    classDef post fill:#9ff,stroke:#333

    %% Legend
    subgraph Legend
        L1["Configuration"]:::config
        L2["Type Definitions"]:::types
        L3["CLI Components"]:::cli
        L4["Watch System"]:::watch
        L5["Operations"]:::ops
        L6["Processing Steps"]:::pre
    end
```
