Amend an existing snippet. #431
Merged
Conversation
This file contains hidden or 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
🦋 Changeset detectedLatest commit: 5f4c5e3 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
✅ Deploy Preview for stacks-editor ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
alexwarren
approved these changes
Apr 28, 2025
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.
Describe your changes
In the Stacks Snippets plugin, we were relying on callers to append their changes to the document. This PR creates a callback parameter on the
openSnippetModalfunction definition such that a function that will update the document can be called instead.This allows us to amend existing snippets by their ID (which is available on the
snippetMetadatapassed toopenSnippetsModal) by replacing thier contents. If it is not present, we append to the document.PR Checklist
/** ... */docsbug/enhancementand other labels as appropriateEnvironment(s) tested
Additional context
I ran into an issue here where the plugin is trying to interact with the markdown-it parser while during a Prosemirror flow. We bundle these together at a top level (e.g.
RichTextEditor) which encapsulates Prosemirror'sEditorViewand aMarkdownSerializer(which is ultimately served by markdown-it).Long story short, we need a way of being able to access that encapsulation from inside the
EditorView, and as such I've registered theBaseViewState(and it's Key) so that we can grab a handle on the editor, and use a familiar pathway for serialization tasks and the like.