component-stats v0.0.1

Component Stats

About this repo | Project board | How to use this repo

About this repo

This tool tracks progress against the project to update Shopify/web to remove duplicate components in favor of a single, extensible component and remove use of polaris-next.

The tool generates usage statistics for a target directory.

Project board

World class admin components

How to use this repo

To run the script on an existing Shopify repository, make sure you have that repository cloned to your computer.

Make sure Git and Node.js are installed on your computer. You should be on Node version 14+. Run the following commands in your terminal to get started:

$ git clone https://github.com/Shopify/component-stats    # git clone repository
$ cd component-stats                                      # access the files
$ npm install                                             # install dependencies
$ npm link                                                # enable global access to dev-stats command
$ dev-stats --type [stat type] [target directory]         # run locally

Note: If you get a permission denied error for npm link, run the command with sudo.

Example usage

If Shopify/web is cloned in the same parent folder as component-stats, the command to run the script should be as follows:

$ dev-stats --type scss ../web

Generate a single SCSS stats file for the target directory.

dev-stats --type scss ../web/packages/@Shopify/polaris-next

Generate historical SCSS stats files for the target directory.

dev-stats --type scss --historical ../web/packages/@Shopify/polaris-next

Note: The above commands will output the generated stats in the current working directory unless overridden by the --output-dir flag or OUTPUT_DIR environment variable.

Run dev-stats --help for detailed usage descriptions.