tiptap-rusty-parser

tiptap-rusty-parser reads Tiptap (ProseMirror) JSONContent documents into a mutable tree of nodes and writes them back out. You can find nodes with closures or a small query language, edit the tree in place, address nodes by index path or by ProseMirror position, diff two documents, validate against a schema and render HTML.

The crate is built around three rules:

• Schema-agnostic. Any node or mark type is accepted. A schema is optional and only used when you ask for validation.
• Faithful roundtrip. Unknown node types and unknown JSON fields are kept and written back. Missing and empty fields stay distinct, so "content": [] does not turn into a missing key or the other way round.
• Performance first. Queries return borrows instead of clones, and edits happen in place on the tree.

Tiptap Studio runs every document operation through this crate.

InstallCopy Anchor Link

[dependencies]
tiptap-rusty-parser = "0.6"

The crate uses Rust edition 2021 and depends on serde, serde_json (with preserve_order), thiserror and unicode-segmentation.

Quick startCopy Anchor Link

Parse a document, find nodes, change them and serialize the result:

use tiptap_rusty_parser::{Document, Mark, Node, Query};

let mut doc = Document::from_json_str(
    r#"{"type":"doc","content":[
        {"type":"heading","attrs":{"level":1},"content":[{"type":"text","text":"Notes"}]},
        {"type":"paragraph","content":[{"type":"text","text":"hello"}]}
    ]}"#,
)?;

// Query with a closure, or with the query language.
assert_eq!(doc.by_type("paragraph").len(), 1);
let q = Query::parse("type == heading && attrs.level == 1")?;
assert_eq!(q.find_paths(doc.root()), vec![vec![0]]);

// Bold every text node and append a paragraph.
let changed = doc.replace_all(
    |n| n.node_type.as_deref() == Some("text"),
    |n| {
        n.add_mark(Mark::new("bold"));
    },
);
assert_eq!(changed, 2);
doc.push_child(Node::element("paragraph").with_text("bye"));

assert_eq!(doc.text_content_with_separator("\n"), "Notes\nhello\nbye");
assert!(doc.to_json_str()?.ends_with(r#"{"type":"paragraph","content":[{"type":"text","text":"bye"}]}]}"#));

Document derefs to its root Node, so every Node method works on a Document directly.

API referenceCopy Anchor Link

The full API reference, with every type and method, is on docs.rs. These pages explain how the pieces fit together.

NextCopy Anchor Link