Migrate Scribe editor to ProseMirror #353
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ion alternative node package managers since many of us use fnm
rhystmills
changed the title
simonbyford
approved these changes
Apr 29, 2024
There was a problem hiding this comment.
I don't know anything about Scribe so may have missed some subtleties in the migration but the code looks good and everything appears to work okay. I tried editing/creating atoms and making sure the rich text fields are persisted correctly, all looks good.
Great work on tackling the last high-priority vulnerability! 🦾
There was a problem hiding this comment.
Should this be renamed FormFieldRichTextEditor.js?
There was a problem hiding this comment.
It absolutely should.
(Now done).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this change?
This PR replaces our Scribe editor with ProseMirror, via @guardian/prosemirror-editor. Scribe is deprecated and contains vulnerabilities, so we want to replace it everywhere it exists. ProseMirror is the rich text editor we use in other tools (most notably flexible-content) so it makes sense to use it here too. This work has already been done for tagmanager and there's a PR open in targeting.
This removes the final (high priority) vulnerability from client-side atom-workshop: 🎉
atom-workshophas historically used<b>and<i>tags rather than the more semantically correct<strong>and<em>tags - I've preserved these (viatransformToLegacyMarkup) for the sake of maintaining styles in consuming platforms.The UX is slightly improved on the previous editor, introducing hover and disabled states for the buttons.
What else does this change?
I found the setup script was failing on a step where
brewtries to installopenjdk8. As it happens this repo now uses Java 11 and advises using a package manage to install it, so I've removed that step.(I also added a mention to the readme that other node package managers are available.)
How to test