VectorCraft: An open-source, vector art tool written by scratch in pure Rust
Export for Screens: Export PDFs As Single file writes the artboards as one PDF's pages
bflatasticb8e5f7088f06
diff --git a/crates/engine/src/cmd/fileio/commands.rs b/crates/engine/src/cmd/fileio/commands.rsindex 0c38079df..abd6857ad 100644--- a/crates/engine/src/cmd/fileio/commands.rs+++ b/crates/engine/src/cmd/fileio/commands.rs@@ -54,7 +54,7 @@ pub fn specs() -> Vec<CommandSpec> {"Export for Screens",["File", "Export"],None,- "{folder?, zip?: false (one .zip of every file, each deflated or stored, whichever is smaller: no folder → {name, dataBase64, bytes, files: [name…]}; with a folder it is written there → {path, bytes, files}), artboards?: [index…] | range?: \"1-3\" (default all), assets?: [asset id…] (instead of artboards: each asset's art alone, cropped to its bounds and named after the asset; see assets.list), layers?: [layer id…] (instead of artboards: each layer's art alone, sublayers included, named after the layer), selection?: one|each (instead of artboards: the selected art as one file, or a file per selected object, named after it), fullDocument?: false (one file per format instead: a PDF of every artboard, other formats the bounds of all visible art, named after the document), includeBleed?: false (artboards grown by the document's bleed), exportPreset?: (a preset of document.exportPresets.list: its settings, under these params), subfolders?: false (each row's files in a sub-folder: its folder, else its size for raster (1x, 2x, 100w…) or its format (SVG, PDF)), folders?: none|rows (as subfolders)|format (a folder per extension: png, svg, pdf…)|item (a folder per artboard, asset, layer or object)|itemFormat (item/extension) (default: rows with subfolders or a preset, else none), name?: (a file name pattern instead of the item's name, with <filename> for the document, <name> for the artboard, asset, layer or object, <index> from 1, #### for the counter zero-padded to the run of #, <format>, <scale>, <suffix> (else the row's suffix ends the name), YYYYMMDD, YYYY-MM-DD, YYYY, <date>, <time>, <YYYY>, <MM>, <DD>, <hh>, <mm> and <ss>; a trailing .ext is dropped, as in `COMPANY-Logo-<filename>-####-YYYYMMDD`; different files it names alike get -2, -3…), counterStart?: 1, counterPer?: item (every file of an item has its number)|file, date?: YYYY-MM-DD (the date the pattern uses; default today, UTC), preset?: mobile (PNG 1x, 2x, 3x) | density (PNG 0.75x–4x in ldpi…xxxhdpi sub-folders) instead of formats (turns subfolders on), formats?: [{format: png|png8|jpg|webp|gif|tiff|bmp|tga|psd|svg|svgz|pdf|eps|ai|vectorcraft, scale?: 1 | \"2x\" | \"100w\" | \"100h\" | \"72ppi\", width?: px | height?: px | ppi? (raster only; width, then height, then ppi win over scale), suffix?: (raster default: @2x, @100w, @100h, none at 1x; vector formats drop size suffixes), folder?: (its sub-folder), quality?: (jpg 0–100), …the format's options (antiAlias, background, preset (pdf)…)}], settings?: {png|png8|jpg|webp|gif|tiff|bmp|tga|psd|svg|svgz|pdf|eps|ai|vectorcraft: {…options for every row of that format}} (rows' own options win), prefix?, antiAlias?: none|art|type (raster rows without their own), openLocation?: (remembered; the app shows the files after exporting)} one file per artboard and format (a PDF holds its artboard alone; artboards with the same name, in any case, get -2, -3…; an unnamed one is Artboard-N) → {files: [path…]}; no folder → {files: [{name, dataBase64}]} (names include sub-folders: 2x/[email protected]); every reply has warnings: [the encoders' warnings for the files, each once: an image that couldn't be decoded, type written in the fallback font…]. eps, ai and vectorcraft rows write a document of the item alone (its one artboard). The params (but zip and assets) are remembered in the document (document.exportSettings; not an undo step)",+ "{folder?, zip?: false (one .zip of every file, each deflated or stored, whichever is smaller: no folder → {name, dataBase64, bytes, files: [name…]}; with a folder it is written there → {path, bytes, files}), artboards?: [index…] | range?: \"1-3\" (default all), assets?: [asset id…] (instead of artboards: each asset's art alone, cropped to its bounds and named after the asset; see assets.list), layers?: [layer id…] (instead of artboards: each layer's art alone, sublayers included, named after the layer), selection?: one|each (instead of artboards: the selected art as one file, or a file per selected object, named after it), fullDocument?: false (one file per format instead: a PDF of every artboard, other formats the bounds of all visible art, named after the document), includeBleed?: false (artboards grown by the document's bleed), pdfs?: multiple|single (Export PDFs As: with several artboards, single writes them as the pages of one PDF per PDF row, named after the document), exportPreset?: (a preset of document.exportPresets.list: its settings, under these params), subfolders?: false (each row's files in a sub-folder: its folder, else its size for raster (1x, 2x, 100w…) or its format (SVG, PDF)), folders?: none|rows (as subfolders)|format (a folder per extension: png, svg, pdf…)|item (a folder per artboard, asset, layer or object)|itemFormat (item/extension) (default: rows with subfolders or a preset, else none), name?: (a file name pattern instead of the item's name, with <filename> for the document, <name> for the artboard, asset, layer or object, <index> from 1, #### for the counter zero-padded to the run of #, <format>, <scale>, <suffix> (else the row's suffix ends the name), YYYYMMDD, YYYY-MM-DD, YYYY, <date>, <time>, <YYYY>, <MM>, <DD>, <hh>, <mm> and <ss>; a trailing .ext is dropped, as in `COMPANY-Logo-<filename>-####-YYYYMMDD`; different files it names alike get -2, -3…), counterStart?: 1, counterPer?: item (every file of an item has its number)|file, date?: YYYY-MM-DD (the date the pattern uses; default today, UTC), preset?: mobile (PNG 1x, 2x, 3x) | density (PNG 0.75x–4x in ldpi…xxxhdpi sub-folders) instead of formats (turns subfolders on), formats?: [{format: png|png8|jpg|webp|gif|tiff|bmp|tga|psd|svg|svgz|pdf|eps|ai|vectorcraft, scale?: 1 | \"2x\" | \"100w\" | \"100h\" | \"72ppi\", width?: px | height?: px | ppi? (raster only; width, then height, then ppi win over scale), suffix?: (raster default: @2x, @100w, @100h, none at 1x; vector formats drop size suffixes), folder?: (its sub-folder), quality?: (jpg 0–100), …the format's options (antiAlias, background, preset (pdf)…)}], settings?: {png|png8|jpg|webp|gif|tiff|bmp|tga|psd|svg|svgz|pdf|eps|ai|vectorcraft: {…options for every row of that format}} (rows' own options win), prefix?, antiAlias?: none|art|type (raster rows without their own), openLocation?: (remembered; the app shows the files after exporting)} one file per artboard and format (a PDF holds its artboard alone; artboards with the same name, in any case, get -2, -3…; an unnamed one is Artboard-N) → {files: [path…]}; no folder → {files: [{name, dataBase64}]} (names include sub-folders: 2x/[email protected]); every reply has warnings: [the encoders' warnings for the files, each once: an image that couldn't be decoded, type written in the fallback font…]. eps, ai and vectorcraft rows write a document of the item alone (its one artboard). The params (but zip and assets) are remembered in the document (document.exportSettings; not an undo step)",has_doc,screens::export_for_screens),diff --git a/crates/engine/src/cmd/fileio/screens.rs b/crates/engine/src/cmd/fileio/screens.rsindex db934aeab..c6ff1e8d6 100644--- a/crates/engine/src/cmd/fileio/screens.rs+++ b/crates/engine/src/cmd/fileio/screens.rs@@ -309,6 +309,9 @@ struct ScreenParams {/// Where files go: `none` (all in the folder), `rows` (the rows' sub-folders, as/// `subfolders`), `format` (a folder per extension), `item`, or `itemFormat`.folders: Option<String>,+ /// Export PDFs As: `single` (the artboards a PDF row writes are the pages of one file) or+ /// `multiple` (a file per artboard, the default).+ pdfs: Option<String>,}/// How exported files are sorted into folders.@@ -389,6 +392,8 @@ struct Naming {/// The counter counts files rather than items.per_file: bool,folders: Folders,+ /// Export PDFs As › Single file.+ single_pdf: bool,}impl Naming {@@ -406,9 +411,14 @@ impl Naming {Some("file") => true,Some(c) => return Err(bad(C, format!("counterPer `{c}`: item or file"))),};+ let single_pdf = match o.pdfs.as_deref() {+ None | Some("multiple") => false,+ Some("single") => true,+ Some(m) => return Err(bad(C, format!("pdfs `{m}`: single or multiple"))),+ };let filename = safe_name(&super::file_stem(title)).unwrap_or_else(|| "Untitled".into());let pattern = o.name.clone().filter(|n| !n.trim().is_empty());- Ok(Self { pattern, prefix, filename, when, counter_start: o.counter_start.unwrap_or(1), per_file, folders })+ Ok(Self { pattern, prefix, filename, when, counter_start: o.counter_start.unwrap_or(1), per_file, folders, single_pdf })}/// The sub-folder (`None` for the export folder itself) and the file name of the file row `r`@@ -781,15 +791,34 @@ fn encode_and_write(export: ScreenExport, writer: &mut dyn FnMut(&str, &[u8]) ->// One step per item and row, the files a name collision skips included.let steps = (items.len() * rows.len()) as u64;let mut step = 0u64;+ // Export PDFs As › Single file: with several artboards, a PDF row writes them all as the pages+ // of one file, named as the document, with the first of them.+ let artboards: Option<Vec<usize>> = items.iter().map(|i| i.artboard).collect::<Option<Vec<_>>>().filter(|a| naming.single_pdf && a.len() > 1);for (index, item) in items.iter().enumerate() {for r in &rows {vectorcraft_doc::cancel::check()?;vectorcraft_doc::cancel::progress(step, steps, &format!("Exporting file {} of {steps}", step + 1));step += 1;- let (sub, file) = naming.file(item, index, files, r);+ let single = artboards.as_ref().filter(|_| r.format.id == "pdf");+ if single.is_some() && index > 0 {+ continue;+ }+ let document = single.map(|_| Item {+ name: naming.filename.clone(),+ stem: naming.filename.clone(),+ doc: item.doc.clone(),+ artboard: None,+ region: item.region,+ every_artboard: None,+ });+ let (sub, file) = naming.file(document.as_ref().unwrap_or(item), index, files, r);let name = sub.map_or_else(|| file.clone(), |d| format!("{d}/{file}"));let Some(name) = out.claim(&name, &format!("{}|{}", item.stem, r.key), o.name.is_some()) else { continue };- let bytes = if let (Some(all), "pdf") = (&item.every_artboard, r.format.id) {+ let bytes = if let Some(boards) = single {+ let mut options = r.options.clone();+ options["range"] = json!(boards.iter().map(|b| (b + 1).to_string()).collect::<Vec<_>>().join(", "));+ write(&item.doc, "pdf", &options)?+ } else if let (Some(all), "pdf") = (&item.every_artboard, r.format.id) {// One page per artboard.let mut options = r.options.clone();options["range"] = json!("all");diff --git a/crates/engine/src/cmd/fileio/tests_screens.rs b/crates/engine/src/cmd/fileio/tests_screens.rsindex 5da4bdf5e..bb4e35625 100644--- a/crates/engine/src/cmd/fileio/tests_screens.rs+++ b/crates/engine/src/cmd/fileio/tests_screens.rs@@ -811,3 +811,25 @@ fn the_document_remembers_its_export_settings() {assert!(!plain.contains("export_settings") && !plain.contains("exportSettings"), "not written when empty");assert!(vectorcraft_format::load(plain.as_bytes()).unwrap().export_settings.is_empty());}++/// Export PDFs As › Single file: with several artboards, a PDF row writes them as the pages of one+/// file named after the document (raster rows still write a file per artboard); with one artboard+/// the PDF is that artboard's, as Multiple files writes it.+#[test]+fn single_file_pdfs_hold_every_chosen_artboard() {+ let mut s = session(3);+ let title = s.doc().unwrap().doc.title.clone();+ let rows = json!([{"format": "png", "scale": "1x"}, {"format": "pdf"}]);+ let r = export(&mut s, json!({"range": "1-2", "pdfs": "single", "formats": rows}));+ let got = files(&r);+ let pdf: Vec<&(String, Vec<u8>)> = got.iter().filter(|(n, _)| n.ends_with(".pdf")).collect();+ assert_eq!(pdf.len(), 1, "{:?}", names(&r));+ assert_eq!(pdf[0].0, format!("{title}.pdf"));+ assert_eq!(vectorcraft_pdf::import(&pdf[0].1).unwrap().artboards.len(), 2, "one page per artboard");+ assert_eq!(got.iter().filter(|(n, _)| n.ends_with(".png")).count(), 2);+ let r = export(&mut s, json!({"range": "2", "pdfs": "single", "formats": [{"format": "pdf"}]}));+ assert_eq!(names(&r), ["Artboard-2.pdf"]);+ let r = export(&mut s, json!({"range": "1-2", "pdfs": "multiple", "formats": [{"format": "pdf"}]}));+ assert_eq!(names(&r), ["Artboard-1.pdf", "Artboard-2.pdf"]);+ assert!(s.execute("document.exportForScreens", &json!({"pdfs": "both", "formats": [{"format": "pdf"}]})).is_err());+}diff --git a/docs/mcp.md b/docs/mcp.mdindex a4756b676..c1568ae63 100644--- a/docs/mcp.md+++ b/docs/mcp.md@@ -3987,8 +3987,9 @@ each file deflated, or stored when deflating does not make it smaller.A row is `{format, scale?}` where `scale` is a factor (`2`, `"2x"`), a pixel width (`"100w"` or `width: 100`), aheight (`"100h"`) or a resolution (`"72ppi"`); raster rows name their files `@2x`, `@100w`… unless `suffix` saysotherwise. `fullDocument` writes one file per row instead (a PDF of every artboard, other formats the bounds of all-art), `includeBleed` grows each artboard by the document's bleed, `subfolders` puts each row's files in a sub-folder-(its size or format, or its own `folder`), `preset: "mobile"` or `"density"` (Android-style ldpi…xxxhdpi+art), `includeBleed` grows each artboard by the document's bleed, `pdfs: "single"` (Export PDFs As › Single file)+writes the artboards a PDF row exports as the pages of one PDF named after the document, `subfolders` puts each+row's files in a sub-folder (its size or format, or its own `folder`; `folders: "format"` sorts by format instead), `preset: "mobile"` or `"density"` (Android-style ldpi…xxxhdpisub-folders) replaces the rows, and `settings: {png: {…}, jpg: {…}, svg: {…}, pdf: {preset}}` gives every row of aformat its options. On every platform, `/`, `\`, `:`, `<`, `>`, `"`, `|`, `?`, `*` and control characters from aprefix, a suffix, a name pattern or an item's name become `-` in file and folder names, a folder name ends without