What is VA Design System Monitor?
VA Design System Monitor is an open-source tool designed for monitoring the usage and compliance of the Department of Veterans Affairs design system. It provides insights into component status and maturity levels, along with real implementation examples fetched directly from VA's official Storybook.
How to use VA Design System Monitor?
To use the VA Design System Monitor, you can install it as an npm package or run it as an MCP service. For npm installation, use the command npm install -g va-design-system-monitor for global access or npm install va-design-system-monitor for local use. You can then run commands to check component status, fetch examples, and generate reports.
Key features of VA Design System Monitor?
- Fetches real HTML examples from VA's Storybook repository.
- Monitors component status and maturity levels.
- Generates intelligent examples when official ones are not available.
- Offers multiple interfaces including CLI, programmatic API, and MCP service.
- Production-ready and cross-compatible with Node.js versions 14.15.0 and above.
Use cases of VA Design System Monitor?
- Monitoring the status of VA design system components.
- Fetching real-world examples for implementation.
- Generating reports on component maturity and recommendations.
- Validating components for production readiness.
FAQ from VA Design System Monitor?
-
Can I use VA Design System Monitor for any VA component?
Yes, it supports all components within the VA design system. -
Is it free to use?
Yes, VA Design System Monitor is open-source and free for everyone. -
How do I contribute to the project?
You can contribute by forking the repository, making changes, and submitting a pull request.