Skip to content

chore: rename /vibes/soul/ to /ui/ #2247

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

Open
wants to merge 2 commits into
base: canary
Choose a base branch
from
Open

Conversation

jorgemoya
Copy link
Contributor

@jorgemoya jorgemoya commented Apr 18, 2025

What/Why?

Rename /vibes/soul/ to /ui/, replacing all imports and configuration rules to match new pathname.

Testing

No eslint errors.

Migration instructions

Rebase conflicts

  • Custom components in /vibes/soul/* need to be moved to /ui/.
  • Change import name from @/vibes/soul/ to @/ui/.
  • If import order errors occur, run pnpm run lint -- --fix to fix import order or fix manually.

Manual migration

  • Replace /vibes/soul/ for /ui/.
  • Rename all imports from @/vibes/soul/ to @/ui/.
  • Update tsconfig.json to point to the @/ui path.
  • Update next.config.ts to replaces vibes with ui in the included eslint dirs.
  • Update global.css to replace ./vibes with ./ui.
  • Run pnpm run lint -- --fix to auto fix import order.

@jorgemoya jorgemoya requested a review from a team as a code owner April 18, 2025 15:03
Copy link

changeset-bot bot commented Apr 18, 2025

🦋 Changeset detected

Latest commit: a157ba4

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

This PR includes changesets to release 1 package
Name Type
@bigcommerce/catalyst-core 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

Copy link

vercel bot commented Apr 18, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
catalyst-canary ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 18, 2025 5:10pm
4 Skipped Deployments
Name Status Preview Comments Updated (UTC)
catalyst ⬜️ Ignored (Inspect) Apr 18, 2025 5:10pm
catalyst-au ⬜️ Ignored (Inspect) Visit Preview Apr 18, 2025 5:10pm
catalyst-soul ⬜️ Ignored (Inspect) Visit Preview Apr 18, 2025 5:10pm
catalyst-uk ⬜️ Ignored (Inspect) Visit Preview Apr 18, 2025 5:10pm

@bookernath
Copy link
Contributor

Thanks for the migration steps!

Copy link
Contributor

⚡️🏠 Lighthouse report

Lighthouse ran against https://catalyst-canary-hzajnbm2p-bigcommerce-platform.vercel.app

🖥️ Desktop

We ran Lighthouse against the changes on a desktop and produced this report. Here's the summary:

Category Score
🟢 Performance 99
🟢 Accessibility 92
🟠 Best practices 78
🟠 SEO 82

📱 Mobile

We ran Lighthouse against the changes on a mobile and produced this report. Here's the summary:

Category Score
🟠 Performance 83
🟢 Accessibility 92
🟠 Best practices 78
🟠 SEO 85

@jorgemoya jorgemoya changed the title chore: rename /vibes/soul/ to /ui/ chore: rename /vibes/soul/ to /ui/ Apr 18, 2025
@jorgemoya jorgemoya changed the title chore: rename /vibes/soul/ to /ui/ chore: rename /vibes/soul/ to /ui/ Apr 18, 2025
Copy link
Collaborator

@migueloller migueloller left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks for providing instructions. I still find some specifics missing, like how users actually get updates (is it via git pull upstream @bigcommerce/catalyst-core@rc.12?) and what steps they could take to minimize conflicts.

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

Successfully merging this pull request may close these issues.

3 participants