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

refactor: migrate to style dictionary v4 #10248

Closed

Conversation

AkshitGarg24
Copy link

Proposed Changes

This PR introduces a codemod that automates the migration to Style Dictionary 4 by transforming configuration files, formats, and other breaking changes from previous versions, as described in the Style Dictionary v4 migration guide.

You can test/run the codemod using:

npx codemod styledictionary/4/migration-recipe

This allows users of earlier versions of Style Dictionary to easily automate the migration to version 4 with a single command. By leveraging the Codemod CLI, users can take advantage of a seamless migration experience similar to that offered by other popular frameworks like React, Nuxt.js, and pnpm.

This codemod is a step towards simplifying the Style Dictionary v4 upgrade process. If this PR is well-received, our community is eager to contribute more codemods to further automate and streamline the migration path for Style Dictionary users.

Copy link
Member

@jcfranco jcfranco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution, @AkshitGarg24!

Before reviewing and testing, would you mind scoping the codemod changes to the calcite-design-tokens package and updating the PR title to follow our conventions? LMK if you have any questions.

@AkshitGarg24 AkshitGarg24 changed the title Migrate to Style Dictionary v4 feat : migrate to style dictionary v4 Sep 9, 2024
@AkshitGarg24
Copy link
Author

Hello @jcfranco,

I have made the required changes. Please let me know if there are any additional modifications needed or if I missed anything.

@AkshitGarg24 AkshitGarg24 changed the title feat : migrate to style dictionary v4 feat(codemod) : migrate to style dictionary v4 Sep 9, 2024
@AkshitGarg24 AkshitGarg24 changed the title feat(codemod) : migrate to style dictionary v4 feat : migrate to style dictionary v4 Sep 10, 2024
@jcfranco
Copy link
Member

Thanks for updating the PR! This is getting close!

The PR title needs a small adjustment to align with the expected syntax (there shouldn’t be a space between the type, e.g., feat, and the colon). Also, since this isn’t adding a new feature, it would be better to use refactor as the type.

Since this involves migrating to v4, could you also update the style-dictionary dependency in the root package.json to the latest or recommended version?

@AkshitGarg24 AkshitGarg24 changed the title feat : migrate to style dictionary v4 refactor: migrate to style dictionary v4 Sep 10, 2024
@AkshitGarg24
Copy link
Author

Hello @jcfranco,

I have made the required changes. Please let me know if there are any additional modifications needed or if I missed anything.

@jcfranco
Copy link
Member

@AkshitGarg24 Were you been able to get a successful build locally? I haven't had luck and suspect we'll need additional changes to our package before migrating.

Copy link
Contributor

This PR has been automatically marked as stale because it has not had recent activity. Please close your PR if it is no longer relevant. Thank you for your contributions.

@github-actions github-actions bot added the Stale Issues or pull requests that have not had recent activity. label Sep 18, 2024
@jcfranco
Copy link
Member

jcfranco commented Nov 5, 2024

@AkshitGarg24 Thanks again for the PR! Since some items are still pending and there haven’t been any recent updates, I’ll close it for now. We can revisit migrating at a later point.

@jcfranco jcfranco closed this Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Stale Issues or pull requests that have not had recent activity.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants