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

Support for Quill v2 #16

Closed
mjwweb opened this issue Jan 5, 2024 · 5 comments
Closed

Support for Quill v2 #16

mjwweb opened this issue Jan 5, 2024 · 5 comments
Assignees
Labels
enhancement New feature or request

Comments

@mjwweb
Copy link

mjwweb commented Jan 5, 2024

I see this project isn't maintained anymore. Are there any plans to keep it updated, or should I switch over to using y-prosemirror? Quill v2 official beta is out [email protected], but not yet supported in y-quill. I have verified the official beta release of Quill v2 here:

slab/quill#3806 (comment)

Quill v1 is using a deprecated DOMNodeInserted mutation event which will be removed from Chrome in July 2024, making Quill v1 obsolete along with y-quill. You can learn more about the issue in the link I provided. As of now, I see y-quill has no support for Quill v2 and I get these errors when building y-quill with v2:

npm ERR! code ERESOLVE
npm ERR! ERESOLVE could not resolve
npm ERR!
npm ERR! While resolving: [email protected]
npm ERR! Found: [email protected]
npm ERR! node_modules/quill
npm ERR! quill@"^2.0.0-beta.0" from the root project
npm ERR!
npm ERR! Could not resolve dependency:
npm ERR! peer quill@"^1.3.7" from [email protected]
npm ERR! node_modules/y-quill
npm ERR! y-quill@"^0.1.5" from the root project
npm ERR!
npm ERR! Conflicting peer dependency: [email protected]
npm ERR! node_modules/quill
npm ERR! peer quill@"^1.3.7" from [email protected]
npm ERR! node_modules/y-quill
npm ERR! y-quill@"^0.1.5" from the root project
npm ERR!
npm ERR! Fix the upstream dependency conflict, or retry
npm ERR! this command with --force or --legacy-peer-deps
npm ERR! to accept an incorrect (and potentially broken) dependency resolution.
npm ERR!
npm ERR!
npm ERR! For a full report see:
npm ERR! /home/ubuntu/.npm/_logs/2024-01-05T15_39_57_532Z-eresolve-report.txt

npm ERR! A complete log of this run can be found in: /home/ubuntu/.npm/_logs/2024-01-05T15_39_57_532Z-debug-0.log

@mjwweb mjwweb added the enhancement New feature or request label Jan 5, 2024
@dmonad
Copy link
Member

dmonad commented Jan 15, 2024

This project is still maintained ;)

I wasn't aware that the stable quill@v1 releases uses a deprecated APi. Is that documented somewhere? If I recall correctly, the v2 release has been in beta-status for a few years now. So I'm a bit hesitant to upgrade y-quill right now.

Regarding the deprecation of APIs and quill v1 not working anymore: I'm not sure where you read that, but I don't think this will happen. Quill v1 is used by A LOT of websites. Chrome won't just remove the feature and break the internet.

Once Quill makes a release, I'll get started on upgrading y-quill to the current stable release. Please ping me here once that happens.

In the meantime, if you are interested in building it yourself, I'd be happy to help!

@mjwweb
Copy link
Author

mjwweb commented Jan 16, 2024

The DOM mutation event (DOMNodeInserted) will indeed be removed from in Chrome in July 2024 which Quill v1 does rely on to some extent.

You can read more on the Chrome deprecation here

The Quill maintainers are hinting they wont be updating Quill v1 to fix this issue
slab/quill#3806 (comment)

Another comment regarding the support of Quill v1 after Chrome deprecates dom mutation events:
slab/quill#3806 (comment)

I very briefly looked into y-quill.js and I assume as long as the quill deltas remain the same in Quill v2 then y-quill should work fine with v2. I don't see any major changes in v2 as of now.

Updating the peer dependencies in the package.json of y-quill should suffice. I haven't done any testing so don't take my word for it. If I get around to do any testing I'll post back in this thread.

  "peerDependencies": {
    "yjs": "^13.0.0",
    "quill": "1.3.6 || 2.0.0"
  }

@dmonad
Copy link
Member

dmonad commented Jan 18, 2024

Wel.. I hope the Chrome Team knows that they gonna break the internet next July.

@dmonad
Copy link
Member

dmonad commented Jan 18, 2024

meme-this-is-fine

Chrome Dev Team in July

@dmonad dmonad closed this as completed in 6f275a3 Apr 22, 2024
@dmonad
Copy link
Member

dmonad commented Apr 22, 2024

Quill@v2 was finally released. I made this library ready for v2 and upgraded all the build tools.
I will publish a y-quill@v1 release soon that will be compatible with quill@v2.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants