feat: add text exporter

.gitignore

@@ -7,6 +7,7 @@
 *.sir.in
 *.pdf
 *.rmp
+*.txt
 *.tsbuildinfo
 /out.json
 

Cargo.toml

@@ -200,6 +200,7 @@ typst-ts-canvas-exporter = { version = "0.4.1-rc2", path = "exporter/canvas" }
 typst-ts-raster-exporter = "0.4.1-rc1"
 typst-ts-serde-exporter = "0.4.1-rc1"
 typst-ts-svg-exporter = "0.4.1-rc1"
+typst-ts-text-exporter = "0.4.1-rc1"
 
 # project common components
 typst-ts-dev-server = { version = "0.4.1-rc2", path = "server/dev" }
@@ -213,6 +214,7 @@ typst-ts-pdf-exporter = { path = "exporter/pdf" }
 typst-ts-raster-exporter = { path = "exporter/raster" }
 typst-ts-serde-exporter = { path = "exporter/serde" }
 typst-ts-svg-exporter = { path = "exporter/svg" }
+typst-ts-text-exporter = { path = "exporter/text" }
 
 # typst = { git = "https://github.com/Myriad-Dreamin/typst.git", branch = "typst.ts-v0.9.0" }
 # typst-library = { git = "https://github.com/Myriad-Dreamin/typst.git", branch = "typst.ts-v0.9.0" }

cli/Cargo.toml

@@ -51,6 +51,7 @@ typst-ts-pdf-exporter = { workspace = true, optional = true }
 typst-ts-raster-exporter = { workspace = true, optional = true }
 typst-ts-serde-exporter = { workspace = true, optional = true }
 typst-ts-svg-exporter = { workspace = true, optional = true }
+typst-ts-text-exporter = { workspace = true, optional = true }
 
 [build-dependencies]
 anyhow.workspace = true
@@ -70,12 +71,14 @@ svg = [
     "typst-ts-svg-exporter",
     "typst-ts-svg-exporter/experimental-ligature",
 ]
+text = ["typst-ts-text-exporter"]
 default = [
     "pdf",
     "raster",
     "serde-json",
     "serde-rmp",
     "svg",
+    "text",
     "gen-manual",
     "embedded-fonts",
     "embedded-cjk-fonts",

cli/src/export.rs

@@ -20,6 +20,7 @@ pub static AVAILABLE_FORMATS: &[(/* format name */ &str, /* feature hint */ &str
     ("svg_html", "svg"),
     ("sir", "svg"),
     ("vector", "svg"),
+    ("text", "text"),
 ];
 
 /// Hint the user that the given format is not enable or not available.
@@ -93,6 +94,8 @@ fn prepare_exporters_impl(out: PathBuf, mut formats: Vec<String>) -> GroupDocExp
             "sir"         => sink_path!(WithSIR as _ as doc, out @@ "artifact.sir.in"),
             #[cfg(feature = "svg")]
             "vector"      => sink_path!(WithSIR as _ as doc, out @@ "artifact.sir.in"),
+            #[cfg(feature = "text")]
+            "text"      => sink_path!(WithText as _ as doc, out @@ "txt"),
             _             => exit_by_unknown_format(f),
         });
     }
@@ -107,6 +110,7 @@ fn prepare_exporters_impl(out: PathBuf, mut formats: Vec<String>) -> GroupDocExp
     type WithSvg = typst_ts_svg_exporter::PureSvgExporter;
     type WithSvgHtml = typst_ts_svg_exporter::SvgExporter<DefaultExportFeature>;
     type WithSIR = typst_ts_svg_exporter::SvgModuleExporter;
+    type WithText = typst_ts_text_exporter::TextExporter;
 
     type ExporterVec<T> = Vec<Box<dyn typst_ts_core::Exporter<T> + Send>>;
 }

exporter/text/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "typst-ts-text-exporter"
+description = "Export a frame of Typst document into plain text."
+version.workspace = true
+license.workspace = true
+edition.workspace = true
+homepage.workspace = true
+repository.workspace = true
+
+[dependencies]
+typst.workspace = true
+typst-ts-core.workspace = true
+
+[features]

exporter/text/README.md

@@ -0,0 +1,3 @@
+# typst-ts-text-exporter
+
+See [Typst.ts](https://github.com/Myriad-Dreamin/typst.ts)

exporter/text/src/lib.rs

@@ -0,0 +1,2 @@
+pub(crate) mod text;
+pub use text::TextExporter;

exporter/text/src/text.rs

@@ -0,0 +1,62 @@
+use core::fmt;
+use std::io::Write;
+use std::sync::Arc;
+
+use typst_ts_core::exporter_utils::map_err;
+use typst_ts_core::{Transformer, TypstDocument};
+
+#[derive(Debug, Clone, Default)]
+pub struct TextExporter {}
+
+impl<W> Transformer<(Arc<TypstDocument>, W)> for TextExporter
+where
+    W: std::io::Write,
+{
+    fn export(
+        &self,
+        _world: &dyn typst::World,
+        (output, writer): (Arc<TypstDocument>, W),
+    ) -> typst::diag::SourceResult<()> {
+        let mut w = std::io::BufWriter::new(writer);
+
+        write!(w, "{}", FullTextDigest(output)).map_err(map_err)?;
+
+        w.flush().unwrap();
+        Ok(())
+    }
+}
+
+struct FullTextDigest(Arc<TypstDocument>);
+
+impl FullTextDigest {
+    fn export_frame(f: &mut fmt::Formatter<'_>, doc: &typst::doc::Frame) -> fmt::Result {
+        for (_, item) in doc.items() {
+            Self::export_item(f, item)?;
+        }
+
+        Ok(())
+    }
+
+    fn export_item(f: &mut fmt::Formatter<'_>, item: &typst::doc::FrameItem) -> fmt::Result {
+        use std::fmt::Write;
+        use typst::doc::FrameItem::*;
+        use typst::doc::Meta::*;
+        match item {
+            Group(g) => Self::export_frame(f, &g.frame),
+            Text(t) => f.write_str(t.text.as_str()),
+            Meta(ContentHint(c), _) => f.write_char(*c),
+            Meta(Link(..) | Elem(..) | PageNumbering(..) | PdfPageLabel(..) | Hide, _)
+            | Shape(..)
+            | Image(..) => Ok(()),
+        }
+    }
+}
+
+impl fmt::Display for FullTextDigest {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        for frame in self.0.pages.iter() {
+            Self::export_frame(f, &frame)?;
+        }
+        Ok(())
+    }
+}