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-Fixing Incorrect List Numbering When Directly Parsing Markdown Content #2876

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

fwx5618177
Copy link

I fixed an issue:

  1. When directly passing markdown content, remarkDefaultElementRules' list transform was unable to correctly read the proper list numbering.
    Here's the code content:
// transform hook
const deserializeMarkdown2Slate = (html: string): Value => {
  const file = unified()
    .use(remarkParse)
    .use(remarkPlugin, {
      elementRules: remarkDefaultElementRules,
      textRules: remarkDefaultTextRules,
      indentList: true,
      editor: null,
    })
    .processSync(html);

  const tree = file.result as Value;

  console.log({
    tree,
  });

  return tree;
};

// value is markdown content
const slateValue = deserializeMarkdown2Slate(value);

<Plate plugins={plugins} initialValue={slateValue}>
 ...
</Plate>

It displayed incorrect ordering.
image

Therefore, I modified the code in remarkDefaultElementRules:

listItems.push({
  type: getPluginType(options.editor, ELEMENT_PARAGRAPH),
  listStyleType,
  indent,
  listStart: index + 1,
  children: remarkTransformElementChildren(paragraph, options),
});

Now it displays correctly.

image

Here's the test data content:
{
"type": "list",
"ordered": true,
"start": 1,
"spread": false,
"children": [
// ... (contents of the list items)
],
"position": {
"start": {
"line": 50,
"column": 1,
"offset": 1237
},
"end": {
"line": 52,
"column": 64,
"offset": 1385
}
}
}

Here's the transformed data content:
{
"type": "p",
"listStyleType": "decimal",
"indent": 1,
"children": [
{
"text": "《深入理解计算机系统》,重点做完 lab"
}
]
},
// ... (other transformed list items)

Here's the data content after the fix:
{
"type": "p",
"listStyleType": "decimal",
"indent": 1,
"listStart": 0,
"children": [
{
"text": "《深入理解计算机系统》,重点做完 lab"
}
]
},
// ... (other fixed list items)

Copy link

changeset-bot bot commented Jan 9, 2024

⚠️ No Changeset found

Latest commit: 9b5a28a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Jan 9, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
plate ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 30, 2024 5:15pm

@zbeyens
Copy link
Member

zbeyens commented Jan 29, 2024

Thanks for the PR, could you fix the CI?

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.

2 participants