How inhiblabcore/vue-hooks-plus works
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.