Design system dashboard MVP

[cvalarida]

Issue Description

I had an idea for a "design system dashboard" MVP. The goal for this project is to get a bird-eye view of how the parts of the design system are being used.

This ticket is to capture work for building the MVP only.

Post-MVP

Post-MVP may include a self-service web-app that doesn't require an engineer to run a command and reports on other things such as analytics on documentation.

Acceptance Criteria

A tool is built which:

• [x] May be run on an engineer's machine from the command line
• [x] Analyzes the vets-website monorepo for uses of design system
• [x] Creates a report containing
  • [x] The number of times a design system component is used
    • Across all applications
    • Per application
  • [ ] ~The number of applications using the forms library~
    • Which applications these are
    • Split this out to https://github.com/department-of-veterans-affairs/va.gov-team/issues/20448
• [x] Outputs the report to the terminal
• [x] Outputs the report to a CSV file
  • We can put this in a spreadsheet to track usage over time

Implementation details

• We can do a grep or ripgrep search for `import (*) from '@department-of-veterans-affairs/component-library"
  • Need to figure out how this works for the telephone component, since we may import Telephone, { CONTACTS }
  • Potentially, we run esprima or another JS parser to search via AST, but this will be a lot slower
• Don't forget to exclude test files from the search
• To find the application a module belongs to, search for the closest manifest file
  • If none is found, mark it as uncategorized and drop the path in the report
  • Alternatively, we can use the registry.json, but that'll exclude anything not in there...which may be fine..?
• To flag an applications as one that uses the forms library, search for an import from platform/forms or platform/forms-system
  • No need to count the number

[cvalarida]

I wrote https://github.com/department-of-veterans-affairs/design-system-dashboard-cli to solve this.

We'll track the results in a spreadsheet over time for now.