Add remark-slate source code to Plate

[12joan]

Description

Fixes #2173

Adds a subset of the remark-slate source code to Plate for ease of modification. To comply with remark-slate's MIT license, I've added @hanford's name to Plate's LICENSE file.

Rather than copy over remark-slate's tests, I've added tests for each element type supported by deserializeMd. A few element types produce incorrectly structured (although mostly still usable) Slate nodes. I'll un-skip the relevant tests once those are fixed. Until then, this PR is a draft. Ready for merge.

To do

• Fix blockquotes
• Fix strikethrough Not supported by remark-parse
• Fix images
• Fix code blocks
• Fix lists
• Fix <br>
• Fix generics
• Make rules configurable through Plate plugin options

[changeset-bot]

🦋 Changeset detected

Latest commit: e382038

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages

Name	Type
@udecode/plate-serializer-md	Minor
@udecode/plate-headless	Minor
@udecode/plate	Minor
@udecode/plate-ui	Minor

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

[vercel]

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

Name	Status	Preview	Comments	Updated
plate	✅ Ready (Inspect)	Visit Preview	💬 Add your feedback	Jan 31, 2023 at 5:11PM (UTC)
plate-examples	✅ Ready (Inspect)	Visit Preview	💬 Add your feedback	Jan 31, 2023 at 5:11PM (UTC)

[ghost]

👇 Click on the image for a new way to code review

• Make big changes easier — review code in small groups of related files

• Know where to start — see the whole change at a glance

• Take a code tour — explore the change with an interactive tour

• Make comments and review — all fully sync’ed with github

  Try it now!

Legend

[zbeyens]

Great! Left a few comments

[12joan]

@zbeyens I've made the requested changes. Element and mark types turned out not to be necessary; TDescendant, TElement and TText sufficed.

I've also refactored the deserialization rules into an options object, which I'll expose in createDeserializeMdPlugin once the code settles down a little. That ought to be helpful for use cases like this one.

This might be a good time for you to take another look at the code and make sure the coding style is consistent with Plate (should I be using a T prefix for the types, for instance?). No hurry though; there's still plenty to do before the PR is ready to merge.

[12joan]

A couple of objects in the refactored remark-slate need to call getPluginType with editor, so I've added editor: PlateEditor<V> where V extends Value to RemarkPluginOptions and various other types and functions. I managed to get it working in commit 5c4cf6f, but I don't know how to get past this error in the latest WIP commit:

Fixed with ({ ... } as unknown) as RemarkPluginOptions<V>. I'm not sure this is the best solution, but it makes the code compile.

[12joan]

Fixed with ({ ... } as unknown) as RemarkPluginOptions<V>. I'm not sure this is the best solution, but it makes the code compile.

Never mind, things started breaking again the moment I added createDeserializeMdPlugin() to the tests.

    packages/serializers/md/src/deserializer/utils/deserializeMd.spec.tsx:14:15 - error TS2322: Type 'PlatePlugin<DeserializeMdPlugin<Value>, Value, PlateEditor<Value>>' is not assignable to type 'PlatePlugin<AnyObject, Value, PlateEditor<Value>>'.
      Type 'PlatePlugin<DeserializeMdPlugin<Value>, Value, PlateEditor<Value>>' is not assignable to type '{ editor?: Nullable<{ insertData?: PlatePluginInsertData<Value> | undefined; }> | undefined; handlers?: Nullable<DOMHandlers<AnyObject, Value, PlateEditor<...>> & { ...; }> | undefined; ... 6 more ...; type?: string | undefined; }'.
        Types of property 'handlers' are incompatible.
          Type 'Nullable<DOMHandlers<DeserializeMdPlugin<Value>, Value, PlateEditor<Value>> & { onChange?: OnChange<DeserializeMdPlugin<Value>, Value, PlateEditor<...>> | undefined; }> | undefined' is not assignable to type 'Nullable<DOMHandlers<AnyObject, Value, PlateEditor<Value>> & { onChange?: OnChange<AnyObject, Value, PlateEditor<Value>> | undefined; }> | undefined'.
            Type 'Nullable<DOMHandlers<DeserializeMdPlugin<Value>, Value, PlateEditor<Value>> & { onChange?: OnChange<DeserializeMdPlugin<Value>, Value, PlateEditor<...>> | undefined; }>' is not assignable to type 'Nullable<DOMHandlers<AnyObject, Value, PlateEditor<Value>> & { onChange?: OnChange<AnyObject, Value, PlateEditor<Value>> | undefined; }>'.
              Types of property 'onCopy' are incompatible.
                Type 'DOMHandler<DeserializeMdPlugin<Value>, Value, PlateEditor<Value>, ClipboardEvent<Element>> | null | undefined' is not assignable to type 'DOMHandler<AnyObject, Value, PlateEditor<Value>, ClipboardEvent<Element>> | null | undefined'.
                  Type 'DOMHandler<DeserializeMdPlugin<Value>, Value, PlateEditor<Value>, ClipboardEvent<Element>>' is not assignable to type 'DOMHandler<AnyObject, Value, PlateEditor<Value>, ClipboardEvent<Element>>'.

    14     plugins: [createDeserializeMdPlugin()],
                     ~~~~~~~~~~~~~~~~~~~~~~~~~~~

@zbeyens Can you see what's wrong here? I can't tell what's different between this plugin's type and, say, createResetNodePlugin's that might be causing this error.

Relevant files:

• createDeserializeMdPlugin.ts
• deserializer/types.ts
• deserializeMd.spec.tsx

[zbeyens]

@12joan you can abuse of as any in test files, this is a less important place. For more context, some plate types are challenging to get right with generics and the plugins array parameter is one of them.

so, plugins: [createDeserializeMdPlugin() as any],