@mbcrm/icon-build-helpers
v1.0.0
Published
Build helpers for the CRM Design System icon library
Readme
@mbcrm/icon-build-helpers
Build helpers for the mbcrm Design System icon library
Getting started
To install @mbcrm/icon-build-helpers in your project, you will need to run
the following command using npm:
npm install -S @mbcrm/icon-build-helpersIf you prefer Yarn, use the following command instead:
yarn add @mbcrm/icon-build-helpersUsage
@mbcrm/icon-build-helpers is a private module in the mbcrm Design System
monorepo. The purpose of this module is to centralize tooling for:
- Searching a directory of
.svgassets and structuring them in terms of size and prefixes - Custom builders for various libraries, which currently include:
- Vanilla
- React
- Implementing repo status checks in CI around icon metadata files, namely
metadata.ymlandcategories.yml
As a result, these file power the generation of the following SVG-based projects:
@mbcrm/icons@mbcrm/icons-react@mbcrm/pictograms@mbcrm/pictograms-react
🙌 Contributing
We're always looking for contributors to help us fix bugs, build new features, or help us improve the project documentation. If you're interested, definitely check out our Contributing Guide! 👀
📝 License
Licensed under the Apache 2.0 License.
