jfhr / deltaconvert

Convert quill deltas to and from other formats

👋 Hello World!

You can find my open-source projects on this page. Most projects are also hosted on jfhr.de/source.

Read my blog, if you like: jfhr.me

Reach out: [email protected]

deltaconvert's Issues

Add video support

Videos should be supported in deltaToHtml, deltaToNpf, htmlToDelta, and npfToDelta.

Considerations:

• HTML supports multiple <src> elements. We could always pick the first one
• NPF supports multiple ways to specify a source: media { type, url } for videos that can be played natively, embed_html, embed_iframe, embed_url and url. url would always work but we could add extra logic for some known providers (e.g. youtube)
• Quill by default inserts videos is <iframe>s with class ql-video. We should treat these like <video>s, using the <src> attribute as the video url

Todo:

• Add unit tests
  • deltaToHtml
  • htmlToDelta
  • npfToDelta
  • deltaToNpf
• Implement stuff
• Add bugs
• Fix bugs

Support code tags

Objects of the form { insert: "foo", attributes: { code: true, /*...*/ } } should be converted into <code>foo</code>, or the equivalent on other platforms

`deltaToIntermediate` loses paragraph break if the first character of the new paragraph has formatting, but the last newline of the previos paragraph does not

Example:

deltaToIntermediate({
    ops: [
        { insert: 'found this for you:\n\n' },
        {
            insert: 'nasa.gov',
            attributes: { link: 'https://www.nasa.gov' }
        },
        { insert: '\n\n' }
    ]
});

Expected: two seperate block inserts, one with 'found this for you:', one with the link.

Got: everything in one block insert

Add deltaToSsml

SSML is an XML format for speech synthesis. See here.

At a minimum we should support:

• top-level <speak> element
• bold text to <emphasis> (only full sentences)
• paragraphs to <p> elements
• maybe sentences to <s> elements, although most TTS engines should be able to split sentences on their own

I don't see the use case for the reverse (ssmlToDelta), so that's not part of this PR

Support code blocks

#6 was about inline code, this one is about code blocks

Objects of the form { insert: "\n", attributes: { "code-block": true, /*...*/ } } should be converted into <pre><code>foo</code></pre>, or the equivalent on other platforms

For tumblr npf, we can use the chat subtype for this (see #7)