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

chore(generator): migrate to tools folder #3501

Merged
merged 1 commit into from
Jan 16, 2025

Conversation

castastrophe
Copy link
Collaborator

@castastrophe castastrophe commented Jan 15, 2025

Description

As the generator is a utility or "tool" for the project, this package would be better served under the tools directory. This PR moves the generator package into the tools folder and updates the necessary scripts and pathing to support the change.

Bonus: the generator works again!

How and where has this been tested?

Please tag yourself on the tests you've marked complete to confirm the tests have been run by someone other than the author.

Validation steps

  • yarn new: choose component and answer the prompts - expect it to make a new component! (@cdransf)

To-do list

  • I have read the contribution guidelines.
  • If my change impacts documentation, I have updated the documentation accordingly.
  • ✨ This pull request is ready to merge. ✨

@castastrophe castastrophe added size-1 XS ~1-6hrs; nearly trivial, a few hours, could do more than one in a single day. build Issues associated with the build process; often a refactor skip_vrt Add to a PR to skip running VRT (but still pass the action) ready-for-review s1 labels Jan 15, 2025
@castastrophe castastrophe self-assigned this Jan 15, 2025
Copy link

changeset-bot bot commented Jan 15, 2025

⚠️ No Changeset found

Latest commit: fdd5ead

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

Copy link
Contributor

github-actions bot commented Jan 15, 2025

🚀 Deployed on https://pr-3501--spectrum-css.netlify.app

Copy link
Contributor

github-actions bot commented Jan 15, 2025

File metrics

Summary

Total size: 3.89 MB*

🎉 No changes detected in any packages

* Size determined by adding together the size of the main file for all packages in the library.
* Results are not gzipped or minified.
* An ASCII character in UTF-8 is 8 bits or 1 byte.

@castastrophe castastrophe requested a review from 5t3ph January 16, 2025 17:42
@5t3ph
Copy link
Collaborator

5t3ph commented Jan 16, 2025

Not sure if you want to address now or future but when I ran the generator it had a few hiccups:

  • the metadata file was not created, breaking the stories - maybe a blank stub is needed, or comment out/remove the import?
  • for the MDX file, missing import for Stories
  • for the template, missing defining is... props

@castastrophe castastrophe mentioned this pull request Jan 16, 2025
@castastrophe
Copy link
Collaborator Author

Not sure if you want to address now or future but when I ran the generator it had a few hiccups:

  • the metadata file was not created, breaking the stories - maybe a blank stub is needed, or comment out/remove the import?
  • for the MDX file, missing import for Stories
  • for the template, missing defining is... props

These are great points! I'll focus this PR on just moving the package but I opened a backlog issue to return & address the generation separately.

@cdransf cdransf self-requested a review January 16, 2025 21:25
Copy link
Member

@cdransf cdransf left a comment

Choose a reason for hiding this comment

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

Ran through the validation steps and works as expected. ✨

@castastrophe castastrophe force-pushed the chore-move-generator-tools branch from fdd5ead to 21310de Compare January 16, 2025 21:36
@castastrophe castastrophe enabled auto-merge (squash) January 16, 2025 21:37
@castastrophe castastrophe merged commit e5141e8 into main Jan 16, 2025
16 of 23 checks passed
@castastrophe castastrophe deleted the chore-move-generator-tools branch January 16, 2025 21:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Issues associated with the build process; often a refactor ready-for-review size-1 XS ~1-6hrs; nearly trivial, a few hours, could do more than one in a single day. skip_vrt Add to a PR to skip running VRT (but still pass the action)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants