search

yorkie-team / dashboard

Dashboard is an administrative tool that allows users to manage projects and documents with ease.
https://yorkie.dev/dashboard/
Apache License 2.0
20 stars 13 forks source link

Update Vite's Node API to ESM from CJS build #155

Closed chacha912 closed 6 days ago

chacha912 commented 6 days ago

What this PR does / why we need it?

This PR resolves the warning message that occurs when running npm run dev or npm run build in Vite. The warning message states that the CJS build of Vite's Node API is deprecated and provides instructions on how to address the issue by switching to ESM.

Any background context you want to provide?

What are the relevant tickets?

Fixes #154

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 6 days ago

Walkthrough

The codebase has transitioned from CommonJS to ES modules across multiple files, addressing deprecation warnings related to Vite's CJS build. The buf.gen.yaml configuration was updated for js_import_style, the package.json file now specifies "type": "module", and export default syntax replaced module.exports in JavaScript configurations. Dependencies and import paths were also updated where necessary.

Changes

File Path Change Summary
buf.gen.yaml Updated js_import_style from legacy_commonjs to module.
package.json Added "type": "module" and a new dependency.
postcss.config.js Switched from module.exports to export default.
src/api/converter.ts Updated the import path for BadRequest.
src/api/.../admin_connect.d.ts Updated protoc-gen-connect-es version and js_import_style.
src/api/.../admin_connect.js Changed import statements to ES modules and updated declarations.
src/api/.../admin_pb.d.ts Updated tool version and js_import_style parameter.
src/api/.../admin_pb.js Transitioned to ES module syntax.
src/api/.../resources_pb.d.ts Updated tool version and js_import_style parameter.
src/api/.../resources_pb.js Transitioned to ES module syntax.

Sequence Diagram(s)

(Not applicable – changes are straightforward and pertain to module syntax conversion rather than control flow modifications)

Assessment against linked issues

Objective (Issue #154) Addressed Explanation
Switch from CJS build to ESM to eliminate deprecation warnings ✅

Poem

In the code where changes gleam,
From CommonJS to ES module dream,
Vite's warnings now no more,
We've aligned with modern lore.
Modules fresh, our paths anew,
With better code, we start anew. 🚀

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.