# inhiblabcore/vue-hooks-plus architecture

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

- Interactive diagram: https://gitdiagram.com/inhiblabcore/vue-hooks-plus
- Repository: https://github.com/inhiblabcore/vue-hooks-plus

## Overview

##### Project type and purpose
- This is an open‑source, monorepo‑style Vue3 hooks library (“VueHooks Plus”) that publishes multiple small packages (composition hooks, plugins, resolvers, utils, docs tooling) to NPM, and hosts interactive documentation via VitePress on GitHub Pages.

##### File structure and README
- Top‑level: configuration (.eslintrc, tsconfig, Husky, CommitLint, GitHub workflows), pnpm‑workspace.yaml, scripts for building and docs, docs folder for VitePress site, packages folder containing ~10 sub‑packages (hooks core, use‑request, plugins, resolvers, use‑worker, etc.).
- README: describes library features, installation, usage, auto‑import resolver, CDN, docs links, examples, CI badges.

##### Main components
a. Developer Environment
- Node.js + pnpm, Vite, Vitest, ESLint, Prettier, Husky/CommitLint.
- Local scripts: bootstrap.ts, build.ts, docs.ts, gitPage.ts.
b. Monorepo Repository
- Root config & scripts.
- Packages:
- hooks (core Vue hooks)
- use-request (request engine)
- use-request‑plugins
- resolvers (auto‑import resolver)
- use-url-state, use-worker, use-immer, sponsor, types, vitepress utilities, vitepress-demo-block
- docs/: VitePress site with theme, plugins, interactive demos.
c. CI/CD Pipeline (GitHub Actions)
- Workflows: ci.yml (build, test, lint), deploy.yml (publish docs, packages), algolia.yml (update search index), auto‑assign/greetings.
d. External Services
- NPM registry (package publication)
- GitHub Pages (Docs hosting)
- CDN (jsDelivr for IIFE bundle)
- Algolia (search index)

##### Relationships and data flow
- Developer pushes code → GitHub Actions CI builds & tests each package (Vite + TS), lint & commit checks → on release tag: deploy workflow publishes packages to NPM and deploys docs to GitHub Pages → Algolia indexing updates search in docs.
- docs site (VitePress) imports built package bundles (for live demos) and uses resolvers for auto‑import.
- Consumers (apps) install packages via pnpm/npm, optionally use CDN, optionally configure AutoImport plugin (Vite/Webpack).

##### Architectural patterns & design principles
- Monorepo with pnpm workspaces for atomic, versioned packages.
- Modular micro‑packages: each hook or feature is a separate package under packages/.
- CI/CD as code: GitHub workflows automate build, test, deploy, search indexing.
- Documentation as code: docs/ powered by VitePress, integrated with demo components from monorepo.
- On‑demand import and tree‑shaking: each hook exports as separate ESM.
- Test‑driven: Vitest runs per‑package tests.

