Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce a script to generate a list of icons and a manifest that can be exported to the Figma board #270

Closed
Tracked by #21415
brionmario opened this issue Oct 8, 2024 · 0 comments · Fixed by #271
Labels
automation Scripting to automate manual tedious. hacktoberfest Issues dedicated for the annual annual Hacktoberfest open source festival. package:primitives Issues/PRs related to the `@oxygen-ui/primitives` package.

Comments

@brionmario
Copy link
Member

brionmario commented Oct 8, 2024

Is your suggestion related to an experience ? Please describe.

In Figma, we currently have to manually add icons one by one to the board, which is inefficient. The inconsistency in naming conventions, due to contributions from multiple people, adds to the complexity and leads to issues when collaborating on the design system. This results in extra manual work to rename and organize icons.

Figma board: Assets Board

Describe the improvement

Introduce a script to automate the process:

  • Reads all SVG files from the packages/primitives/src/icons directory.
  • Renames them using a consistent <ICON_NAME>Icon.svg format (Output naming convention of @oxygen-ui/react-icons.)
  • Exports the renamed icons to a figma/.export/icons folder under figma.
  • Generates an icon-manifest.txt file that lists all the icons for easy reference and consistency.

This automation will streamline the process of managing icons for the Figma board and ensure uniformity in naming across the team, reducing manual effort.

Additional context

N/A

@brionmario brionmario added hacktoberfest Issues dedicated for the annual annual Hacktoberfest open source festival. package:primitives Issues/PRs related to the `@oxygen-ui/primitives` package. automation Scripting to automate manual tedious. labels Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation Scripting to automate manual tedious. hacktoberfest Issues dedicated for the annual annual Hacktoberfest open source festival. package:primitives Issues/PRs related to the `@oxygen-ui/primitives` package.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant