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

.changeset/ninety-wolves-fix.md

@@ -0,0 +1,22 @@
+---
+"@bigcommerce/catalyst-core": minor
+---
+
+Rename `/vibes/soul/` to `/ui/`, replacing all imports and configuration rules to match new pathname.
+
+## 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.

core/app/[locale]/(default)/(auth)/change-password/_actions/change-password.ts

@@ -5,7 +5,7 @@ import { SubmissionResult } from '@conform-to/react';
 import { parseWithZod } from '@conform-to/zod';
 import { getTranslations } from 'next-intl/server';
 
-import { schema } from '@/vibes/soul/sections/reset-password-section/schema';
+import { schema } from '@/ui/sections/reset-password-section/schema';
 import { client } from '~/client';
 import { graphql } from '~/client/graphql';
 

core/app/[locale]/(default)/(auth)/change-password/page.tsx

@@ -2,7 +2,7 @@
 import { Metadata } from 'next';
 import { getTranslations, setRequestLocale } from 'next-intl/server';
 
-import { ResetPasswordSection } from '@/vibes/soul/sections/reset-password-section';
+import { ResetPasswordSection } from '@/ui/sections/reset-password-section';
 import { redirect } from '~/i18n/routing';
 
 import { changePassword } from './_actions/change-password';

core/app/[locale]/(default)/(auth)/login/_actions/login.ts

@@ -6,7 +6,7 @@ import { parseWithZod } from '@conform-to/zod';
 import { AuthError } from 'next-auth';
 import { getLocale, getTranslations } from 'next-intl/server';
 
-import { schema } from '@/vibes/soul/sections/sign-in-section/schema';
+import { schema } from '@/ui/sections/sign-in-section/schema';
 import { signIn } from '~/auth';
 import { redirect } from '~/i18n/routing';
 import { getCartId } from '~/lib/cart';

core/app/[locale]/(default)/(auth)/login/forgot-password/_actions/reset-password.ts

@@ -5,7 +5,7 @@ import { SubmissionResult } from '@conform-to/react';
 import { parseWithZod } from '@conform-to/zod';
 import { getTranslations } from 'next-intl/server';
 
-import { schema } from '@/vibes/soul/sections/forgot-password-section/schema';
+import { schema } from '@/ui/sections/forgot-password-section/schema';
 import { client } from '~/client';
 import { graphql } from '~/client/graphql';
 

core/app/[locale]/(default)/(auth)/login/forgot-password/page.tsx

@@ -6,7 +6,7 @@ import { getTranslations, setRequestLocale } from 'next-intl/server';
 // import { revalidate } from '~/client/revalidate-target';
 // import { bypassReCaptcha } from '~/lib/bypass-recaptcha';
 
-import { ForgotPasswordSection } from '@/vibes/soul/sections/forgot-password-section';
+import { ForgotPasswordSection } from '@/ui/sections/forgot-password-section';
 
 import { resetPassword } from './_actions/reset-password';
 

core/app/[locale]/(default)/(auth)/login/page.tsx

@@ -2,8 +2,8 @@
 import { Metadata } from 'next';
 import { getTranslations, setRequestLocale } from 'next-intl/server';
 
-import { ButtonLink } from '@/vibes/soul/primitives/button-link';
-import { SignInSection } from '@/vibes/soul/sections/sign-in-section';
+import { ButtonLink } from '@/ui/primitives/button-link';
+import { SignInSection } from '@/ui/sections/sign-in-section';
 import { buildConfig } from '~/build-config/reader';
 import { ForceRefresh } from '~/components/force-refresh';
 

core/app/[locale]/(default)/(auth)/register/_actions/register-customer.ts

@@ -6,7 +6,7 @@ import { parseWithZod } from '@conform-to/zod';
 import { getLocale, getTranslations } from 'next-intl/server';
 import { z } from 'zod';
 
