fix: apply #5147 fix to marks and nodes #5156
Open
+54
−81
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
✅ Deploy Preview for tiptap-embed ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
nperez0111
commented
May 24, 2024
Comment on lines
+50
to
+64
| // addProseMirrorPlugins() { | ||
| // console.log('custom', this, this.parent) | ||
| // return [ | ||
| // ...this.parent(), | ||
| // ] | ||
| // }, | ||
| }) | ||
| .configure({ lowlight }), | ||
| .configure({ lowlight }) | ||
| .extend({ | ||
| addProseMirrorPlugins() { | ||
| return [ | ||
| ...this.parent(), | ||
| ] | ||
| }, | ||
| }), |
There was a problem hiding this comment.
I will need to add more tests for this. Just wanted it out of my mind
nperez0111
commented
May 24, 2024
| @@ -181,7 +181,7 @@ export class ExtensionManager { | |||
| let defaultBindings: Record<string, () => boolean> = {} | |||
|
|
|||
| // bind exit handling | |||
| if (extension.type === 'mark' && extension.config.exitable) { | |||
| if (extension.type === 'mark' && getExtensionField<AnyConfig['exitable']>(extension, 'exitable')) { | |||
There was a problem hiding this comment.
Per the observation by: #4191 (comment) we should not ever access extension.config to get a field, it needs to just be accessed through this helper that can resolve through inheritance
nperez0111
commented
May 24, 2024
Comment on lines
-239
to
-260
| /** | ||
| * This function extends the schema of the node. | ||
| * @example | ||
| * extendNodeSchema() { | ||
| * return { | ||
| * group: 'inline', | ||
| * selectable: false, | ||
| * } | ||
| * } | ||
| */ | ||
| extendNodeSchema?: | ||
| | (( | ||
| this: { | ||
| name: string | ||
| options: Options | ||
| storage: Storage | ||
| parent: ParentConfig<MarkConfig<Options, Storage>>['extendNodeSchema'] | ||
| }, | ||
| extension: Node, | ||
| ) => Record<string, any>) | ||
| | null | ||
|
|
There was a problem hiding this comment.
Unused on a mark
nperez0111
commented
May 24, 2024
Comment on lines
-261
to
-283
| /** | ||
| * This function extends the schema of the mark. | ||
| * @example | ||
| * extendMarkSchema() { | ||
| * return { | ||
| * group: 'inline', | ||
| * selectable: false, | ||
| * } | ||
| * } | ||
| */ | ||
| extendMarkSchema?: | ||
| | (( | ||
| this: { | ||
| name: string | ||
| options: Options | ||
| storage: Storage | ||
| parent: ParentConfig<NodeConfig<Options, Storage>>['extendMarkSchema'] | ||
| editor?: Editor | ||
| }, | ||
| extension: Node, | ||
| ) => Record<string, any>) | ||
| | null | ||
|
|
There was a problem hiding this comment.
Unused on a node
nperez0111
commented
May 24, 2024
packages/core/src/Extension.ts
Outdated
Comment on lines
459
to
463
| const extension = this.extend({ | ||
| addOptions() { | ||
| return mergeDeep(this.parent?.() || {}, options) as Options | ||
| }, | ||
| }) |
There was a problem hiding this comment.
This is the secret sauce, a configure is just a short way of expressing additional options to be applied
nperez0111
commented
May 24, 2024
| @@ -23,6 +23,7 @@ import { mergeDeep } from './utilities/mergeDeep.js' | |||
|
|
|||
| declare module '@tiptap/core' { | |||
| interface NodeConfig<Options = any, Storage = any> { | |||
| // @ts-ignore allow index signature | |||
| [key: string]: any | |||
There was a problem hiding this comment.
I question this type, but we can leave it ignored for now
nperez0111
commented
May 24, 2024
| @@ -75,6 +75,7 @@ export function getSchemaByResolvedExtensions(extensions: Extensions, editor?: E | |||
| getExtensionField<NodeConfig['draggable']>(extension, 'draggable', context), | |||
| ), | |||
| code: callOrReturn(getExtensionField<NodeConfig['code']>(extension, 'code', context)), | |||
| whitespace: callOrReturn(getExtensionField<NodeConfig['whitespace']>(extension, 'whitespace', context)), | |||
There was a problem hiding this comment.
whitespace was not being sent to the schema when it should have been, per: #4191 (comment)
2 tasks
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.
Changes Overview
As a follow up to #5147
In my previous PR, @634750802 reminded me that Nodes & Marks both have the configure method as well and have almost the exact same logic as extensions. So I applied the change to Nodes & Marks as well
Implementation Approach
See $5147
Testing Done
Ran all tests, everything looks good
Verification Steps
See above
Additional Notes
Checklist
feat: Implement new featureorchore(deps): Update dependencies)Related Issues