feat: moving private components to ui-private #358
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughThe update introduces a new package Changes
TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: .coderabbit.yaml
Files selected for processing (77)
- .release-please-manifest.json (1 hunks)
- packages/ui-components/lib/buildIcons.js (1 hunks)
- packages/ui-components/package.json (1 hunks)
- packages/ui-components/src/common/tests/utilities.test.tsx (1 hunks)
- packages/ui-components/src/common/utilities.ts (2 hunks)
- packages/ui-components/src/components/Bubble/BubbleTypes.d.ts (1 hunks)
- packages/ui-components/src/components/Bubble/utilities.ts (1 hunks)
- packages/ui-components/src/components/Button/ButtonTypes.d.ts (1 hunks)
- packages/ui-components/src/components/Button/utilities.ts (1 hunks)
- packages/ui-components/src/components/Card/CardTypes.d.ts (1 hunks)
- packages/ui-components/src/components/Card/utilities.ts (1 hunks)
- packages/ui-components/src/components/Footer/Footer.tsx (1 hunks)
- packages/ui-components/src/components/Footer/FooterTypes.d.ts (1 hunks)
- packages/ui-components/src/components/Header/Header.tsx (1 hunks)
- packages/ui-components/src/components/Header/HeaderTypes.d.ts (1 hunks)
- packages/ui-components/src/components/Icons/IconBack.tsx (1 hunks)
- packages/ui-components/src/components/Icons/IconChart.tsx (1 hunks)
- packages/ui-components/src/components/Icons/IconClose.tsx (1 hunks)
- packages/ui-components/src/components/Icons/IconCopied.tsx (1 hunks)
- packages/ui-components/src/components/Icons/IconCopy.tsx (1 hunks)
- packages/ui-components/src/components/Icons/IconDelete.tsx (1 hunks)
- packages/ui-components/src/components/Icons/IconDog.tsx (1 hunks)
- packages/ui-components/src/components/Icons/IconEdit.tsx (1 hunks)
- packages/ui-components/src/components/Icons/IconGitHub.tsx (1 hunks)
- packages/ui-components/src/components/Icons/IconHide.tsx (1 hunks)
- packages/ui-components/src/components/Icons/IconHistory.tsx (1 hunks)
- packages/ui-components/src/components/Icons/IconInfo.tsx (1 hunks)
- packages/ui-components/src/components/Icons/IconNext.tsx (1 hunks)
- packages/ui-components/src/components/Icons/IconPrevious.tsx (1 hunks)
- packages/ui-components/src/components/Icons/IconProfile.tsx (1 hunks)
- packages/ui-components/src/components/Icons/IconRestore.tsx (1 hunks)
- packages/ui-components/src/components/Icons/IconSettings.tsx (1 hunks)
- packages/ui-components/src/components/Icons/IconShow.tsx (1 hunks)
- packages/ui-components/src/components/Icons/IconUser.tsx (1 hunks)
- packages/ui-components/src/components/Icons/IconsTypes.d.ts (1 hunks)
- packages/ui-components/src/components/Icons/tests/Icons.test.tsx (1 hunks)
- packages/ui-components/src/components/Main/Main.tsx (1 hunks)
- packages/ui-components/src/components/Main/MainTypes.d.ts (1 hunks)
- packages/ui-components/src/components/Menu/MenuTypes.d.ts (1 hunks)
- packages/ui-components/src/components/Panel/Panel.tsx (1 hunks)
- packages/ui-components/src/components/Spinner/Spinner.tsx (1 hunks)
- packages/ui-components/src/components/Spinner/SpinnerTypes.d.ts (1 hunks)
- packages/ui-components/src/components/Table/TableTypes.d.ts (1 hunks)
- packages/ui-components/src/components/Table/utilities.ts (1 hunks)
- packages/ui-components/src/components/TextArea/TextArea.tsx (1 hunks)
- packages/ui-components/src/components/TextArea/TextAreaTypes.d.ts (1 hunks)
- packages/ui-components/src/components/TextArea/utilities.ts (1 hunks)
- packages/ui-components/src/components/TextInput/TextInput.tsx (1 hunks)
- packages/ui-components/src/components/TextInput/TextInputMask.tsx (1 hunks)
- packages/ui-components/src/components/TextInput/TextInputTypes.d.ts (1 hunks)
- packages/ui-components/src/components/TextInput/utilities.ts (1 hunks)
- packages/ui-components/src/components/Toggle/ToggleTypes.d.ts (1 hunks)
- packages/ui-components/src/components/Toggle/utilities.ts (1 hunks)
- packages/ui-private/README.md (1 hunks)
- packages/ui-private/package.json (1 hunks)
- packages/ui-private/postcss.config.cjs (1 hunks)
- packages/ui-private/src/common/tests/helpers.ts (1 hunks)
- packages/ui-private/src/common/tests/utilities.test.tsx (1 hunks)
- packages/ui-private/src/common/index.d.ts (1 hunks)
- packages/ui-private/src/common/utilities.ts (1 hunks)
- packages/ui-private/src/components/Modal/Modal.tsx (1 hunks)
- packages/ui-private/src/components/SvgIcon/SvgIcon.tsx (1 hunks)
- packages/ui-private/src/components/SvgIcon/SvgIconTypes.d.ts (1 hunks)
- packages/ui-private/src/components/index.ts (1 hunks)
- packages/ui-private/src/index.css (1 hunks)
- packages/ui-private/src/style.ts (1 hunks)
- packages/ui-private/src/utilities.ts (1 hunks)
- packages/ui-private/src/vite-env.d.ts (1 hunks)
- packages/ui-private/tailwind.config.js (1 hunks)
- packages/ui-private/tsconfig.json (1 hunks)
- packages/ui-private/tsconfig.node.json (1 hunks)
- packages/ui-private/tsup.config.ts (1 hunks)
- packages/ui-private/vite.config.ts (1 hunks)
- packages/ui-private/vitest.config.ts (1 hunks)
- packages/ui-private/vitest.setup.ts (1 hunks)
- pnpm-lock.yaml (3 hunks)
- release-please-config.json (1 hunks)
Files skipped from review due to trivial changes (7)
- packages/ui-components/src/components/Icons/IconChart.tsx
- packages/ui-private/postcss.config.cjs
- packages/ui-private/src/components/index.ts
- packages/ui-private/src/index.css
- packages/ui-private/src/style.ts
- packages/ui-private/src/utilities.ts
- packages/ui-private/src/vite-env.d.ts
Additional comments: 43
release-please-config.json (1)
- 6-7: The addition of
"packages/ui-private"to the release-please configuration is correctly implemented, following the existing structure and syntax of the JSON file..release-please-manifest.json (1)
- 5-6: The addition of
"packages/ui-private": "0.0.0"to the release-please manifest is correctly implemented, with an appropriate initial version for the new package.packages/ui-private/tailwind.config.js (1)
- 3-7: The Tailwind configuration for the
ui-privatepackage is correctly set up, including the import of a custom Tailwind plugin and the appropriate configuration settings. This follows best practices for extending Tailwind configurations.packages/ui-private/tsconfig.node.json (1)
- 1-9: The TypeScript configuration for the
ui-privatepackage is correctly set up for a Node.js environment, including appropriate compiler options and file inclusions. This follows TypeScript configuration best practices for such environments.packages/ui-private/tsup.config.ts (1)
- 1-13: The
tsupconfiguration for theui-privatepackage is correctly set up, specifying the format, entry points, output directory, and TypeScript declaration settings. This follows best practices for bundling and building TypeScript projects.packages/ui-components/src/components/Icons/IconClose.tsx (1)
- 13-13: The import statement for
SvgIconhas been updated to use the@versini/ui-privatepackage. This change aligns with the PR's objectives to improve modularity by moving private components to a new package. Please ensure thatSvgIconis correctly exported from@versini/ui-privateand that this change does not introduce any build or runtime issues.packages/ui-components/src/components/Icons/IconCopy.tsx (1)
- 13-13: The update to the import statement for
SvgIconto use the@versini/ui-privatepackage is consistent with the project's restructuring efforts. Please verify thatSvgIconis correctly exported from@versini/ui-privateand that this change does not affect the build or runtime behavior adversely.packages/ui-components/src/components/Menu/MenuTypes.d.ts (1)
- 2-2: The update to the import path for
SpacingPropsto use the@versini/ui-privatepackage aligns with the project's goals to centralize utilities and types. Please ensure thatSpacingPropsis correctly exported from@versini/ui-privateand that this change does not introduce any type-related issues.packages/ui-components/src/components/Icons/IconNext.tsx (1)
- 13-13: The update to the import statement for
SvgIconto use the@versini/ui-privatepackage is consistent with the project's restructuring efforts. Please verify thatSvgIconis correctly exported from@versini/ui-privateand that this change does not affect the build or runtime behavior adversely.packages/ui-components/src/components/Icons/IconEdit.tsx (1)
- 13-13: The update to import
SvgIconfrom@versini/ui-privatealigns with the PR's objectives of improving modularity by moving private components to a separate package. Ensure that the version of@versini/ui-privateis compatible with the current project requirements and that all instances ofSvgIconimports across the project have been consistently updated.packages/ui-components/src/components/Table/TableTypes.d.ts (1)
- 1-1: The update to import
SpacingPropsfrom@versini/ui-privateis consistent with the PR's goal of centralizing utility types. Ensure that the structure ofSpacingPropsfrom@versini/ui-privatematches its expected usage withinTablePropsto avoid type mismatches.packages/ui-components/src/components/Icons/IconShow.tsx (1)
- 13-13: The update to import
SvgIconfrom@versini/ui-privatealigns with the PR's objectives of improving modularity by moving private components to a separate package. Ensure that the version of@versini/ui-privateis compatible with the current project requirements and that all instances ofSvgIconimports across the project have been consistently updated.packages/ui-components/src/components/Panel/Panel.tsx (1)
- 7-8: The reorganization of imports, including moving
useEffectanduseRefbelow other imports and changing the import source for Modal related components to@versini/ui-private, aligns with the PR's objectives. Ensure that the imported Modal components are compatible with their usage in the Panel component and that the reorganization of React hooks imports follows best practices for readability and consistency.packages/ui-components/src/components/Spinner/Spinner.tsx (1)
- 1-1: The update to import
getSpacingfrom@versini/ui-privateis consistent with the PR's goal of centralizing utility functions. Ensure that the functionality ofgetSpacingfrom@versini/ui-privatematches its expected usage within the Spinner component to avoid introducing errors.packages/ui-components/src/components/Bubble/utilities.ts (1)
- 1-2: The updates to import
SpacingPropsandgetSpacingfrom@versini/ui-privateare consistent with the PR's goal of centralizing utility types and functions. Ensure that the structure ofSpacingPropsand the functionality ofgetSpacingfrom@versini/ui-privatematch their expected usage within the Bubble component utilities to avoid type mismatches or errors.packages/ui-components/src/components/Icons/IconProfile.tsx (1)
- 13-13: The update to import
SvgIconfrom@versini/ui-privatealigns with the PR's objectives of improving modularity by moving private components to a separate package. Ensure that the version of@versini/ui-privateis compatible with the current project requirements and that all instances ofSvgIconimports across the project have been consistently updated.packages/ui-components/src/common/__tests__/utilities.test.tsx (1)
- 3-3: The removal of tests for the
getSpacingfunction aligns with its move to the@versini/ui-privatepackage. Ensure that corresponding tests are added to the@versini/ui-privatepackage to maintain test coverage forgetSpacing.packages/ui-components/src/components/TextArea/TextAreaTypes.d.ts (1)
- 1-1: The update to import
SpacingPropsfrom@versini/ui-privateis consistent with the PR's goal of centralizing utility types. Ensure that the structure ofSpacingPropsfrom@versini/ui-privatematches its expected usage withinTextAreaPropsto avoid type mismatches.packages/ui-private/package.json (1)
- 1-56: The
package.jsonconfiguration for the@versini/ui-privatepackage appears to be correctly set up with appropriate metadata, dependencies, and scripts. Ensure that dependencies are kept up-to-date and that the build and test scripts are thoroughly tested to prevent issues during development and deployment.packages/ui-components/src/common/utilities.ts (1)
- 1-1: The removal of
memoizeDeepandgetSpacingfunctions fromutilities.tsaligns with the PR's objectives of centralizing utility functions in the@versini/ui-privatepackage. Ensure that corresponding functions in@versini/ui-privateare correctly implemented and that all references to these removed functions across the project have been updated.packages/ui-components/src/components/Icons/IconHide.tsx (1)
- 13-13: The import statement for
SvgIconhas been correctly updated to reflect the new package structure. This change aligns with the PR objectives of reorganizing private UI components into theui-privatepackage.packages/ui-components/package.json (2)
- 42-44: The peer dependencies have been updated, which is a good practice to ensure compatibility with the consuming applications. However, ensure that these version updates are communicated clearly in the release notes to avoid any potential issues for consumers.
- 51-51: Adding
@versini/ui-privateas a dependency is a crucial step in integrating the new package structure. This change is well-aligned with the PR objectives. Ensure that the version specified matches the current or intended release version ofui-privateto avoid any versioning conflicts.packages/ui-components/src/components/Icons/IconDog.tsx (1)
- 1-1: The import statement for
SvgIconhas been correctly updated to use the new package path. This change is consistent with the restructuring objectives and ensures that the component correctly imports from theui-privatepackage.packages/ui-components/src/components/Toggle/utilities.ts (1)
- 1-2: The import statements for
SpacingPropsandgetSpacinghave been correctly updated to reflect their new location in theui-privatepackage. This change is in line with the PR objectives of centralizing utilities and improving code reusability. Ensure that the path@versini/ui-private/dist/utilitiescorrectly points to the exported entities.packages/ui-components/src/components/Icons/IconGitHub.tsx (1)
- 13-13: The import statement for
SvgIconhas been updated to import from@versini/ui-private, which is consistent with the PR's goal of centralizing private UI components. This change is correctly implemented.packages/ui-components/src/components/Button/ButtonTypes.d.ts (1)
- 1-1: The import path for
SpacingPropshas been updated to use the external package@versini/ui-private. This change correctly reflects the PR's objective of centralizing types and utilities. Ensure that the path accurately points to theSpacingPropstype definition.packages/ui-components/src/components/TextInput/TextInputTypes.d.ts (1)
- 1-1: The import statement for
SpacingPropshas been correctly updated to import from@versini/ui-private. This aligns with the PR's objectives of improving code modularity by centralizing utility types.packages/ui-private/src/common/utilities.ts (2)
- 41-42: The
memoizeDeepfunction is correctly implemented usingmicro-memoizeandfast-equalsfor deep comparison. This utility function is essential for optimizing performance in scenarios where functions are called with complex objects as arguments. Ensure that this utility is used judiciously to avoid unnecessary overhead in simpler cases.- 57-91: The
getSpacingutility function is well-implemented, providing a flexible way to handle spacing in components. It correctly handles different types of inputs (number, string, object) and memoizes the results to improve performance. This utility will be very useful for maintaining consistent spacing across the UI components.packages/ui-components/src/components/TextInput/TextInput.tsx (1)
- 1-1: The update to import
LiveRegionfrom@versini/ui-privatealigns with the PR's goal of modularizing the codebase. Ensure that all instances whereLiveRegionis used have been tested to confirm that the component functions as expected with the new import path.packages/ui-components/src/components/Table/utilities.ts (1)
- 1-2: The update to import paths for
SpacingPropsandgetSpacingfrom@versini/ui-privateis a positive step towards centralizing utilities. Verify that the usage of these imports across the project does not introduce any type or functionality issues.packages/ui-private/src/components/Modal/Modal.tsx (1)
- 7-7: The update to import
useUniqueIdfrom@versini/ui-hooksis consistent with the PR's goal of improving code organization. Ensure that the functionality ofuseUniqueIdremains unchanged and that the Modal component's accessibility features work as expected.packages/ui-components/lib/buildIcons.js (1)
- 41-41: The update to import
SvgIconfrom@versini/ui-privatesupports the PR's aim of centralizing components. Verify that the icon generation process functions correctly with this new import path, especially in terms of component compatibility and build process integrity.packages/ui-components/src/components/TextInput/utilities.ts (1)
- 1-2: The update to import paths for
SpacingPropsandgetSpacingfrom@versini/ui-privateis a positive step towards centralizing utilities. Verify that the usage of these imports across the project does not introduce any type or functionality issues.packages/ui-components/src/components/Button/utilities.ts (1)
- 1-2: The update to import paths for
SpacingPropsandgetSpacingfrom@versini/ui-privateis a positive step towards centralizing utilities. Verify that the usage of these imports across the project does not introduce any type or functionality issues.packages/ui-components/src/components/TextArea/utilities.ts (1)
- 1-2: The import statements for
SpacingPropsandgetSpacinghave been correctly updated to reflect their new location in the@versini/ui-privatepackage. This change supports the goal of improving modularity and maintainability by centralizing utility functions and types.However, ensure that the
@versini/ui-private/dist/utilitiesmodule correctly exports these entities to avoid import errors.packages/ui-components/src/components/TextInput/TextInputMask.tsx (1)
- 1-1: The import statement for
LiveRegionhas been correctly updated to reflect its new location in the@versini/ui-privatepackage. This change supports the goal of centralizing private UI components and utilities.However, ensure that the
@versini/ui-privatepackage correctly exportsLiveRegionto avoid import errors.packages/ui-components/src/components/Icons/__tests__/Icons.test.tsx (1)
- 2-2: The import statement for
SpacingPropshas been correctly updated to reflect its new location in the@versini/ui-privatepackage. This change supports the goal of centralizing types and utilities.However, ensure that the
@versini/ui-private/dist/utilitiesmodule correctly exportsSpacingPropsto avoid import errors.packages/ui-components/src/components/TextArea/TextArea.tsx (1)
- 1-1: The import statement for
LiveRegionhas been correctly updated to reflect its new location in the@versini/ui-privatepackage. This change supports the goal of centralizing private UI components and utilities.However, ensure that the
@versini/ui-privatepackage correctly exportsLiveRegionto avoid import errors.pnpm-lock.yaml (3)
- 87-89: The addition of
@versini/ui-privatewith a workspace specifier is correctly implemented. This ensures that the local version of the package is used, which is essential for a monorepo setup.- 100-104: Updating
reactandreact-domto version18.2.0is a significant change. Ensure that this version update is compatible with the rest of the project's dependencies and does not introduce breaking changes.- 120-140: The dependencies added to
packages/ui-privateare correctly specified with their versions. It's important to verify that these dependencies (@floating-ui/react,@tailwindcss/typography,fast-equals, etc.) are necessary for the functionality of theui-privatepackage and do not introduce unnecessary bloat.
Bundle Size (components)
Overall bundle size: 90.68 KB (+18 B +0.02%) Bundle Size (system)
Overall bundle size: 49.06 KB (-104 B -0.21%) |
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: .coderabbit.yaml
Files selected for processing (2)
- packages/bundlesize/package.json (1 hunks)
- pnpm-lock.yaml (4 hunks)
Files skipped from review as they are similar to previous changes (1)
- pnpm-lock.yaml
Additional comments: 1
packages/bundlesize/package.json (1)
- 16-18: The addition of
@versini/ui-privatetodevDependenciesusing the workspace protocol is a good practice for facilitating local development and testing. It aligns with the project's restructuring objectives to enhance modularity and maintainability. Please ensure that this dependency is correctly scoped as a development dependency and not required for the production build of@versini/bundlesize.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
@versini/ui-privatefor enhanced UI components and utilities.LiveRegionandModal.@versini/ui-privatepackage for improved performance and consistency.getSpacingfunction and other utilities.@versini/ui-privateand adjusted peer dependencies accordingly.