| 1 | # @shopify/polaris-icons-audit
|
| 2 |
|
| 3 | [](https://www.npmjs.com/package/@shopify/polaris-icons-audit)
|
| 4 |
|
| 5 | > This package is a command line utility that can be run by any project to generate an audit of SVG usage.
|
| 6 |
|
| 7 | ## Usage
|
| 8 |
|
| 9 | This package’s audits can be used without installation by using `npx`.
|
| 10 |
|
| 11 | To run all audits on a folder, specify the relative folder path. For example:
|
| 12 |
|
| 13 | ```sh
|
| 14 | npx @shopify/polaris-icons-audit audit ./app
|
| 15 | ```
|
| 16 |
|
| 17 | To run a subset of audits, pass a comma-separated list of
|
| 18 | audits to the `--reports` parameter. For example:
|
| 19 |
|
| 20 | ```sh
|
| 21 | npx @shopify/polaris-icons-audit audit ./app --reports=duplicate-content
|
| 22 | ```
|
| 23 |
|
| 24 | Valid report names are: `duplicate-basenames`, `duplicate-content`, `folder-names` and `icon-content`.
|
| 25 |
|
| 26 | ## Contributing 🙌
|
| 27 |
|
| 28 | We’re always looking for contributors to help us fix bugs, build new features, or improve the project documentation. Refer to our [contributing guide](https://github.com/Shopify/polaris-icons/blob/main/CONTRIBUTING.md) (restricted to Shopify employees). 👀
|
| 29 |
|
| 30 | ## License 📝
|
| 31 |
|
| 32 | Source code is under a [custom license](https://unpkg.com/browse/@shopify/polaris-icons-audit/LICENSE.md) 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.
|