Skip to content

Latest commit

 

History

History
117 lines (71 loc) · 3.3 KB

README.md

File metadata and controls

117 lines (71 loc) · 3.3 KB
Raw

@georgewrmarshall/design-system-metrics

A CLI tool to audit design system component usage across multiple MetaMask codebases

Getting Started

Extension

  1. Clone the MetaMask Extension repository if you haven’t already:
git clone https://github.com/MetaMask/metamask-extension.git
  1. Run the CLI tool from the @georgewrmarshall/design-system-metrics package:

Navigate to the @georgewrmarshall/design-system-metrics package directory:

cd /path/to/@georgewrmarshall/design-system-metrics
  1. Run the CLI tool for the MetaMask Extension:
yarn node index.js --project extension
  1. A file called extension-component-adoption-metrics.csv will be generated in the current working directory if there are no errors.

Mobile

  1. Clone the MetaMask Mobile repository if you haven’t already:
git clone https://github.com/MetaMask/metamask-mobile.git
  1. Run the CLI tool from the @georgewrmarshall/design-system-metrics package:

Navigate to the @georgewrmarshall/design-system-metrics package directory:

cd /path/to/@georgewrmarshall/design-system-metrics
  1. Run the CLI tool for the MetaMask Mobile project:
yarn node index.js --project mobile
  1. A file called mobile-component-adoption-metrics.csv will be generated in the current working directory if there are no errors.

CLI Options

  • --project (Required): Specify the project to audit. Options are:

  • extension: For MetaMask Extension

  • mobile: For MetaMask Mobile

Example:

yarn node index.js --project extension
  • --format (Optional): Specify the output format. Options are csv (default) or json.

Example:

yarn node index.js --project extension --format json
  • Custom Configuration: By default, the tool uses a config.json file to define the component list and ignore patterns. You can also pass a custom configuration file by adding the --config option:
yarn node index.js --project extension --config /path/to/custom-config.json

Requirements

  • The tool ignores deprecated components (e.g., component-library/deprecated).
  • The tool does not count duplicate components when imported from different locations (e.g., <Button from ../../ui/button versus <Button from ../../component-library).
  • Components inside JSDoc comments are not counted (e.g., @deprecated <Box /> is deprecated in favour of <Box />).

Example Output

Upon running the CLI tool, a CSV file will be generated in the root of the repository (e.g., extension-component-adoption-metrics.csv or mobile-component-adoption-metrics.csv), listing the components and the number of instances where they are used.

Contributing

If you wish to contribute to the tool, ensure you are running the latest version of Yarn (v4.x) and Node.js. You can make adjustments to the config.json file or update the CLI logic for tracking additional components or repositories.

License

This project is licensed under the MIT License.