How dequelabs/axe-core works
Main Components Overview
a. Core Engine Layer:
• Rule Engine (lib/core)
• Check Engine (lib/checks)
• Commons Utilities (lib/commons)
• Standards Implementation (lib/standards)
b. Integration Layer:
• API Interface (lib/core/public)
• Reporter System (lib/core/reporters)
• Frame Messenger (lib/core/utils/frame-messenger)
• Virtual DOM Implementation (lib/core/base/virtual-node)
c. Rules & Checks Layer:
• Accessibility Rules (lib/rules)
• Check Implementations (lib/checks)
• Rule Matches (test/rule-matches)
Component Relationships
[API Interface] → [Core Engine]
[Core Engine] → [Rules & Checks Layer]
[Core Engine] → [Virtual DOM]
[Frame Messenger] ↔ [Core Engine]
[Reporter System] ← [Core Engine]
[Commons Utilities] ← [All Components]
Data Flow Representation
Flow of accessibility testing:
[Web Page/Application] → [Virtual DOM] → [Rule Engine] → [Check Engine] → [Reporter System] → [Test Results]
Key Integration Points
External integration capabilities:
• Browser Integration
• Test Framework Integration
• CI/CD Integration
• Frame Communication
Specific Implementation Details
• Supported Standards (WCAG 2.0, 2.1, 2.2)
• Localization Support
• Browser Compatibility
• Rule Categories
Technical Specifications
Annotations for:
• JavaScript-based implementation
• Cross-browser support
• Shadow DOM support
• iframe handling
Notes Section
Important details about:
• Zero false positives philosophy
• Automated vs manual checks
• Configuration options
• Performance considerations
Version Information
A section showing:
• Current version
• Support timeline
• Update frequency
• Security considerations
• Modularity of the system
• Extensibility points
• Security features
• Performance optimization points
• Integration capabilities
Remember to:
• Clear boundaries between components
• Critical paths and dependencies
• Error handling flows
• Scalability considerations