##### Technologies & frameworks
- Core: TypeScript, Vue3 Composition API, Vite.
- Build: Vite + Rollup, ts‑configs per package.
- Testing: Vitest.
- Lint & formatting: ESLint, Prettier, markdownlint.
- Git hooks: Husky, CommitLint.
- CI/CD: GitHub Actions.
- Docs: VitePress, unplugin‑auto‑import, Algolia search.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Developer Environment
    subgraph "Developer Environment"
        DEV["Developer"]:::devtools
        Scripts["Scripts & Config"]:::code
    end

    %% Monorepo Root
    subgraph "Monorepo Repository"
        RootConfig["Root Config & Scripts"]:::code
        subgraph "Packages"
            subgraph "Core Hooks"
                HooksPkg["packages/hooks"]:::code
            end
            subgraph "Request Engine"
                ReqPkg["packages/use-request"]:::code
                ReqPluginsPkg["packages/use-request-plugins"]:::code
            end
            ResolverPkg["packages/resolvers"]:::code
            URLStatePkg["packages/use-url-state"]:::code
            WorkerPkg["packages/use-worker"]:::code
            ImmerPkg["packages/use-immer"]:::code
            SponsorPkg["packages/sponsor"]:::code
            TypesPkg["packages/types"]:::code
            subgraph "VitePress Utils & Demo"
                VitepressUtils["packages/vitepress/utils"]:::code
                DemoBlock["packages/vitepress/vitepress-demo-block"]:::code
            end
        end
        DocsSource["docs/"]:::docs
    end

    %% CI/CD Pipeline
    subgraph "CI/CD (GitHub Actions)"
        CI["CI Workflow"]:::devtools
        Deploy["Deploy Workflow"]:::devtools
        AlgoliaWF["Algolia Workflow"]:::devtools
        AutoAssign["Auto-assign/Greetings"]:::devtools
    end

    %% External Services
    NPM["NPM Registry"]:::external
    GHPages["GitHub Pages"]:::external
    Algolia["Algolia Search"]:::external
    CDN["jsDelivr CDN"]:::external

    %% Connections
    DEV -->|"push code"| RootConfig
    RootConfig -->|"bootstrap/build/docs scripts"| Scripts
    RootConfig -->|"workspace orchestrate"| HooksPkg
    RootConfig --> ReqPkg
    RootConfig --> ResolverPkg
    RootConfig --> URLStatePkg
    RootConfig --> WorkerPkg
    RootConfig --> ImmerPkg
    RootConfig --> SponsorPkg
    RootConfig --> TypesPkg
    RootConfig --> VitepressUtils
    RootConfig --> DemoBlock
    RootConfig --> DocsSource

    RootConfig -->|"trigger CI"| CI
    CI -->|"build & test packages"| HooksPkg
    CI --> ReqPkg
    CI --> ResolverPkg
    CI --> URLStatePkg
    CI --> WorkerPkg
    CI --> ImmerPkg
    CI --> SponsorPkg
    CI --> TypesPkg
    CI --> VitepressUtils
    CI --> DemoBlock

    Deploy -->|"publish packages"| NPM
    Deploy -->|"deploy docs"| GHPages
    AlgoliaWF -->|"update index"| Algolia

    CI --> Deploy
    CI --> AlgoliaWF
    CI --> AutoAssign

    %% Docs Build & Deployment
    DocsSource -->|"build docs site"| Deploy
    DocsSource -->|"live demos import"| HooksPkg
    DocsSource -->|"auto-import via resolver"| ResolverPkg
    Deploy --> GHPages

    %% Consumer Flow
    Consumer["External Consumers"]:::external
    Consumer -->|"install from NPM"| NPM
    Consumer -->|"use CDN IIFE"| CDN
    Consumer -->|"auto-import plugin"| ResolverPkg

    %% Click Events for scripts & config
    click Scripts "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/scripts/bootstrap.ts"
    click Scripts "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/scripts/build.ts"
    click Scripts "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/scripts/docs.ts"
    click Scripts "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/scripts/gitPage.ts"
    click Scripts "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/package.json"
    click Scripts "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/pnpm-workspace.yaml"
    click Scripts "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/eslint.config.js"
    click Scripts "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/.prettierrc"
    click Scripts "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/.prettierignore"
    click Scripts "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/commitlint.config.cts"
    click Scripts "https://github.com/inhiblabcore/vue-hooks-plus/tree/master/.husky/commit-msg"
    click Scripts "https://github.com/inhiblabcore/vue-hooks-plus/tree/master/.husky/pre-commit"

    %% Click Events for packages
    click HooksPkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/hooks/src/index.ts"
    click HooksPkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/hooks/config/build.ts"
    click HooksPkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/hooks/package.json"

    click ReqPkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/use-request/src/useRequest.ts"
    click ReqPkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/use-request/src/plugins/useCachePlugin.ts"
    click ReqPkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/use-request/src/utils/cache.ts"
    click ReqPkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/use-request/package.json"

    click ReqPluginsPkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/use-request-plugins/src/index.ts"
    click ReqPluginsPkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/use-request-plugins/src/useBroadcastChannelPlugin/index.ts"
    click ReqPluginsPkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/use-request-plugins/package.json"

    click ResolverPkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/resolvers/src/unplugin-auto-import-resolver/index.ts"
    click ResolverPkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/resolvers/src/unplugin-auto-import-resolver/useRequestResolver.ts"
    click ResolverPkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/resolvers/package.json"

    click URLStatePkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/use-url-state/src/index.ts"
    click URLStatePkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/use-url-state/package.json"

    click WorkerPkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/use-worker/src/index.ts"
    click WorkerPkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/use-worker/src/lib/createWorkerBlobUrl.ts"
    click WorkerPkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/use-worker/package.json"

    click ImmerPkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/use-immer/src/index.ts"
    click ImmerPkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/use-immer/package.json"

    click SponsorPkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/sponsor/src/banner.ts"
    click SponsorPkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/sponsor/src/modal.ts"
    click SponsorPkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/sponsor/package.json"

    click TypesPkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/types/index.d.ts"
    click TypesPkg "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/types/package.json"

    click VitepressUtils "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/vitepress/utils/index.ts"
    click DemoBlock "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/vitepress/vitepress-demo-block/src/Demo.vue"
    click DemoBlock "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/packages/vitepress/vitepress-demo-block/package.json"

    %% Click Events for docs
    click DocsSource "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/docs/.vitepress/config/index.ts"
    click DocsSource "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/docs/.vitepress/plugins/applyMdPlugin.ts"
    click DocsSource "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/docs/.vitepress/theme/index.ts"
    click DocsSource "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/docs/components/button/button.vue"
    click DocsSource "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/docs/demo/useRequest/demo.vue"
    click DocsSource "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/docs/en/guide/getting-started.md"
    click DocsSource "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/docs/zh/guide/getting-started.md"

    %% Click Events for CI/CD
    click CI "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/.github/workflows/ci.yml"
    click Deploy "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/.github/workflows/deploy.yml"
    click AlgoliaWF "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/.github/workflows/algolia.yml"
    click AutoAssign "https://github.com/inhiblabcore/vue-hooks-plus/blob/master/.github/workflows/auto-assign.yml"

    %% Styles
    classDef code fill:#D0E8FF,stroke:#0366d6,color:#0366d6;
    classDef devtools fill:#FFD8B8,stroke:#d9730d,color:#d9730d;
    classDef docs fill:#D0FFC8,stroke:#28a745,color:#22863a;
    classDef external fill:#E0E0E0,stroke:#6a737d,color:#6a737d;
```
