yorkie-team / yorkie-ui

Yorkie UI is a set of components and styles for Yorkie.
https://yorkie.dev/yorkie-ui
Apache License 2.0
6 stars 0 forks source link

Change build package from tsc to rollup #127

Closed vitran12 closed 3 months ago

vitran12 commented 3 months ago

What this PR does / why we need it:

Special notes for your reviewer:

Which issue(s) this PR fixes:

Fixes #

Checklist:

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

[!WARNING]

Rate limit exceeded

@vitran12 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 31 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 25abe51490d0267ebd53b550482878ac238c6dd4 and 3790b357cbbd46ab7401f10aaaa0485a2cd3e8b6.

Walkthrough

This update introduces major improvements and refactors, including changes to the .gitignore file, package.json, and various TypeScript and React component files. Key modifications involve enhanced build scripts, better import paths, and restructured export synchronization. The Rollup configuration file has been optimized with new plugins, and Babel settings have been standardized.

Changes

File/Path Change Summary
.gitignore Added /.rollup.cache, removed /storybook-static.
package.json Updated version to 0.5.18, revised main and module paths, restructured exports, added build scripts and dependencies for Rollup and TypeScript plugins.
rollup.config.mjs Added and configured multiple Rollup plugins for bundling process, updated export settings.
.babelrc Introduced configuration for Babel presets, including @babel/env and @babel/preset-react.
src/components/ui/button/Button.tsx Consolidated Icon and LinkProps imports, streamlined <Icon> component usage for icon positioning.
src/components/ui/toast/Toast.stories.tsx Adjusted import for CloseIcon to Icons.IconClose.
src/index.ts Updated import paths for exporting components from a different directory structure.
src/components/ui/aspect/AspectRatio.stories.tsx Changed image import for Yorkie to use an absolute path.
src/components/ui/dialog/Dialog.stories.tsx Modified property descriptions, switched between single and double quotes.
src/components/ui/button/index.ts Removed export of ButtonProps type.
src/components/ui/input/index.ts Changed export syntax for InputProps to use export type instead of export.

Sequence Diagram(s)

Build Process Overview

sequenceDiagram
    participant Dev as Developer
    participant Term as Terminal
    participant Rollup as Rollup Bundler
    Dev ->> Term: Run build script
    Term ->> Rollup: Trigger build
    Rollup ->> TypeScript: Transpile code
    Rollup ->> Babel: Process React and ES6
    Rollup ->> CommonJS: Handle commonjs modules
    Rollup ->> Output: Write bundles to disk

Import Changes Workflow

sequenceDiagram
    participant Dev as Developer
    participant Code as Codebase
    Dev ->> Code: Update import paths and structures
    Code ->> Rollup: Adapted to new paths in config
    Rollup -->> Dev: Bundle updated with new paths

Poem

Amidst the code the changes flow,
With Rollup's magic, scripts now glow.
Imports tidy, exports clean,
A build refined, a codebase keen.
TypeScript friends, in harmony dance,
For buttons, toast, and dialog's chance.
The version sings a new sweet tune,
Enhanced and ready, like a summer's bloom. 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.