How gumball12/text-vide works
Main Components
a. Core Package Structure:
• text-vide (main package)
• utils (shared utilities)
• tsconfig (shared TypeScript configuration)
b. Applications:
• Sandbox (demo application)
• Benchmark (performance testing)
Key Architectural Elements
Layer 1 - Client Applications:
• Sandbox | | Benchmark |
• (React + Vite) | | (Node.js) |
• ↓ ↓
• ↓
Layer 2 - Main Package:
• text-vide package |
• Core Processing | |
• getFixationLength | |
• getHighlightedText | |
• HTML Tag/Entity Handling | |
• ↓
Layer 3 - Supporting Packages:
• Utils | | TSConfig |
• Shared Helpers | | Build Config |
Important Details to Highlight
• Processing Components:
• Text Analysis
• Fixation Point Calculation
• HTML Processing
• Text Transformation
• Configuration Flows:
• Options handling
• Build configuration
• TypeScript settings
Data Flow Indicators
• Input text flow
• Processing pipeline
• Output generation
• Configuration application
Input Text → Word Separation → Fixation Point Calculation → HTML Tag Processing → Entity Processing → Final Output
Integration Points
How the library can be consumed:
• Browser (IIFE)
• ESM
• CommonJS
Technical Details
• Build tools (Vite, Turbo)
• Testing framework (Vitest)
• Package management (pnpm)
• CI/CD workflows
The testing and benchmarking infrastructure
Keep the focus on the core text processing functionality while showing how the monorepo structure supports development, testing, and demonstration of the library.
Use standardized symbols:
• Rectangles for packages/modules
• Diamonds for decision points
Remember to maintain a balance between showing the monorepo structure and the actual text processing functionality, as the latter is the primary purpose of the project.