How taogreat/vue works
Project Type and Purpose
• This is the Vue.js core repository—a progressive, framework-style UI library rather than a traditional full-stack application.
• It provides:
• A core runtime & reactivity system (src/core & src/observer)
• A template compiler (src/compiler)
• Platform-specific adaptors (src/platforms/web, src/platforms/weex)
• A server‐side renderer (src/server & packages/vue-server-renderer)
• Bundled outputs in dist/ for browser and Node
• Auxiliary packages for template‐only compilation, Weex framework, and renderers
File Structure Analysis
• Top-level folders:
• src/ – source code grouped by responsibility:
– src/compiler – parses Vue templates into render functions
– src/core – the reactive data system, component API, VDOM implementation
– src/platforms – web & Weex compile/runtime adaptations
– src/server – SSR code & webpack integration
– src/sfc – single‐file component parser
– src/shared – cross‐cutting utilities & constants
• packages/ – independent NPM packages (vue-server-renderer, vue-template-compiler, weex-template-compiler, weex-vue-framework)
• dist/ – compiled bundles (UMD, ESM, runtime-only, full build)
• scripts/ – build and release automation
• benchmarks/ & examples/ – demonstration and performance testing
• test/ – unit, SSR, e2e, and Weex test suites
• Build pipeline: src/ → scripts/build.js & scripts/config.js → dist/ outputs
• CI/config files: CircleCI, ESLint, Flow, TypeScript definitions
README Insights
• Emphasizes Vue’s role as a progressive framework and lists related ecosystem projects.
• Main Components:
A. Developer API Layer
• Global API (Vue.use, mixin, extend)
• Component API (data, props, computed, lifecycle hooks)
B. Compiler (src/compiler & vue-template-compiler)
• Template Parser → AST → Codegen → Render Functions
C. Runtime Core (src/core + src/observer + src/vdom)
• Reactive state & watcher dispatch
• Virtual DOM creation & patch
D. Platform Adapters
• Web runtime & compiler modules (src/platforms/web)
• Weex runtime & compiler modules (src/platforms/weex)
E. Server‐Side Renderer (src/server & vue-server-renderer)
• Bundle runner
• Template‐to‐stream / string renderers
F. Build System & Packaging (scripts/, Rollup/Webpack plugins in src/server/webpack-plugin)
G. Distribution (dist/* bundles)
H. Examples & Benchmarks (illustrative frontends, performance tests)
I. Testing (test suites verifying each module)
• Relationships & Data Flow:
1. Source Code is consumed by Build Scripts → produces dist Bundles & NPM Packages.
2. At runtime (Browser / Node):
• User Code → uses Compiled Vue (dist/vue.js or runtime-only)
• Vue API invokes Reactive System → VDOM → Platform Patch (DOM ops for web, Weex ops for weex)
3. On SSR:
• User Components + Render Context → Server‐Side Renderer → HTML string/stream
• Architectural Patterns & Principles:
• Modularization: clear separation of compiler, core, platform layers
• Pluggable Platform: abstraction over DOM operations, directives, patch modules
• Reactivity + VDOM: one-way data flow with dependency tracking
• Incremental Adoption: runtime-only vs compiler+runtime builds
• Technologies & Frameworks:
• JavaScript w/ Flow types
• Build via Rollup/Webpack (scripts/config.js)
• Linting (ESLint), CI (CircleCI)
• Testing (Jasmine, Nightwatch, e2e harness)