How yeonjuan/html-eslint works
Main Components Identification
• CLI Package (@html-eslint/cli)
• ESLint Plugin (@html-eslint/eslint-plugin)
• Parser (@html-eslint/parser)
• Template Parser (@html-eslint/template-parser)
• Web Linter (@html-eslint/web-linter)
• Website Package (documentation and playground)
┌─────────────────────────────────────────────┐
• HTML ESLint Core │
• ┬───────────────┬──────────┤
• ESLint Plugin │ Parser │ Template │
• Parser │
• ┴───────────────┴──────────┘
┌─────────────────┐ ┌─────────────────┐
• CLI │ │ Web Linter │
• ┘ └─────────────────┘
┌─────────────────────────────────────┐
• Website │
• (Documentation + Playground) │
• ┘
Component Relationships
• CLI → ESLint Plugin (uses)
• Web Linter → ESLint Plugin (uses)
• ESLint Plugin → Parser (depends on)
• Parser → Template Parser (uses)
• Website → Web Linter (integrates)
Additional Elements
Important elements:
• Rule Definitions (connected to ESLint Plugin)
• Configuration System
• Test Infrastructure
• Documentation Generation Flow
Implementation Details
ESLint Plugin:
• Rule Implementation
• Configuration Presets
• HTML AST Handling
Parser:
• HTML Parsing
• AST Generation
• Traversal Utilities
CLI:
• Command Processing
• File Handling
• Report Generation
External Integrations
Integration points with:
• ESLint Core
• Editor Integration
• CI/CD Systems
The flow from input (HTML files) to output (lint results)
Keep the abstraction level focused on the architectural components while showing enough detail to understand the system's operation and data flow.
• How the different packages interact
• The processing flow of HTML linting
• Integration points for extending the system
• The overall architecture of the HTML ESLint ecosystem