# mistylady/titleandurlcapturer architecture

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

- Interactive diagram: https://gitdiagram.com/mistylady/titleandurlcapturer
- Repository: https://github.com/mistylady/titleandurlcapturer

## Overview

##### Project type and purpose
- From the file tree and README, this is a browser extension (full‐stack in the narrow sense of “UI + logic”, but not a web server).

##### File structure
- Top level:
- src/
– config/parameter.ts (extension parameters, default settings)
– lib/ (utility functions: tab info retrieval, formatting, clipboard, filename validation)
– popup/index.tsx (React or JSX popup entry)
– style/style.css
- package.json & pnpm-lock.yaml (build & dependency management)
- tsconfig.json (TypeScript compile config)
- .prettierrc, .gitignore, LICENSE, README.md

- No explicit “background” folder is shown; this appears to be a “popup-only” extension relying on browser.tabs API invoked from the popup.

##### README for additional insights
- Confirms two user actions: “Copy To Clipboard” and “Export to Markdown.”
- Mentions an optional filename input for Markdown export.
- Provides dev/build commands (pnpm dev, pnpm build).

##### Main components & interactions
a. Components:
1. Browser Extension Host (the Chrome/Firefox extension engine)
3. Popup UI (src/popup/index.tsx + style.css)
4. Utility Library (src/lib)
5. Configuration (src/config/parameter.ts)
6. Browser Tabs API (external service)
7. Clipboard API & File Download mechanism

b. Relationships / Data Flow:
- Popup UI imports config & lib modules
- Popup UI calls lib.getTabsInfo → calls browser.tabs.query → returns tabs info
- Depending on user choice:
– lib.copyToClipboard formats data and calls Clipboard API
– lib.exportToMarkdown formats data, asks user for filename (validFilename), then calls a download API or generates a Blob for file save
- All modules are bundled at build time via pnpm scripts + TypeScript compiler

c. Architectural patterns / design principles:
– Separation of concerns: UI layer (popup) vs. business logic (lib) vs. configuration
– Single responsibility: each lib function does one job (copy, format, filename validation)
– Event-driven: UI events trigger tab queries and output actions

d. Key technologies & frameworks:
– TypeScript + tsconfig.json
– React/JSX or Preact (tsx in popup)
– pnpm for package management
– Browser Extension APIs (tabs, clipboard, download)

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Extension Host"
        Icon["Extension Icon / UI Trigger"]:::ui
        Popup["Popup UI\n(index.tsx)"]:::ui
        Config["Configuration Module\n(parameter.ts)"]:::logic
        subgraph "Utility Library"
            GetTabs["Tab Info Service\ngetTabsInfo.ts"]:::logic
            CopyClip["Clipboard Service\ncopyToClipboard.ts"]:::logic
            ExportMD["Markdown Export Service\nexportToMarkdown.ts"]:::logic
            ValidFN["Filename Validation Service\nvalidFilename.ts"]:::logic
        end
        TabsAPI[(Browser Tabs API)]:::external
        ClipboardAPI[(Clipboard API)]:::external
        DownloadAPI[(Download API)]:::external

        Icon -->|"click"| Popup
        Popup -->|"load config"| Config
        Popup -->|"requests tabs"| GetTabs
        GetTabs -->|"calls browser.tabs.query"| TabsAPI
        TabsAPI -->|"returns tabs data"| GetTabs
        GetTabs -->|"returns tabs info"| Popup
        Popup -->|"Copy to Clipboard"| CopyClip
        CopyClip -->|"calls Clipboard API"| ClipboardAPI
        Popup -->|"Export to Markdown"| ExportMD
        ExportMD -->|"validates filename"| ValidFN
        ValidFN -->|"returns valid name"| ExportMD
        ExportMD -->|"calls Download API"| DownloadAPI
    end

    subgraph "Build & Packaging"
        Package["package.json"]:::build
        TSConfig["tsconfig.json"]:::build
        Package -.->|build config| Popup
        TSConfig -.->|compile settings| Popup
    end

    click Icon "https://github.com/mistylady/titleandurlcapturer/tree/master/assets/"
    click Popup "https://github.com/mistylady/titleandurlcapturer/blob/master/src/popup/index.tsx"
    click Config "https://github.com/mistylady/titleandurlcapturer/blob/master/src/config/parameter.ts"
    click GetTabs "https://github.com/mistylady/titleandurlcapturer/blob/master/src/lib/getTabsInfo.ts"
    click CopyClip "https://github.com/mistylady/titleandurlcapturer/blob/master/src/lib/copyToClipboard.ts"
    click ExportMD "https://github.com/mistylady/titleandurlcapturer/blob/master/src/lib/exportToMarkdown.ts"
    click ValidFN "https://github.com/mistylady/titleandurlcapturer/blob/master/src/lib/validFilename.ts"
    click Package "https://github.com/mistylady/titleandurlcapturer/blob/master/package.json"
    click TSConfig "https://github.com/mistylady/titleandurlcapturer/blob/master/tsconfig.json"

    classDef ui fill:#D6EAF8,stroke:#1B4F72,color:#1B2631;
    classDef logic fill:#D5F5E3,stroke:#196F3D,color:#145A32;
    classDef external fill:#D5D8DC,stroke:#808B96,color:#566573,stroke-dasharray: 5 5;
    classDef build fill:#FCF3CF,stroke:#B7950B,color:#7D6608;
```
