# vitejs/vite-plugin-vue architecture

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

- Interactive diagram: https://gitdiagram.com/vitejs/vite-plugin-vue
- Repository: https://github.com/vitejs/vite-plugin-vue

## Overview

##### Project type and purpose
- This is an open-source monorepo providing two Vite plugins: “@vitejs/plugin-vue” and “@vitejs/plugin-vue-jsx.”
- Its purpose is to integrate Vue Single-File Components (SFCs) and JSX support into the Vite build pipeline.

##### File structure
- Top-level:
– Monorepo config: pnpm-workspace.yaml, package.json, tsconfig.json, CI/workflow files under .github/workflows
– scripts/: build, release, patch utilities
– packages/: two packages (plugin-vue, plugin-vue-jsx), each with its own src/ modules, build.config.ts, package.json, tsconfig.json
– playground/: dozens of example consumer projects testing SFC handling, SSR, tailwind, JSX, etc.
- Patterns:
– Monorepo using pnpm workspaces
– Each plugin follows a build script (Rollup) to output ESM/CJS + types
– playground/ projects import the plugin and exercise its hooks

##### README for additional insights
- Confirms two public packages and links to their detailed READMEs

##### Elements
– from .vue files into parsing hook
– from plugin output back to Vite bundler
– from build scripts into NPM registry
– from CI into test runners and release scripts

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Developer Layer
    DeveloperCode["Developer Application<br/>(.vue / .jsx files)"]:::dev

    %% Core Runtime
    ViteCore["Vite Core<br/>(Plugin Host)"]:::runtime
    VueCompiler["Vue Compiler-SFC<br/>(node_modules/vue/compiler-sfc)"]:::runtime

    %% Monorepo Packages
    subgraph "Monorepo Packages"
        direction TB
        subgraph "@vitejs/plugin-vue" 
            direction TB
            PV_Index["index.ts"]:::runtime
            PV_Compiler["compiler.ts"]:::runtime
            PV_Script["script.ts"]:::runtime
            PV_Template["template.ts"]:::runtime
            PV_Style["style.ts"]:::runtime
            PV_HotUpdate["handleHotUpdate.ts"]:::runtime
            PV_Helper["helper.ts"]:::runtime
            PV_Descriptor["descriptorCache.ts"]:::runtime
            PV_Error["error.ts"]:::runtime
            PV_Query["query.ts"]:::runtime
        end
        subgraph "@vitejs/plugin-vue-jsx"
            direction TB
            PJ_Index["index.ts"]:::runtime
            PJ_Types["types.ts"]:::runtime
        end
    end

    %% Playground
    Playground["Playground Examples"]:::dev

    %% Build & Release Infrastructure
    CI["GitHub Actions CI/CD"]:::infra
    Scripts["Build & Release Scripts"]:::infra
    NPM["NPM Registry"]:::infra

    %% Vitest Configs
    Vitest["Vitest Configurations"]:::infra

    %% Lint & Misc Config
    Lint["Lint / Formatting / Misc Config"]:::infra

    %% Flows
    DeveloperCode -->|"imports| writes"| ViteCore
    ViteCore -->|"invoke hooks"| PV_Index
    ViteCore -->|"invoke hooks"| PJ_Index
    PV_Index -->|"parse .vue|calls"| PV_Compiler
    PV_Index -->|"transform .vue|calls"| PV_Script
    PV_Index -->|"transform template|calls"| PV_Template
    PV_Index -->|"transform style|calls"| PV_Style
    PV_Index -->|"handle HMR|calls"| PV_HotUpdate
    PV_Descriptor --> PV_Index
    PV_Helper --> PV_Index
    PV_Error --> PV_Index
    PV_Query --> PV_Index
    PV_Compiler -->|"uses"| VueCompiler
    PJ_Index -->|"transform JSX"| DeveloperCode
    ViteCore -->|"bundle modules"| DeveloperCode
    Playground -->|"consumes plugins|tested in"| CI
    CI -->|"runs tests|uses"| Vitest
    CI -->|"runs scripts"| Scripts
    Scripts -->|"publish artifacts"| NPM
    Lint --> CI

    %% Click Events for Component Mapping
    click pnpmPW "https://github.com/vitejs/vite-plugin-vue/blob/main/pnpm-workspace.yaml"
    click rootPkg "https://github.com/vitejs/vite-plugin-vue/blob/main/package.json"
    click rootTS "https://github.com/vitejs/vite-plugin-vue/blob/main/tsconfig.json"
    click patchCJS "https://github.com/vitejs/vite-plugin-vue/blob/main/scripts/patchCJS.ts"
    click publishCI "https://github.com/vitejs/vite-plugin-vue/blob/main/scripts/publishCI.ts"
    click releaseScript "https://github.com/vitejs/vite-plugin-vue/blob/main/scripts/release.ts"
    click releaseUtils "https://github.com/vitejs/vite-plugin-vue/blob/main/scripts/releaseUtils.ts"
    click ciYML "https://github.com/vitejs/vite-plugin-vue/blob/main/.github/workflows/ci.yml"
    click publishYML "https://github.com/vitejs/vite-plugin-vue/blob/main/.github/workflows/publish.yml"
    click rcYML "https://github.com/vitejs/vite-plugin-vue/blob/main/.github/workflows/release-continuous.yml"
    click rtYML "https://github.com/vitejs/vite-plugin-vue/blob/main/.github/workflows/release-tag.yml"
    click spYML "https://github.com/vitejs/vite-plugin-vue/blob/main/.github/workflows/semantic-pull-request.yml"
    click pvBuild "https://github.com/vitejs/vite-plugin-vue/blob/main/packages/plugin-vue/build.config.ts"
    click pvPkg "https://github.com/vitejs/vite-plugin-vue/blob/main/packages/plugin-vue/package.json"
    click pvTs "https://github.com/vitejs/vite-plugin-vue/blob/main/packages/plugin-vue/tsconfig.json"
    click pvIndex "https://github.com/vitejs/vite-plugin-vue/blob/main/packages/plugin-vue/src/index.ts"
    click pvCompiler "https://github.com/vitejs/vite-plugin-vue/blob/main/packages/plugin-vue/src/compiler.ts"
    click pvScript "https://github.com/vitejs/vite-plugin-vue/blob/main/packages/plugin-vue/src/script.ts"
    click pvTemplate "https://github.com/vitejs/vite-plugin-vue/blob/main/packages/plugin-vue/src/template.ts"
    click pvStyle "https://github.com/vitejs/vite-plugin-vue/blob/main/packages/plugin-vue/src/style.ts"
    click pvHot "https://github.com/vitejs/vite-plugin-vue/blob/main/packages/plugin-vue/src/handleHotUpdate.ts"
    click pvHelper "https://github.com/vitejs/vite-plugin-vue/blob/main/packages/plugin-vue/src/helper.ts"
    click pvDesc "https://github.com/vitejs/vite-plugin-vue/blob/main/packages/plugin-vue/src/utils/descriptorCache.ts"
    click pvError "https://github.com/vitejs/vite-plugin-vue/blob/main/packages/plugin-vue/src/utils/error.ts"
    click pvQuery "https://github.com/vitejs/vite-plugin-vue/blob/main/packages/plugin-vue/src/utils/query.ts"
    click pjBuild "https://github.com/vitejs/vite-plugin-vue/blob/main/packages/plugin-vue-jsx/build.config.ts"
    click pjPkg "https://github.com/vitejs/vite-plugin-vue/blob/main/packages/plugin-vue-jsx/package.json"
    click pjTs "https://github.com/vitejs/vite-plugin-vue/blob/main/packages/plugin-vue-jsx/tsconfig.json"
    click pjIndex "https://github.com/vitejs/vite-plugin-vue/blob/main/packages/plugin-vue-jsx/src/index.ts"
    click pjTypes "https://github.com/vitejs/vite-plugin-vue/blob/main/packages/plugin-vue-jsx/src/types.ts"
    click playgroundDir "https://github.com/vitejs/vite-plugin-vue/tree/main/playground/"
    click vitestConfig "https://github.com/vitejs/vite-plugin-vue/blob/main/vitest.config.ts"
    click vitestE2E "https://github.com/vitejs/vite-plugin-vue/blob/main/vitest.config.e2e.ts"
    click eslintConfig "https://github.com/vitejs/vite-plugin-vue/blob/main/eslint.config.js"
    click prettierrc "https://github.com/vitejs/vite-plugin-vue/blob/main/.prettierrc.json"
    click prettierIgnore "https://github.com/vitejs/vite-plugin-vue/blob/main/.prettierignore"
    click editorConfig "https://github.com/vitejs/vite-plugin-vue/blob/main/.editorconfig"
    click npmrc "https://github.com/vitejs/vite-plugin-vue/blob/main/.npmrc"
    click gitattributes "https://github.com/vitejs/vite-plugin-vue/blob/main/.gitattributes"
    click gitignore "https://github.com/vitejs/vite-plugin-vue/blob/main/.gitignore"

    %% Styles
    classDef runtime fill:#cce5ff,stroke:#4da3ff,color:#004085
    classDef dev fill:#d4edda,stroke:#28a745,color:#155724
    classDef infra fill:#fff3cd,stroke:#ffeeba,color:#856404
    class DeveloperCode,Playground dev
    class ViteCore,VueCompiler,PV_Index,PV_Compiler,PV_Script,PV_Template,PV_Style,PV_HotUpdate,PV_Helper,PV_Descriptor,PV_Error,PV_Query,PJ_Index,PJ_Types runtime
    class CI,Scripts,NPM,Vitest,Lint infra
```
