@shopify/polaris-icons-audit

This package is a command line utility that can be run by any project to generate an audit of SVG usage.

Usage

This package’s audits can be used without installation by using npx.

To run all audits on a folder, specify the relative folder path. For example:

npx @shopify/polaris-icons-audit audit ./app

To run a subset of audits, pass a comma-separated list of audits to the --reports parameter. For example:

npx @shopify/polaris-icons-audit audit ./app --reports=duplicate-content

Valid report names are: duplicate-basenames, duplicate-content, folder-names and icon-content.

Contributing 🙌

We’re always looking for contributors to help us fix bugs, build new features, or improve the project documentation. Refer to our contributing guide (restricted to Shopify employees). 👀

License 📝

Source code is under a custom license based on MIT. The license restricts Polaris icons usage to applications that integrate or interoperate with Shopify software or services, with additional restrictions for external, stand-alone applications.