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

fix: unsupported node mark #135

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Conversation

XiaodongTong
Copy link

fix #47

Using『node mark』 as an attribute on YElement,Each mark corresponds to an YElement attribute.
Runable in my project.

Hope to merge

Copy link
Member

@dmonad dmonad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR. Could you please add some tests first? Specifically, we should test adding & removing marks from nodes.

const prefix = 'yelement_mark_'
marks.forEach((mark) => {
if (mark.type.name !== 'ychange') {
pattrs[`${prefix}${mark.type.name}`] = JSON.stringify(mark.attrs || {})
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why Stringify?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a .toJSON method on mark.attrs or is it actually already a JSON object?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i will change

}
} else {
yDomFragment.removeAttribute(key)
}
}
// remove all keys that are no longer in pAttrs
for (const key in yDomAttrs) {
if (pAttrs[key] === undefined) {
if (attrs[key] === undefined) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here, we clean up unused attributes. When are unused marks removed?

@@ -780,7 +796,7 @@ const createTypeFromTextOrElementNode = (node, mapping) =>
const isObject = (val) => typeof val === 'object' && val !== null

const equalAttrs = (pattrs, yattrs) => {
const keys = Object.keys(pattrs).filter((key) => pattrs[key] !== null)
const keys = Object.keys(pattrs).filter((key) => pattrs[key] !== null && !key.includes('yelement_mark_'))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use key.startsWith instead

const key = keys[i];
const l = JSON.stringify(pMarkAttr[key])
const r = yattrs[key]
eq = key === 'ychange' || l === r ;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once l and r are objects. You could use f.equalityDeep to compare them. Where import * as f from 'lib0/function'

for (const key in attrs) {
if (key.startsWith('yelement_mark_')) {
const markName = key.replace('yelement_mark_','');
let markValue = attrs[key];
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be const

@@ -780,7 +797,7 @@ const createTypeFromTextOrElementNode = (node, mapping) =>
const isObject = (val) => typeof val === 'object' && val !== null

const equalAttrs = (pattrs, yattrs) => {
const keys = Object.keys(pattrs).filter((key) => pattrs[key] !== null)
const keys = Object.keys(pattrs).filter((key) => pattrs[key] !== null && !key.startsWith('yelement_mark_'))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are you filtering yelement_mark_ here in the attributes that you get from the prosemirror node? If there is a reason, why are you not filtering in the next line when you are comparing?

@@ -965,6 +1000,17 @@ const marksToAttributes = (marks) => {
return pattrs
}

const nodeMarksToAttributes = (marks) => {
const pattrs = {}
const prefix = 'yelement_mark_'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's store this prefix globally somewhere as it is reused throughout the file. Also I suggest we use a shorter name that starts with an _. E.g. _mark_.

@kkeybbs
Copy link

kkeybbs commented May 23, 2023

I meet similar sitituation in my custom prosemirror's schema.I'm not sure about when to use mark / attrs for a node.

But in file y-prosemirror/src/lib.js,
yXmlFragmentToProsemirrorJSON this function processes only text nodes' marks, and attrs only for non-text nodes.

If marks are designed just for text node, and atts for non-text nodes, y-prosemirror will should not support marks for non-text nodes, as that will be anti prosemirror's design.

It's a pleasure for any suggestion or guidance on how to use marks/attrs correctly, fellows the design.

@josonyang
Copy link

I meet similar sitituation in my custom prosemirror's schema.I'm not sure about when to use mark / attrs for a node.

But in file y-prosemirror/src/lib.js, yXmlFragmentToProsemirrorJSON this function processes only text nodes' marks, and attrs only for non-text nodes.

If marks are designed just for text node, and atts for non-text nodes, y-prosemirror will should not support marks for non-text nodes, as that will be anti prosemirror's design.

It's a pleasure for any suggestion or guidance on how to use marks/attrs correctly, fellows the design.

I have also need to handle this case

In my understanding,marks act as a way to add attrs to prosemirror document , not only text node.

In tiptap and Confluence Editor , also use mark to effect non-text node

@jjgmckenzie
Copy link

jjgmckenzie commented May 29, 2023

Looking good, very useful feature for format compatibility & avoiding data loss.

@XiaodongTong - any plans to fix the final requested change and add tests?

jibin2706 added a commit to peppercontent/y-prosemirror that referenced this pull request Aug 4, 2023
jibin2706 added a commit to peppercontent/y-prosemirror that referenced this pull request Aug 4, 2023
@hoebbelsB
Copy link

@dmonad are there any plans to merge this? I also face the very same issue and wanted to raise a PR. Then I noticed this one here. I can also complete this work if you like

@Pruxis
Copy link

Pruxis commented Jul 2, 2024

What's actuality pending here? I'd like to contribute to get this thing through

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

Successfully merging this pull request may close these issues.

Does not support marks on non-TextNodes
7 participants