# netease/tango architecture

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

- Interactive diagram: https://gitdiagram.com/netease/tango
- Repository: https://github.com/netease/tango

## Overview

##### Project Type and Purpose
- Tango is a **monorepo** (Lerna + Yarn) that delivers a **front‑end low‑code builder**.
- It provides core AST‑based code generation libraries, a React “designer” UI, helper utilities, code sandbox runtime, setting‐form DSL components, and UI primitives.
- Two consumer apps live alongside: a Playground demo app and a Storybook showcase.

##### Main Components
A. Monorepo Root & Tooling
- Lerna (package management)
- Yarn workspaces
- CI/CD (GitHub workflows: ci.yml, deploy.yml)
- Build configs (babel.config.js, jest.config.js, tsconfig.json files)
B. Package Layer (each published to NPM)
1) **@music163/tango-core**
– AST parser/traverser/generator, Code workspace models, engine, history.
2) **@music163/tango-context**
– React Context providers for workspace, selection, drag‑drop.
3) **@music163/tango-designer**
– Designer Panel, Simulator, Sidebar, Toolbar, DnD, variable trees, context menus, setters.
4) **@music163/tango-ui**
5) **@music163/tango-setting-form**
– Form model, UI for property panels, built-in setters (bool, code, text, etc.).
6) **@music163/tango-sandbox**
– CodeSandbox integration, iframe protocol, live preview manager.
7) **@music163/tango-helpers**
– Generic JS/React utilities, hooks, stores, HOCs.
8) **@music163/tango-spec**
– Configuration schema for AST rules (tango-config).
C. Consumer Applications
1) **Playground** (apps/playground)
– Demo / local development environment, imports all packages, serves over Umi.
2) **Storybook** (apps/storybook)
– Isolated component catalog for designer, ui, setting‑form, sandbox artifacts.

##### Relationships & Interactions
- **Playground & Storybook →** import **all packages** via workspace links.
- **Designer components (tango-designer) →** use **core** for AST-based code logic, **context** for state propagation, **ui** and **setting-form** for rendering property editors.
- **Sandbox** provides runtime embedding for live‑editing previews and code execution.
- **Helpers** are consumed pervasively by all other packages.
- **Spec** feeds AST transforms and code schema validations into core and designer.

##### Architectural Patterns & Principles
- **Modular Monorepo**: clear separation of concerns by package; Lerna for versioning/publishing.
- **Component‑Based UI**: React components grouped by domain (designer UI, setting form, sandbox).
- **AST‑Driven Code Gen**: core library uses visitor pattern to parse, traverse, generate code.
- **Context‑based State**: React Context to share editor/workspace state.
- **Pluggable Extensions**: setting‑form setters, ui primitives, spec config make the system extensible.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Tooling & CI
    subgraph "Tooling & CI"
        direction TB
        CI_CD["CI/CD (GitHub Workflows)"]:::tooling
        Lerna["Lerna (package mgmt)"]:::tooling
        Yarn["Yarn Workspaces"]:::tooling
        BuildConfigs["Build Configs"]:::tooling
    end

    %% Monorepo Root
    Monorepo["Monorepo Root"]:::root

    CI_CD --> Monorepo
    Lerna --> Monorepo
    Yarn --> Monorepo
    BuildConfigs --> Monorepo

    %% Packages Layer
    subgraph "Packages" 
        direction TB
        Core["@music163/tango-core\n(TS, AST parser/generator, models)"]:::package
        Context["@music163/tango-context\n(React Context providers)"]:::package
        Designer["@music163/tango-designer\n(React, DnD, Simulator)"]:::package
        UI["@music163/tango-ui\n(UI primitives)"]:::package
        SettingForm["@music163/tango-setting-form\n(Form model, setters)"]:::package
        Sandbox["@music163/tango-sandbox\n(CodeSandbox iframe, live preview)"]:::package
        Helpers["@music163/tango-helpers\n(JS/React utilities)"]:::package
        Spec["@music163/tango-spec\n(AST schema config)"]:::package
    end

    Monorepo --> Core
    Monorepo --> Context
    Monorepo --> Designer
    Monorepo --> UI
    Monorepo --> SettingForm
    Monorepo --> Sandbox
    Monorepo --> Helpers
    Monorepo --> Spec

    %% Internal Package Relationships
    Designer -->|"uses"| Core
    Designer -->|"uses"| Context
    Designer -->|"uses"| UI
    Designer -->|"uses"| SettingForm
    Designer -->|"uses"| Sandbox

    Core -->|"uses"| Spec
    Spec -->|"schemas for"| Core
    Core --> Helpers
    Context --> Helpers
    Designer --> Helpers
    UI --> Helpers
    SettingForm --> Helpers
    Sandbox --> Helpers
    Spec --> Helpers

    %% Consumer Apps
    subgraph "Consumer Apps"
        direction TB
        Playground["Playground\n(Umi demo)"]:::app
        Storybook["Storybook\n(component catalog)"]:::app
    end

    Playground -->|imports| Core
    Playground -->|imports| Context
    Playground -->|imports| Designer
    Playground -->|imports| UI
    Playground -->|imports| SettingForm
    Playground -->|imports| Sandbox
    Playground -->|imports| Helpers
    Playground -->|imports| Spec

    Storybook -->|imports| Core
    Storybook -->|imports| Context
    Storybook -->|imports| Designer
    Storybook -->|imports| UI
    Storybook -->|imports| SettingForm
    Storybook -->|imports| Sandbox
    Storybook -->|imports| Helpers
    Storybook -->|imports| Spec

    %% External Systems
    Browser(("Browser")):::external
    NPMRegistry(("NPM Registry")):::external

    Playground -->|runs in| Browser
    Designer -->|preview via iframe| Sandbox
    Monorepo -.->|publishes| NPMRegistry

    %% Click Events
    click CI_CD "https://github.com/netease/tango/blob/main/.github/workflows/ci.yml"
    click CI_CD "https://github.com/netease/tango/blob/main/.github/workflows/deploy.yml"
    click Lerna "https://github.com/netease/tango/blob/main/lerna.json"
    click BuildConfigs "https://github.com/netease/tango/blob/main/babel.config.js"
    click BuildConfigs "https://github.com/netease/tango/blob/main/jest.config.js"
    click BuildConfigs "https://github.com/netease/tango/blob/main/tsconfig.json"
    click Core "https://github.com/netease/tango/tree/main/packages/core"
    click Context "https://github.com/netease/tango/tree/main/packages/context"
    click Designer "https://github.com/netease/tango/tree/main/packages/designer"
    click UI "https://github.com/netease/tango/tree/main/packages/ui"
    click SettingForm "https://github.com/netease/tango/tree/main/packages/setting-form"
    click Sandbox "https://github.com/netease/tango/tree/main/packages/sandbox"
    click Helpers "https://github.com/netease/tango/tree/main/packages/helpers"
    click Spec "https://github.com/netease/tango/tree/main/packages/spec"
    click Playground "https://github.com/netease/tango/tree/main/apps/playground"
    click Storybook "https://github.com/netease/tango/tree/main/apps/storybook"

    %% Styles
    classDef tooling fill:#d3d3d3,stroke:#333,stroke-width:1px
    classDef root fill:#ffffff,stroke:#666,stroke-width:2px
    classDef package fill:#c6efce,stroke:#2e7d32,stroke-width:1px
    classDef app fill:#bbdefb,stroke:#0d47a1,stroke-width:1px
    classDef external fill:#fff9c4,stroke:#f9a825,stroke-width:1px
```