-import { Field, FieldGroup, schema } from '@/vibes/soul/form/dynamic-form/schema';
+import { Field, FieldGroup, schema } from '@/ui/form/dynamic-form/schema';
 import { signIn } from '~/auth';
 import { client } from '~/client';
 import { graphql, VariablesOf } from '~/client/graphql';

core/app/[locale]/(default)/(auth)/register/page.tsx

@@ -5,7 +5,7 @@ import { getTranslations, setRequestLocale } from 'next-intl/server';
 // TODO: Add recaptcha token
 // import { bypassReCaptcha } from '~/lib/bypass-recaptcha';
 
-import { DynamicFormSection } from '@/vibes/soul/sections/dynamic-form-section';
+import { DynamicFormSection } from '@/ui/sections/dynamic-form-section';
 import { formFieldTransformer } from '~/data-transformers/form-field-transformer';
 import {
   CUSTOMER_FIELDS_TO_EXCLUDE,

core/app/[locale]/(default)/(faceted)/brand/[slug]/page.tsx

@@ -4,14 +4,14 @@ import { getFormatter, getTranslations, setRequestLocale } from 'next-intl/serve
 import { createSearchParamsCache } from 'nuqs/server';
 import { cache } from 'react';
 
-import { Streamable } from '@/vibes/soul/lib/streamable';
-import { createCompareLoader } from '@/vibes/soul/primitives/compare-drawer/loader';
-import { CursorPaginationInfo } from '@/vibes/soul/primitives/cursor-pagination';
-import { Product } from '@/vibes/soul/primitives/product-card';
-import { ProductsListSection } from '@/vibes/soul/sections/products-list-section';
-import { getFilterParsers } from '@/vibes/soul/sections/products-list-section/filter-parsers';
-import { Filter } from '@/vibes/soul/sections/products-list-section/filters-panel';
-import { Option as SortOption } from '@/vibes/soul/sections/products-list-section/sorting';
+import { Streamable } from '@/ui/lib/streamable';
+import { createCompareLoader } from '@/ui/primitives/compare-drawer/loader';
+import { CursorPaginationInfo } from '@/ui/primitives/cursor-pagination';
+import { Product } from '@/ui/primitives/product-card';
+import { ProductsListSection } from '@/ui/sections/products-list-section';
+import { getFilterParsers } from '@/ui/sections/products-list-section/filter-parsers';
+import { Filter } from '@/ui/sections/products-list-section/filters-panel';
+import { Option as SortOption } from '@/ui/sections/products-list-section/sorting';
 import { facetsTransformer } from '~/data-transformers/facets-transformer';
 import { pageInfoTransformer } from '~/data-transformers/page-info-transformer';
 import { pricesTransformer } from '~/data-transformers/prices-transformer';

core/app/[locale]/(default)/(faceted)/category/[slug]/page.tsx

@@ -5,15 +5,15 @@ import { getFormatter, getTranslations, setRequestLocale } from 'next-intl/serve
 import { createSearchParamsCache } from 'nuqs/server';
 import { cache } from 'react';
 
-import { Stream, Streamable } from '@/vibes/soul/lib/streamable';
-import { createCompareLoader } from '@/vibes/soul/primitives/compare-drawer/loader';
-import { CursorPaginationInfo } from '@/vibes/soul/primitives/cursor-pagination';
-import { Product } from '@/vibes/soul/primitives/product-card';
-import { Breadcrumb } from '@/vibes/soul/sections/breadcrumbs';
-import { ProductsListSection } from '@/vibes/soul/sections/products-list-section';
-import { getFilterParsers } from '@/vibes/soul/sections/products-list-section/filter-parsers';
-import { Filter } from '@/vibes/soul/sections/products-list-section/filters-panel';
-import { Option as SortOption } from '@/vibes/soul/sections/products-list-section/sorting';
+import { Stream, Streamable } from '@/ui/lib/streamable';
+import { createCompareLoader } from '@/ui/primitives/compare-drawer/loader';
+import { CursorPaginationInfo } from '@/ui/primitives/cursor-pagination';
+import { Product } from '@/ui/primitives/product-card';
+import { Breadcrumb } from '@/ui/sections/breadcrumbs';
+import { ProductsListSection } from '@/ui/sections/products-list-section';
+import { getFilterParsers } from '@/ui/sections/products-list-section/filter-parsers';
+import { Filter } from '@/ui/sections/products-list-section/filters-panel';
+import { Option as SortOption } from '@/ui/sections/products-list-section/sorting';
 import { facetsTransformer } from '~/data-transformers/facets-transformer';
 import { pageInfoTransformer } from '~/data-transformers/page-info-transformer';
 import { pricesTransformer } from '~/data-transformers/prices-transformer';

core/app/[locale]/(default)/(faceted)/search/page.tsx

@@ -3,15 +3,15 @@ import { getFormatter, getTranslations, setRequestLocale } from 'next-intl/serve
 import { createSearchParamsCache } from 'nuqs/server';
 import { cache } from 'react';
 
-import { Streamable } from '@/vibes/soul/lib/streamable';
-import { createCompareLoader } from '@/vibes/soul/primitives/compare-drawer/loader';
-import { CursorPaginationInfo } from '@/vibes/soul/primitives/cursor-pagination';
-import { Product } from '@/vibes/soul/primitives/product-card';
-import { Breadcrumb } from '@/vibes/soul/sections/breadcrumbs';
-import { ProductsListSection } from '@/vibes/soul/sections/products-list-section';
-import { getFilterParsers } from '@/vibes/soul/sections/products-list-section/filter-parsers';
-import { Filter } from '@/vibes/soul/sections/products-list-section/filters-panel';
-import { Option as SortOption } from '@/vibes/soul/sections/products-list-section/sorting';
+import { Streamable } from '@/ui/lib/streamable';
+import { createCompareLoader } from '@/ui/primitives/compare-drawer/loader';
+import { CursorPaginationInfo } from '@/ui/primitives/cursor-pagination';
+import { Product } from '@/ui/primitives/product-card';
+import { Breadcrumb } from '@/ui/sections/breadcrumbs';
+import { ProductsListSection } from '@/ui/sections/products-list-section';
+import { getFilterParsers } from '@/ui/sections/products-list-section/filter-parsers';
+import { Filter } from '@/ui/sections/products-list-section/filters-panel';
+import { Option as SortOption } from '@/ui/sections/products-list-section/sorting';
 import { facetsTransformer } from '~/data-transformers/facets-transformer';
 import { pricesTransformer } from '~/data-transformers/prices-transformer';
 

core/app/[locale]/(default)/_components/slideshow/index.tsx

@@ -1,6 +1,6 @@
 import { useTranslations } from 'next-intl';
 
-import { Slideshow as SlideshowSection } from '~/vibes/soul/sections/slideshow';
+import { Slideshow as SlideshowSection } from '@/ui/sections/slideshow';
 
 import SlideBg01 from './slide-bg-01.jpg';
 import SlideBg02 from './slide-bg-02.jpg';

core/app/[locale]/(default)/account/addresses/_actions/address-action.ts

@@ -1,7 +1,7 @@
 import { SubmissionResult } from '@conform-to/react';
 
-import { Field, FieldGroup } from '@/vibes/soul/form/dynamic-form/schema';
-import { Address, DefaultAddressConfiguration } from '@/vibes/soul/sections/address-list-section';
+import { Field, FieldGroup } from '@/ui/form/dynamic-form/schema';
+import { Address, DefaultAddressConfiguration } from '@/ui/sections/address-list-section';
 
 import { createAddress } from './create-address';
 import { deleteAddress } from './delete-address';

core/app/[locale]/(default)/account/addresses/_actions/create-address.ts

@@ -4,8 +4,8 @@ import { unstable_expireTag as expireTag } from 'next/cache';
 import { getTranslations } from 'next-intl/server';
 import { z } from 'zod';
 
-import { Field, FieldGroup } from '@/vibes/soul/form/dynamic-form/schema';
-import { schema } from '@/vibes/soul/sections/address-list-section/schema';
+import { Field, FieldGroup } from '@/ui/form/dynamic-form/schema';
+import { schema } from '@/ui/sections/address-list-section/schema';
 import { getSessionCustomerAccessToken } from '~/auth';
 import { client } from '~/client';
 import { graphql, VariablesOf } from '~/client/graphql';

core/app/[locale]/(default)/account/addresses/_actions/delete-address.ts

@@ -4,7 +4,7 @@ import { unstable_expireTag as expireTag } from 'next/cache';
 import { getTranslations } from 'next-intl/server';
 import { z } from 'zod';
 
-import { schema } from '@/vibes/soul/sections/address-list-section/schema';
+import { schema } from '@/ui/sections/address-list-section/schema';
 import { getSessionCustomerAccessToken } from '~/auth';
 import { client } from '~/client';
 import { graphql, VariablesOf } from '~/client/graphql';

core/app/[locale]/(default)/account/addresses/_actions/update-address.ts

@@ -4,8 +4,8 @@ import { unstable_expireTag as expireTag } from 'next/cache';
 import { getTranslations } from 'next-intl/server';
 import { z } from 'zod';
 
-import { Field, FieldGroup } from '@/vibes/soul/form/dynamic-form/schema';
-import { schema } from '@/vibes/soul/sections/address-list-section/schema';
+import { Field, FieldGroup } from '@/ui/form/dynamic-form/schema';
+import { schema } from '@/ui/sections/address-list-section/schema';
 import { getSessionCustomerAccessToken } from '~/auth';
 import { client } from '~/client';
 import { graphql, VariablesOf } from '~/client/graphql';

core/app/[locale]/(default)/account/addresses/page.tsx

@@ -2,7 +2,7 @@ import { Metadata } from 'next';
 import { notFound } from 'next/navigation';
 import { getTranslations, setRequestLocale } from 'next-intl/server';
 
-import { Address, AddressListSection } from '@/vibes/soul/sections/address-list-section';
+import { Address, AddressListSection } from '@/ui/sections/address-list-section';
 import {
   fieldToFieldNameTransformer,
   formFieldTransformer,

core/app/[locale]/(default)/account/layout.tsx

@@ -1,8 +1,8 @@
 import { getTranslations, setRequestLocale } from 'next-intl/server';
 import { PropsWithChildren } from 'react';
 
-import { SidebarMenu } from '@/vibes/soul/sections/sidebar-menu';
-import { StickySidebarLayout } from '@/vibes/soul/sections/sticky-sidebar-layout';
+import { SidebarMenu } from '@/ui/sections/sidebar-menu';
+import { StickySidebarLayout } from '@/ui/sections/sticky-sidebar-layout';
 import { isLoggedIn } from '~/auth';
 import { redirect } from '~/i18n/routing';
 

core/app/[locale]/(default)/account/orders/[id]/page.tsx

@@ -1,7 +1,7 @@
 import { notFound } from 'next/navigation';
 import { getFormatter, getTranslations, setRequestLocale } from 'next-intl/server';
 
-import { OrderDetailsSection } from '@/vibes/soul/sections/order-details-section';
+import { OrderDetailsSection } from '@/ui/sections/order-details-section';
 import { orderDetailsTransformer } from '~/data-transformers/order-details-transformer';
 
 import { getCustomerOrderDetails } from './page-data';

core/app/[locale]/(default)/account/orders/page.tsx

@@ -1,9 +1,9 @@
 import { notFound } from 'next/navigation';
 import { getFormatter, getTranslations, setRequestLocale } from 'next-intl/server';
 
+import { OrderListSection } from '@/ui/sections/order-list-section';
 import { ordersTransformer } from '~/data-transformers/orders-transformer';
 import { pageInfoTransformer } from '~/data-transformers/page-info-transformer';
-import { OrderListSection } from '~/vibes/soul/sections/order-list-section';
 
 import { getCustomerOrders } from './page-data';
 

core/app/[locale]/(default)/account/settings/_actions/change-password.ts

@@ -4,8 +4,8 @@ import { BigCommerceGQLError } from '@bigcommerce/catalyst-client';
 import { parseWithZod } from '@conform-to/zod';
 import { getTranslations } from 'next-intl/server';
 
-import { ChangePasswordAction } from '@/vibes/soul/sections/account-settings-section/change-password-form';
-import { changePasswordSchema } from '@/vibes/soul/sections/account-settings-section/schema';
+import { ChangePasswordAction } from '@/ui/sections/account-settings-section/change-password-form';
+import { changePasswordSchema } from '@/ui/sections/account-settings-section/schema';
 import { getSessionCustomerAccessToken } from '~/auth';
 import { client } from '~/client';
 import { graphql } from '~/client/graphql';

core/app/[locale]/(default)/account/settings/_actions/update-customer.ts

@@ -5,8 +5,8 @@ import { parseWithZod } from '@conform-to/zod';
 import { unstable_expireTag } from 'next/cache';
 import { getTranslations } from 'next-intl/server';
 
-import { updateAccountSchema } from '@/vibes/soul/sections/account-settings-section/schema';
-import { UpdateAccountAction } from '@/vibes/soul/sections/account-settings-section/update-account-form';
+import { updateAccountSchema } from '@/ui/sections/account-settings-section/schema';
+import { UpdateAccountAction } from '@/ui/sections/account-settings-section/update-account-form';
 import { getSessionCustomerAccessToken } from '~/auth';
 import { client } from '~/client';
 import { graphql } from '~/client/graphql';

core/app/[locale]/(default)/account/settings/page.tsx

@@ -2,7 +2,7 @@ import { Metadata } from 'next';
 import { notFound } from 'next/navigation';
 import { getTranslations, setRequestLocale } from 'next-intl/server';
 
-import { AccountSettingsSection } from '@/vibes/soul/sections/account-settings-section';
+import { AccountSettingsSection } from '@/ui/sections/account-settings-section';
 
 import { changePassword } from './_actions/change-password';
 import { updateCustomer } from './_actions/update-customer';

core/app/[locale]/(default)/account/wishlists/[id]/_components/share-button.tsx

@@ -3,11 +3,11 @@
 import { clsx } from 'clsx';
 import { useState } from 'react';
 
-import { Stream, Streamable } from '@/vibes/soul/lib/streamable';
-import { Button, ButtonProps } from '@/vibes/soul/primitives/button';
-import * as Skeleton from '@/vibes/soul/primitives/skeleton';
-import { toast } from '@/vibes/soul/primitives/toaster';
-import { Tooltip } from '@/vibes/soul/primitives/tooltip';
+import { Stream, Streamable } from '@/ui/lib/streamable';
+import { Button, ButtonProps } from '@/ui/primitives/button';
+import * as Skeleton from '@/ui/primitives/skeleton';
+import { toast } from '@/ui/primitives/toaster';
+import { Tooltip } from '@/ui/primitives/tooltip';
 import { Modal } from '~/components/modal';
 
 import { ShareWishlistModal } from '../../_components/modals/share';

core/app/[locale]/(default)/account/wishlists/[id]/_components/visibility-switch.tsx

@@ -2,9 +2,9 @@
 
 import { useActionState, useEffect, useTransition } from 'react';
 
-import { Switch } from '@/vibes/soul/form/switch';
-import { toast } from '@/vibes/soul/primitives/toaster';
-import { Wishlist } from '@/vibes/soul/sections/wishlist-details';
+import { Switch } from '@/ui/form/switch';
+import { toast } from '@/ui/primitives/toaster';
+import { Wishlist } from '@/ui/sections/wishlist-details';
 
 import { toggleWishlistVisibility } from '../../_actions/change-wishlist-visibility';
 

core/app/[locale]/(default)/account/wishlists/[id]/_components/wishlist-actions.tsx

@@ -1,7 +1,7 @@
-import { SwitchSkeleton } from '@/vibes/soul/form/switch';
-import { Streamable } from '@/vibes/soul/lib/streamable';
-import * as Skeleton from '@/vibes/soul/primitives/skeleton';
-import { Wishlist } from '@/vibes/soul/sections/wishlist-details';
+import { SwitchSkeleton } from '@/ui/form/switch';
+import { Streamable } from '@/ui/lib/streamable';
+import * as Skeleton from '@/ui/primitives/skeleton';
+import { Wishlist } from '@/ui/sections/wishlist-details';
 
 import { WishlistAction, WishlistActionsMenu } from '../../_components/wishlist-actions-menu';
 

core/app/[locale]/(default)/account/wishlists/[id]/page.tsx

@@ -3,9 +3,9 @@ import { getFormatter, getTranslations, setRequestLocale } from 'next-intl/serve
 import { SearchParams } from 'nuqs';
 import { createSearchParamsCache, parseAsInteger, parseAsString } from 'nuqs/server';
 
-import { Streamable } from '@/vibes/soul/lib/streamable';
-import { CursorPaginationInfo } from '@/vibes/soul/primitives/cursor-pagination';
-import { Wishlist, WishlistDetails } from '@/vibes/soul/sections/wishlist-details';
+import { Streamable } from '@/ui/lib/streamable';
+import { CursorPaginationInfo } from '@/ui/primitives/cursor-pagination';
+import { Wishlist, WishlistDetails } from '@/ui/sections/wishlist-details';
 import { ExistingResultType } from '~/client/util';
 import { defaultPageInfo, pageInfoTransformer } from '~/data-transformers/page-info-transformer';
 import { wishlistDetailsTransformer } from '~/data-transformers/wishlists-transformer';

core/app/[locale]/(default)/account/wishlists/_components/modals/change-visibility.tsx

@@ -1,7 +1,7 @@
 'use client';
 
-import { FormStatus } from '@/vibes/soul/form/form-status';
-import { Wishlist } from '@/vibes/soul/sections/wishlist-details';
+import { FormStatus } from '@/ui/form/form-status';
+import { Wishlist } from '@/ui/sections/wishlist-details';
 import { useModalForm } from '~/components/modal/modal-form-provider';
 
 import { toggleWishlistVisibilitySchema } from '../../_actions/schema';

core/app/[locale]/(default)/account/wishlists/_components/modals/delete.tsx

@@ -1,7 +1,7 @@
 'use client';
 
-import { FormStatus } from '@/vibes/soul/form/form-status';
-import { Wishlist } from '@/vibes/soul/sections/wishlist-details';
+import { FormStatus } from '@/ui/form/form-status';
+import { Wishlist } from '@/ui/sections/wishlist-details';
 import { useModalForm } from '~/components/modal/modal-form-provider';
 
 import { deleteWishlistSchema } from '../../_actions/schema';

core/app/[locale]/(default)/account/wishlists/_components/modals/new.tsx

@@ -3,8 +3,8 @@
 import { getInputProps } from '@conform-to/react';
 import { useRef } from 'react';
 
-import { FormStatus } from '@/vibes/soul/form/form-status';
-import { Input } from '@/vibes/soul/form/input';
+import { FormStatus } from '@/ui/form/form-status';
+import { Input } from '@/ui/form/input';
 import { useModalForm } from '~/components/modal/modal-form-provider';
 
 import { newWishlistSchema } from '../../_actions/schema';

core/app/[locale]/(default)/account/wishlists/_components/modals/rename.tsx

@@ -3,9 +3,9 @@
 import { getInputProps } from '@conform-to/react';
 import { useRef } from 'react';
 
-import { FormStatus } from '@/vibes/soul/form/form-status';
-import { Input } from '@/vibes/soul/form/input';
-import { Wishlist } from '@/vibes/soul/sections/wishlist-details';
+import { FormStatus } from '@/ui/form/form-status';
+import { Input } from '@/ui/form/input';
+import { Wishlist } from '@/ui/sections/wishlist-details';
 import { useModalForm } from '~/components/modal/modal-form-provider';
 
 import { renameWishlistSchema } from '../../_actions/schema';