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

Yjs plugin #2487

Merged
merged 13 commits into from
Jul 17, 2023
Merged

Yjs plugin #2487

merged 13 commits into from
Jul 17, 2023

Conversation

zbeyens
Copy link
Member

@zbeyens zbeyens commented Jul 9, 2023

Description

See changesets.

# Conflicts:
#	config/aliases-plate.js
#	docs/docs/sidebars.js
#	yarn.lock
@changeset-bot
Copy link

changeset-bot bot commented Jul 9, 2023

🦋 Changeset detected

Latest commit: a33f9b1

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@udecode/plate-yjs Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@vercel
Copy link

vercel bot commented Jul 9, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
plate ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 17, 2023 2:27pm

@reviewpad
Copy link
Contributor

reviewpad bot commented Jul 9, 2023

AI-Generated Summary: This pull request introduces support for collaborative editing feature using Yjs. Specifically, it adds a new 'Plate yjs plugin' package (@udecode/plate-yjs) that handles the Yjs collaborative editing feature integration. This includes adding new exports, creating the yjs plugin, creating necessary utility functions and middleware.

It adds a new Rollup named export for the 'scheduler' module and updates the yarn.lock file with new dependencies.

Additionally, it includes documentation for how to install and use the new plugin (@udecode/plate-yjs), detailing how to enable and disable certain features. This documentation is added to the existing documentation in /docs/docs/plugins/collaboration.mdx

Tests and test utilities directories are ignored during the npm packaging of the new 'Plate yjs plugin' plugin.

Also, multiple TypeScript files were added for the Yjs plugin, including: creating the Yjs plugin, hooking up Yjs, handling cursors in Yjs, handling history in Yjs, initializing Yjs, and a store for Yjs state.

In summary, this pull request adds the essential components for collaborative editing feature using Yjs in the Plate editor.

@reviewpad reviewpad bot added the large Pull request is large label Jul 9, 2023
@reviewpad
Copy link
Contributor

reviewpad bot commented Jul 9, 2023

Reviewpad Report

⚠️ Warnings

  • Please rebase your pull request on the latest changes

@ghost
Copy link

ghost commented Jul 9, 2023

👇 Click on the image for a new way to code review

Review these changes using an interactive CodeSee Map

Legend

CodeSee Map legend

zbeyens added 2 commits July 17, 2023 15:30
@zbeyens zbeyens marked this pull request as ready for review July 17, 2023 15:02
@zbeyens zbeyens merged commit 347e051 into main Jul 17, 2023
7 checks passed
@zbeyens zbeyens deleted the feat/yjs branch July 17, 2023 15:02
@zbeyens zbeyens mentioned this pull request Jul 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
large Pull request is large waiting-for-review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant