How formkit/formkit works
Overview of File Structure
• Root
• pnpm-workspace.yaml – workspace config
• scripts/ – build, bundle, lint, publish pipelines
• examples/ – standalone Vite/Vue demo app
• e2e/ – Playwright/Memory-DOM test suites
• .tests/ – shared Vitest helpers
• packages/ – each subfolder is a self-contained npm package:
• core – reactive form engine, plugin registry, schema compiler
• inputs – built-in input scaffolding (checkbox, text, etc.)
• validation/rules – synchronous and async rules library
• i18n – locale files + formatters
• themes – CSS frameworks integrations (Genesis, Tailwind, Unocss)
• cli – Node.js binary for project scaffolding & exports
• vue – Vue 3 plugin, SSR bindings, composables
• nuxt – Nuxt module, SSR plugin
• tailwindcss – Tailwind plugin integration
• zod – Zod schema integration
• observer, utils, addons, dev – supplemental libs
Main Components & Their Roles
• Core Engine (packages/core)
• Node-based reactive form data model
• Schema compiler → renders Node tree
• Plugin registry for extensions
• Plugin Packages
• Integrations
• Vue plugin (packages/vue) injects components/composables for CSR & SSR
• Nuxt module (packages/nuxt) bootstraps SSR, auto-imports, hooks
• Tailwind plugin (packages/tailwindcss) theme utilities
• CLI (packages/cli) scaffolds projects, themes, exports components
• Examples & Tests
• examples/ – live demo harness
• e2e/ and .tests/ – proof-of-concept and regression tests
• Build & CI/CD
• scripts/ – compile TS, bundle ESM/CJS, publish to npm
• GitHub Actions – run Vitest, E2E, lint, build
Relationships & Data Flow
• Plugins depend on Core → register schema sections, inputs, rules
• Nuxt Module depends on Vue Plugin + SSR helper
• CLI depends on Core + Themes + Vue Plugin to scaffold new apps
• Examples app imports CLI-generated config or direct packages
• CI/CD triggers scripts → build each package → run tests → publish
Architectural Patterns & Principles
• Monorepo & Workspace – PNPM workspaces for atomic versions
• Modular Plugin System – core engine exposes plugin API for inputs, validation, theming
• Schema-Driven Rendering – JSON → AST → DOM via Vue components
• Separation of Concerns – core engine vs. UI layer vs. CLI vs. themes
• SSR & CSR Support – Vue plugin abstracts platform differences