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

Featured Badge Names Type #97

Merged
merged 3 commits into from
Nov 15, 2024
Merged

Conversation

bryantkelley
Copy link
Member

@bryantkelley bryantkelley commented Nov 15, 2024

Description

Removes the featuredBadgeNames string array and replaces it with a Type for narrowing and improved tree-shaking.

Fixes # (issue)

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

How Has This Been Tested?

I linked these changes to victory with pnpm and do not see unused SVGs when building the victory docs site.

Checklist: (Feel free to delete this section upon completion)

  • I have included a changeset if this change will require a version change to one of the packages.
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have run all builds, tests, and linting and all checks pass
  • I have added tests that prove my fix is effective or that my feature works
  • My changes generate no new warnings
  • Any dependent changes have been merged and published in downstream modules

@bryantkelley bryantkelley self-assigned this Nov 15, 2024
Copy link

changeset-bot bot commented Nov 15, 2024

🦋 Changeset detected

Latest commit: 4013520

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
formidable-oss-badges Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@bryantkelley bryantkelley merged commit 52ce32a into master Nov 15, 2024
1 check passed
@bryantkelley bryantkelley deleted the task/featured-badge-names-type branch November 15, 2024 22:51
@github-actions github-actions bot mentioned this pull request Nov 15, 2024
@JDMathew
Copy link
Contributor

JDMathew commented Dec 23, 2024

I'm bumping into this change when updating React Native AMA's docs. While this change does improve tree-shaking it might be useful to have a definite list of featured projects (featuredLogoNames) that is exported from formidable-oss-badges while still maintaining the tree-shaking this change implements. I'm happy to put a PR together for this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants