# wuba/picasso architecture

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

- Interactive diagram: https://gitdiagram.com/wuba/picasso
- Repository: https://github.com/wuba/picasso

## Overview

##### Main components
- Sketch Plugin Host
– Sketch App (runs the plugin via SKPM)
– Plugin Manifest & Entry (`webpack.skpm.config.js`, `src/manifest.json`, `src/index.js`)
- Plugin UI / WebView
– `resources/webview.html`, `.js`, `.css`
– Presents options: selected/all artboards, target code type
- Plugin Controller & Orchestration
– `src/index.js`, `src/parseArtboard/*`, `src/handleImage/*`
– Receives UI commands, loads artboard JSON, filters layers, handles images
- Transformation Monorepo Packages (`picasso-package/packages/*`)
– parse (`picasso-parse`): transforms Sketch JSON into an intermediate DSL
– group (`picasso-group`): merges/organizes layer groups
– DSL definitions (`picasso-dsl`): exposes UI/Style/Structure components
– code generation (`picasso-trans`): turns DSL into Web/RN/weapp code
– browser integration (`picasso-code` / `picasso-code-browser`): loads transformations in-browser for preview
– Sketch DSL bindings (`sketch-dsl`): Sketch-specific data structures
- Output artifacts
– Generated source code (Web HTML/CSS/SCSS, WXSS/WXML, JSX/StyleSheet)
– Downloaded or copied back into UI

##### Relationships and data flow
- User triggers action in Sketch → UI WebView
- WebView → Plugin Controller
– Passes “artboard JSON + target type”
- Controller calls parseArtboard → intermediate representation (raw nodes + style metadata)
- Sequential pipeline through packages:
parse → layout → group → DSL assembly → code transform
- Final code returned to UI → written to disk or clipboard

##### Architectural patterns
- Monorepo (Lerna) managing loosely‐coupled packages
- Pipeline pattern: each package handles a stage in the transform
- Plugin pattern: SKPM + WebView for UI/host integration
- Adapter layers: sketch-dsl adapts Sketch JSON into a uniform DSL; picasso-trans adapts DSL into target language

##### Technologies & frameworks
- Node.js, SKPM (Sketch Plugin Manager), Webpack
- TypeScript for packages (tsconfig.json in each)
- JavaScript for plugin core (`src/**/*.js`)
- Lerna (monorepo)
- Web UI: plain HTML/JS/CSS loaded by Sketch

##### Detail is critical
- Packages from `picasso-package/packages` as individual pipeline stages
- Where `resources` fit (UI assets) and where top‐level `src/handleImage` and `src/parseArtboard` reside in orchestration
- File watchers / build (npm start, npm run build) as side notes if desired

