feat(core): allow independent registration and override of node/mark specs in extensions#990
Draft
feat(core): allow independent registration and override of node/mark specs in extensions#990
Conversation
fed0b73 to
90f79f8
Compare
…specs in extensions
90f79f8 to
9823331
Compare
makhnatkin
reviewed
Apr 3, 2026
| }); | ||
|
|
||
| describe('granular add methods', () => { | ||
| it('should add node via granular methods', () => { |
Collaborator
There was a problem hiding this comment.
it('should preserve addNode full spec when addMarkdownTokenParserSpec uses same tokenName', () => {
// Bug scenario: tokenName === entityName in step 1b of build()
// Step 1 adds full spec under 'code_block'.
// Step 1b finds parserSpecsByEntity['code_block'] and calls map.addToEnd('code_block', parserOnlyEntry),
// which overwrites the full spec with { spec: {}, toMd: () => { throw } }.
const realToMd = jest.fn();
const nodes = new ExtensionBuilder(logger)
.addNode('code_block', () => ({
spec: {group: 'block', code: true},
fromMd: {tokenSpec: {name: 'code_block', type: 'block', noCloseToken: true}},
toMd: realToMd,
}))
.addMarkdownTokenParserSpec('code_block', () => ({
// tokenName === entityName: 'code_block' → 'code_block'
name: 'code_block',
type: 'block',
noCloseToken: true,
}))
.build()
.nodes();
// Full addNode spec must survive — not be replaced by parser-only entry
expect(nodes.size).toBe(1);
const codeBlock = nodes.get('code_block');
expect(codeBlock).toBeTruthy();
// Spec must be the real one, not {} from buildParserOnlyNodeEntry
expect(codeBlock!.spec.group).toBe('block');
expect(codeBlock!.spec.code).toBe(true);
// toMd must be the real function, not the throwing stub
expect(codeBlock!.toMd).toBe(realToMd);
expect(() => (codeBlock!.toMd as Function)()).not.toThrow();
});
makhnatkin
reviewed
Apr 3, 2026
| * @deprecated Will be removed in the next major version. | ||
| * Use addNodeSpec() + addMarkdownTokenParserSpec() + addNodeSerializerSpec() instead. | ||
| */ | ||
| addNode(name: string, cb: AddPmNodeCallback): this { |
Collaborator
There was a problem hiding this comment.
Should we add the same checks like:
if (this.#rawNodeSpecs[name]) {
throw new Error(`Node spec with name "${name}" already registered via addNodeSpec`);
}?
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
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.
Description
addNode/addMarkbundle schema spec, parser spec, and serializer spec into a single callback, making it impossible for one extension to incrementally modify another — the only option was full replacement.This PR adds granular registration and override methods to
ExtensionBuilder:New add methods:
addNodeSpec,addMarkSpec— register ProseMirror schema specs independentlyaddMarkdownTokenParserSpec— register markdown-it token → PM entity mappingaddNodeSerializerSpec,addMarkSerializerSpec— register serializer specsNew override methods:
overrideNodeSpec,overrideMarkSpec— modify previously registered schema specsoverrideMarkdownTokenParserSpec— modify parser token specs (works with bothaddNodeand granular API)overrideNodeSerializerSpec,overrideMarkSerializerSpec— modify serializer specsaddNodeandaddMarkmethods are marked as@deprecated.