Skip to content
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

[WEB-1116] chore: remove yjs packages from the editor #5603

Merged
merged 2 commits into from
Sep 16, 2024

Conversation

aaryan610
Copy link
Collaborator

@aaryan610 aaryan610 commented Sep 13, 2024

This PR removes all the unnecessary yjs packages from the editor.

Summary by CodeRabbit

  • New Features

    • Streamlined editor functionality by removing unnecessary dependencies, enhancing performance.
  • Bug Fixes

    • Adjusted collaborative editing features by eliminating outdated Yjs integrations, which may improve stability.
  • Documentation

    • Updated export statements to reflect the removal of Yjs-related functionalities, ensuring clarity in available features.

Copy link
Contributor

coderabbitai bot commented Sep 13, 2024

Important

Review skipped

Review was skipped due to path filters

Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request involves the removal of several Yjs-related dependencies and associated functionality from the packages/editor directory. Specifically, the y-prosemirror, y-protocols, and yjs dependencies have been deleted from the package.json, along with the removal of the yjs.ts helper file that facilitated the integration of ProseMirror with Yjs. Additionally, the export statement for the yjs helper has been removed from the index.ts file, indicating a significant shift in the project's approach to collaborative editing features.

Changes

Files Change Summary
packages/editor/package.json Removed dependencies: y-prosemirror, y-protocols, yjs.
packages/editor/src/core/helpers/yjs.ts Removed the file containing functions for converting ProseMirror JSON documents to Yjs documents and managing updates, including exports for proseMirrorJSONToBinaryString, applyUpdates, and mergeUpdates.
packages/editor/src/index.ts Removed export statement for yjs helper, indicating a refactor or shift in module dependencies.

Possibly related PRs

Suggested labels

🛠️refactor

Poem

In the meadow where rabbits play,
Yjs has hopped away today.
Dependencies shed, a lighter load,
New paths ahead, on this bright road.
With every change, we leap and bound,
In code's embrace, new joy is found! 🐇✨


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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • 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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@pushya22 pushya22 merged commit 6826ce0 into preview Sep 16, 2024
14 of 15 checks passed
@pushya22 pushya22 deleted the chore/remove-yjs-packages branch September 16, 2024 12:58
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