[Sketch App]
↓
[Plugin WebView (resources/webview.html/js/css)]
↓ “command(targetType, artboardJSON)”
[Plugin Controller (src/index.js + parseArtboard + handleImage)]
↓ artboard JSON
┌───────────────────────────────────────────────────────────────┐
│  Transformation Pipeline (picasso-package)                  │
│  ┌───────────┐  ┌──────────────┐  ┌────────────┐            │
│  │ picasso-  │→ │ picasso-     │→ │ picasso-   │→ ...       │
│  │   parse   │  │   layout     │  │   group    │            │
│  └───────────┘  └──────────────┘  └────────────┘            │
│        ↓ intermediate DSL                                        │
│   ┌──────────────┐   ┌───────────────┐                        │
│   │ picasso-dsl  │ →│ picasso-trans  │                       │
│   └──────────────┘   └───────────────┘                       │
└───────────────────────────────────────────────────────────────┘
↓ generated code (HTML/CSS/SCSS, WXML/WXSS, JSX/Style)
[Output: files saved / clipboard / UI display]

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Plugin Host & Entry
    subgraph "Sketch Plugin Host"
        SketchHost((Sketch App)):::platform
        webpackc["webpack.skpm.config.js"]:::config
        manifest["src/manifest.json"]:::config
        entry["src/index.js"]:::config
    end

    %% UI/WebView
    subgraph "Plugin UI / WebView"
        webviewHtml["resources/webview.html"]:::ui
        webviewJs["resources/webview.js"]:::ui
        webviewCss["resources/style.css"]:::ui
    end

    %% Controller & Orchestration
    subgraph "Plugin Controller & Orchestration"
        Controller["src/index.js"]:::controller
        parseArt["src/parseArtboard/index.js"]:::controller
        handleIm["src/handleImage/index.js"]:::controller
    end

    %% Transformation Pipeline
    subgraph "Transformation Pipeline"
        SketchDSL["sketch-dsl"]:::adapter
        PParse["picasso-parse"]:::pipeline
        PLayout["picasso-layout"]:::pipeline
        PGroup["picasso-group"]:::pipeline
        PDSL["picasso-dsl"]:::pipeline
        PTrans["picasso-trans"]:::pipeline
        PCode["picasso-code"]:::pipeline
        PCodeBrowser["picasso-code-browser"]:::pipeline
    end

    %% Output
    Output["Generated Code<br/>HTML/CSS/SCSS, WXML/WXSS, JSX"]:::output

    %% Data Flow
    SketchHost --> PluginWebView[/"Launch WebView"/] 
    SketchHost --> webpackc
    SketchHost --> manifest
    SketchHost --> entry

    webviewHtml -->|"UI Loaded"| Controller
    webviewJs --> Controller
    webviewCss --> Controller

    Controller -->|"Sketch JSON"| SketchDSL
    SketchDSL -->|"Adapted DSL"| PParse
    PParse -->|"Intermediate Nodes"| PLayout
    PLayout -->|"Layout Data"| PGroup
    PGroup -->|"Grouped Layers"| PDSL
    PDSL -->|"DSL Tree"| PTrans
    PTrans -->|"Generated Code"| PCode
    PTrans -->|"Browser Preview"| PCodeBrowser
    PCode -->|"Final Artifacts"| Output
    PCodeBrowser -->|"Preview Artifacts"| Output

    %% Click Events
    click webpackc "https://github.com/wuba/picasso/blob/master/webpack.skpm.config.js"
    click manifest "https://github.com/wuba/picasso/blob/master/src/manifest.json"
    click entry "https://github.com/wuba/picasso/blob/master/src/index.js"
    click webviewHtml "https://github.com/wuba/picasso/blob/master/resources/webview.html"
    click webviewJs "https://github.com/wuba/picasso/blob/master/resources/webview.js"
    click webviewCss "https://github.com/wuba/picasso/blob/master/resources/style.css"
    click Controller "https://github.com/wuba/picasso/blob/master/src/index.js"
    click parseArt "https://github.com/wuba/picasso/blob/master/src/parseArtboard/index.js"
    click handleIm "https://github.com/wuba/picasso/blob/master/src/handleImage/index.js"
    click PParse "https://github.com/wuba/picasso/tree/master/picasso-package/packages/picasso-parse/"
    click PLayout "https://github.com/wuba/picasso/tree/master/picasso-package/packages/picasso-layout/"
    click PGroup "https://github.com/wuba/picasso/tree/master/picasso-package/packages/picasso-group/"
    click PDSL "https://github.com/wuba/picasso/tree/master/picasso-package/packages/picasso-dsl/"
    click PTrans "https://github.com/wuba/picasso/tree/master/picasso-package/packages/picasso-trans/"
    click PCodeBrowser "https://github.com/wuba/picasso/tree/master/picasso-package/packages/picasso-code-browser/"
    click PCode "https://github.com/wuba/picasso/tree/master/picasso-package/packages/picasso-code/"
    click SketchDSL "https://github.com/wuba/picasso/tree/master/picasso-package/packages/sketch-dsl/"

    %% Styles
    classDef platform fill:#f9f,stroke:#333,stroke-width:2px
    classDef config fill:#ffd,stroke:#333
    classDef ui fill:#bbf,stroke:#333
    classDef controller fill:#bfb,stroke:#333
    classDef adapter fill:#fcf,stroke:#333
    classDef pipeline fill:#ffb,stroke:#333
    classDef output fill:#fea,stroke:#333,stroke-width:2px
```
