build: bump shiroa packages to v0.3.1 (Myriad-Dreamin#223)

Myriad-Dreamin · web-flow · commit 39b5ea5e3d7b · 2025-11-27T23:23:34.000+08:00
diff --git a/cli/src/main.rs b/cli/src/main.rs
@@ -118,7 +118,7 @@ async fn init(args: InitArgs) -> Result<()> {
         dir.join("book.typ"),
         format!(
             r##"
-#import "@preview/shiroa:0.3.0": *
+#import "@preview/shiroa:0.3.1": *
 
 #show: book
 
@@ -153,7 +153,7 @@ Sample page
     write_file(
         dir.join("ebook.typ"),
         format!(
-            r##"#import "@preview/shiroa:0.3.0": *
+            r##"#import "@preview/shiroa:0.3.1": *
 
 #import "{ebook_template}"
 
diff --git a/cli/src/project.rs b/cli/src/project.rs
@@ -194,11 +194,11 @@ impl Project {
             }
 
             let InternalPackageMeta::Package { version } = self.query_meta("<shiroa-internal-package-meta>", query)?
-                .context("No package meta. are you using old book package?, please import @preview/shiroa:0.3.0; or do you forget the show rule `#show: book`?")?;
+                .context("No package meta. are you using old book package?, please import @preview/shiroa:0.3.1; or do you forget the show rule `#show: book`?")?;
 
-            if version != "0.3.0" {
+            if version != "0.3.1" {
                 return Err(error_once!(
-                    "outdated book package, please import @preview/shiroa:0.3.0", importing_version: version,
+                    "outdated book package, please import @preview/shiroa:0.3.1", importing_version: version,
                 ));
             }
         }
diff --git a/cli/src/render/typst.rs b/cli/src/render/typst.rs
@@ -21,7 +21,7 @@ use reflexo_typst::{
     config::CompileOpts,
     escape::{escape_str, AttributeEscapes},
     path::{unix_slash, PathClean},
-    static_html,
+    print_diagnostics, static_html,
     system::SystemWorldComputeGraph,
     vector::{
         ir::{LayoutRegionNode, Module, Page, PageMetadata},
@@ -30,9 +30,9 @@ use reflexo_typst::{
     },
     world::{diag::print_diagnostics_to, EntryOpts},
     CompilationTask, CompileSnapshot, DiagnosticFormat, DiagnosticHandler, DynSvgModuleExport,
-    EntryReader, ExportDynSvgModuleTask, FlagTask, ImmutStr, LazyHash, SystemCompilerFeat, TakeAs,
-    TaskInputs, TypstAbs, TypstDict, TypstDocument, TypstHtmlDocument, TypstPagedDocument,
-    TypstSystemWorld,
+    EntryReader, ExportDynSvgModuleTask, FlagTask, ImmutStr, LazyHash, SourceWorld,
+    SystemCompilerFeat, TakeAs, TaskInputs, TypstAbs, TypstDict, TypstDocument, TypstHtmlDocument,
+    TypstPagedDocument, TypstSystemWorld,
 };
 use reflexo_typst::{CompileReport, TypstSystemUniverse};
 use reflexo_vec2svg::{
@@ -229,13 +229,14 @@ impl TypstRenderer {
 
         // todo: review me.
         if !task.ctx.static_html {
-            THEME_LIST
+            let res = THEME_LIST
                 .into_par_iter()
                 .map(|theme| {
                     let mut task = self.spawn_with_theme(path, theme)?;
                     task.compile_paged_page_with(settings.clone())
                 })
-                .collect::<Result<()>>()?;
+                .collect::<Result<()>>();
+            print_diag_or_error(task.world(), res)?;
         }
 
         Ok((task, doc))
@@ -1004,6 +1005,21 @@ fn no_foreign_obj_diag(diag: &&typst::diag::SourceDiagnostic) -> bool {
     !diag.message.contains("image contains foreign object")
 }
 
+fn print_diag_or_error<T>(world: &impl SourceWorld, result: Result<T>) -> Result<T> {
+    match result {
+        Ok(v) => Ok(v),
+        Err(err) => {
+            if let Some(diagnostics) = err.diagnostics() {
+                print_diagnostics(world, diagnostics.iter(), DiagnosticFormat::Human)
+                    .context_ut("print diagnostics")?;
+                bail!("compile failed");
+            }
+
+            Err(err)
+        }
+    }
+}
+
 pub struct HtmlRenderContext<'a> {
     pub search: &'a SearchCtx<'a>,
     pub dest_dir: &'a Path,
diff --git a/contrib/typst/gh-ebook.typ b/contrib/typst/gh-ebook.typ
@@ -1,4 +1,4 @@
-#import "@preview/shiroa:0.3.0": *
+#import "@preview/shiroa:0.3.1": *
 #import "/contrib/typst/gh-pages.typ": part-style, project
 
 #let _page-project = project
diff --git a/contrib/typst/gh-pages.typ b/contrib/typst/gh-pages.typ
@@ -1,6 +1,6 @@
 // This is important for shiroa to produce a responsive layout
 // and multiple targets.
-#import "@preview/shiroa:0.3.0": (
+#import "@preview/shiroa:0.3.1": (
   get-page-width, is-html-target, is-pdf-target, is-web-target, plain-text, shiroa-sys-target, templates,
 )
 #import templates: *
diff --git a/github-pages/docs/book.typ b/github-pages/docs/book.typ
@@ -1,5 +1,5 @@
 
-#import "@preview/shiroa:0.3.0": *
+#import "@preview/shiroa:0.3.1": *
 
 #show: book
 
diff --git a/github-pages/docs/cli/init.typ b/github-pages/docs/cli/init.typ
@@ -44,7 +44,7 @@ your `book.typ` should at least provide a `book-meta`.
 
 #sample-file("/tests/minimal/book.typ")
 
-Your `template.typ` must import and respect the `get-page-width` and `target` variable from `@preview/shiroa:0.3.0` The two variables will be used by the tool for rendering responsive layout and multiple targets.
+Your `template.typ` must import and respect the `get-page-width` and `target` variable from `@preview/shiroa:0.3.1` The two variables will be used by the tool for rendering responsive layout and multiple targets.
 
 #sample-file("/tests/minimal/template.typ")
 
diff --git a/github-pages/docs/format/theme.typ b/github-pages/docs/format/theme.typ
@@ -33,10 +33,10 @@ A target can be suffixed with a theme name to support specialized rendering for
 
 == Respecting `x-target` in your template
 
-To apply set rules for different targets, your `template.typ` can import and respect the `x-target` variable from `@preview/shiroa:0.3.0`. For example, to remove margins for web target, you can do:
+To apply set rules for different targets, your `template.typ` can import and respect the `x-target` variable from `@preview/shiroa:0.3.1`. For example, to remove margins for web target, you can do:
 
 ```typ
-#import "@preview/shiroa:0.3.0": x-target
+#import "@preview/shiroa:0.3.1": x-target
 
 #let project(body) = {
 
@@ -66,7 +66,7 @@ There are samples to create components that utilize metadata from `book.typ`:
 Shiroa will pre-render multiple layouts by setting `sys.page-width` and `sys.x-target` to different values. A template must use `page-width` to adjust the page width to avoid the content being cut off.
 
 ```typ
-#import "@preview/shiroa:0.3.0": page-width, x-target
+#import "@preview/shiroa:0.3.1": page-width, x-target
 
 #let project(body) = {
   // set web/pdf page properties
@@ -80,7 +80,7 @@ Shiroa will pre-render multiple layouts by setting `sys.page-width` and `sys.x-t
 We know shiroa will render a page with `sys.x-target` set to `html-wrapper` and `web` targets, so template must be aware of that. The html file (rendered with `html-wrapper` target) must contain a trampoline to load the svg file (rendered with `web` target). You can either create you owned trampoline or use the `paged-load-trampoline` function provided by shiroa:
 
 ```typ
-#import "@preview/shiroa:0.3.0": paged-load-trampoline, x-target
+#import "@preview/shiroa:0.3.1": paged-load-trampoline, x-target
 #let html-template(trampoline) = html.html(
   html.head(html.title("Page Title")),
   html.body(trampoline),
diff --git a/github-pages/docs/guide/get-started.typ b/github-pages/docs/guide/get-started.typ
@@ -1,5 +1,5 @@
 #import "/github-pages/docs/book.typ": book-page
-#import "@preview/shiroa:0.3.0": shiroa-sys-target
+#import "@preview/shiroa:0.3.1": shiroa-sys-target
 
 #show: book-page.with(title: "Get Started")
 
@@ -46,7 +46,7 @@ Before a chapter can be viewed, it must be added to this list.
 Here's a basic summary file with a few chapters:
 
 ```typ
-#import "@preview/shiroa:0.3.0": *
+#import "@preview/shiroa:0.3.1": *
 #show: book
 
 #book-meta( // put metadata of your book like book.toml of mdbook
diff --git a/github-pages/docs/pdf.typ b/github-pages/docs/pdf.typ
@@ -1,4 +1,4 @@
-#import "@preview/shiroa:0.3.0": *
+#import "@preview/shiroa:0.3.1": *
 
 #import "/contrib/typst/gh-ebook.typ"
 #let ebook = gh-ebook
diff --git a/packages/shiroa-tests/test-plain-text.typ b/packages/shiroa-tests/test-plain-text.typ
@@ -1,4 +1,4 @@
-#import "@preview/shiroa:0.3.0": *
+#import "@preview/shiroa:0.3.1": *
 
 
 #let test-none() = plain-text(none).trim()
diff --git a/packages/shiroa-tests/test-summary.typ b/packages/shiroa-tests/test-summary.typ
@@ -1,4 +1,4 @@
-#import "@preview/shiroa:0.3.0": *
+#import "@preview/shiroa:0.3.1": *
 
 
 #let harness(inp) = book-meta(summary: inp)
diff --git a/packages/shiroa/lib.typ b/packages/shiroa/lib.typ
@@ -1,7 +1,7 @@
 //! The `shiroa` package has three parts.
 //!
 //! 1. Metadata variables and functions.
-//!   - `target`
+//!   - `x-target`
 //!   - `page-width`
 //!   - `is-web-target`
 //!   - `is-html-target`
diff --git a/packages/shiroa/meta-and-state.typ b/packages/shiroa/meta-and-state.typ
@@ -1,5 +1,5 @@
 
-#import "sys.typ": page-width, target, x-current, x-target, x-url-base
+#import "sys.typ": page-width, x-target, x-current, x-target, x-url-base
 
 /// The default page width is A4 paper's width (21cm).
 ///
@@ -14,16 +14,16 @@
 
 /// Whether the current compilation is for _html_
 #let is-html-target(exclude-wrapper: false) = (
-  target.starts-with("html") and (not exclude-wrapper or not x-target.starts-with("html-wrapper"))
+  x-target.starts-with("html") and (not exclude-wrapper or not x-target.starts-with("html-wrapper"))
 )
 /// Whether the current compilation is for _web_
-#let is-web-target() = target.starts-with("web")
+#let is-web-target() = x-target.starts-with("web")
 /// Whether the current compilation is for _pdf_
-#let is-pdf-target() = target.starts-with("pdf")
+#let is-pdf-target() = x-target.starts-with("pdf")
 
 /// Derived book variables from `sys.args`
 #let book-sys = (
-  target: target,
+  target: x-target,
   page-width: page-width,
   sys-is-html-target: ("target" in dictionary(std)),
   is-html-target: is-html-target(),
diff --git a/packages/shiroa/template-theme.typ b/packages/shiroa/template-theme.typ
@@ -1,5 +1,5 @@
 
-#import "sys.typ": target
+#import "sys.typ": x-target
 
 /// Reads a theme from a preset dictionary and returns a structured theme object.
 ///
@@ -8,7 +8,7 @@
 /// - read (function): A function to read theme files.
 /// - target (string): The target platform or style, such as "web-light", "web-dark", or "pdf".
 /// -> dictionary
-#let book-theme-from(preset, xml: xml, read: none, target: target) = {
+#let book-theme-from(preset, xml: xml, read: none, target: x-target) = {
   // todo: move theme style parser to another lib file
   let theme-target = if target.contains("-") {
     target.split("-").at(1)
@@ -74,7 +74,7 @@
 #let theme-box-styles-from(
   preset,
   read: read,
-  target: target,
+  target: x-target,
   light-theme: none,
   dark-theme: none,
 ) = {
diff --git a/packages/shiroa/templates.typ b/packages/shiroa/templates.typ
@@ -25,7 +25,7 @@
   main-size: main-size,
   heading-sizes: heading-sizes,
   list-indent: list-indent,
-  starlight: "@preview/shiroa-starlight:0.3.0",
+  starlight: "@preview/shiroa-starlight:0.3.1",
 ) = {
   assert(themes != none, message: "themes must be set")
   let (
@@ -165,7 +165,7 @@
   web-theme: "starlight",
   code-font: none,
   themes: none,
-  zebraw: "@preview/zebraw:0.6.0",
+  zebraw: "@preview/zebraw:0.6.1",
 ) = {
   import zebraw: zebraw, zebraw-init
 
@@ -208,6 +208,12 @@
   ) = themes
   let theme-box = theme-box.with(themes: themes)
 
+  let zebraw-commons = (
+    inset: (left: 1em, top: 0.375em),
+    lang: false,
+    numbering: false,
+  )
+
   let init-with-theme((code-extra-colors, is-dark)) = if is-dark {
     zebraw-init.with(
       // should vary by theme
@@ -217,20 +223,23 @@
       highlight-color: rgb("#3d59a1"),
       comment-color: rgb("#394b70"),
       lang-color: rgb("#3d59a1"),
-      lang: false,
-      numbering: false,
+      ..zebraw-commons,
     )
   } else {
     zebraw-init.with(
       // should vary by theme
       background-color: if code-extra-colors.bg != none {
         (code-extra-colors.bg, code-extra-colors.bg)
       },
-      lang: false,
-      numbering: false,
+      ..zebraw-commons,
     )
   }
 
+  context if shiroa-sys-target() != "html" {
+    counter("zebraw-html-styles").step()
+    counter("zebraw-html-clipboard").step()
+  }
+
   /// HTML code block supported by zebraw.
   show: init-with-theme(default-theme)
   set raw(tab-size: 114)
@@ -283,8 +292,8 @@
   book-meta: none,
   web-theme: auto,
   extra-assets: (),
-  starlight: "@preview/shiroa-starlight:0.3.0",
-  mdbook: "@preview/shiroa-mdbook:0.3.0",
+  starlight: "@preview/shiroa-starlight:0.3.1",
+  mdbook: "@preview/shiroa-mdbook:0.3.1",
 ) = {
   // Prepares description
   assert(type(description) == str or description == auto, message: "description must be a string or auto")
diff --git a/packages/shiroa/typst.toml b/packages/shiroa/typst.toml
@@ -1,6 +1,6 @@
 [package]
 name = "shiroa"
-version = "0.3.0"
+version = "0.3.1"
 entrypoint = "lib.typ"
 authors = ["Myriad-Dreamin <https://github.com/Myriad-Dreamin>"]
 license = "Apache-2.0"
diff --git a/refs/paged/example-shiroa-docs.hash b/refs/paged/example-shiroa-docs.hash
@@ -1 +1 @@
-siphash128_13:5069fe6e5d35f6216596681f37dc3840
+siphash128_13:97a714c56e43bbb6ab3ac13d8078c9b2
diff --git a/tests/minimal/book.typ b/tests/minimal/book.typ
@@ -1,4 +1,4 @@
-#import "@preview/shiroa:0.3.0": *
+#import "@preview/shiroa:0.3.1": *
 #show: book
 
 #book-meta(
diff --git a/tests/minimal/template.typ b/tests/minimal/template.typ
@@ -1,4 +1,4 @@
-#import "@preview/shiroa:0.3.0": get-page-width, is-html-target, is-pdf-target, is-web-target, templates
+#import "@preview/shiroa:0.3.1": get-page-width, is-html-target, is-pdf-target, is-web-target, templates
 #import templates: *
 
 // Metadata
diff --git a/themes/mdbook/html.typ b/themes/mdbook/html.typ
@@ -1,3 +1,3 @@
-#import "@preview/shiroa:0.3.0": html-support
+#import "@preview/shiroa:0.3.1": html-support
 #import html-support: *
 #import supports-html-internal: *
diff --git a/themes/mdbook/lib.typ b/themes/mdbook/lib.typ
@@ -20,7 +20,7 @@
   social-links: social-links,
   right-group: none,
 ) = {
-  import "@preview/shiroa:0.3.0": get-book-meta, is-html-target, paged-load-trampoline, x-current, x-target, x-url-base
+  import "@preview/shiroa:0.3.1": get-book-meta, is-html-target, paged-load-trampoline, x-current, x-target, x-url-base
   import "mod.typ": inline-assets, replace-raw
   import "html.typ": a, div, meta
   import "icons.typ": builtin-icon
diff --git a/themes/mdbook/mod.typ b/themes/mdbook/mod.typ
@@ -1,7 +1,7 @@
 
 
 #import "html.typ": *
-#import "@preview/shiroa:0.3.0": plain-text, templates
+#import "@preview/shiroa:0.3.1": plain-text, templates
 #import templates: get-label-disambiguator, label-disambiguator, make-unique-label, static-heading-link
 
 #let has-toc = true;
diff --git a/themes/mdbook/page-sidebar.typ b/themes/mdbook/page-sidebar.typ
@@ -1,7 +1,7 @@
 
 #import "mod.typ": *
 #import "icons.typ": builtin-icon
-#import "@preview/shiroa:0.3.0": cross-link-path-label, get-book-meta, x-current, x-url-base
+#import "@preview/shiroa:0.3.1": cross-link-path-label, get-book-meta, x-current, x-url-base
 
 // todo: fold_level
 // let is_expanded =
diff --git a/themes/mdbook/page.typ b/themes/mdbook/page.typ
@@ -1,7 +1,7 @@
 
 #import "mod.typ": *
 #import "icons.typ": builtin-icon
-#import "@preview/shiroa:0.3.0": x-current
+#import "@preview/shiroa:0.3.1": x-current
 
 // ---
 
diff --git a/themes/mdbook/typst.toml b/themes/mdbook/typst.toml
@@ -1,6 +1,6 @@
 [package]
 name = "shiroa-mdbook"
-version = "0.3.0"
+version = "0.3.1"
 entrypoint = "lib.typ"
 authors = ["Myriad-Dreamin <https://github.com/Myriad-Dreamin>"]
 license = "Apache-2.0"
diff --git a/themes/starlight/html.typ b/themes/starlight/html.typ
@@ -1,3 +1,3 @@
-#import "@preview/shiroa:0.3.0": html-support
+#import "@preview/shiroa:0.3.1": html-support
 #import html-support: *
 #import supports-html-internal: *
diff --git a/themes/starlight/lib.typ b/themes/starlight/lib.typ
diff --git a/themes/starlight/mod.typ b/themes/starlight/mod.typ
diff --git a/themes/starlight/page-sidebar.typ b/themes/starlight/page-sidebar.typ
diff --git a/themes/starlight/site-search-results.typ b/themes/starlight/site-search-results.typ
diff --git a/themes/starlight/typst.toml b/themes/starlight/typst.toml

Original file line number	Diff line number	Diff line change
`@@ -194,11 +194,11 @@ impl Project {`
`194`	`194`	`}`
`195`	`195`
`196`	`196`	`let InternalPackageMeta::Package { version } = self.query_meta("<shiroa-internal-package-meta>", query)?`
`197`		- .context("No package meta. are you using old book package?, please import @preview/shiroa:0.3.0; or do you forget the show rule `#show: book`?")?;
	`197`	+ .context("No package meta. are you using old book package?, please import @preview/shiroa:0.3.1; or do you forget the show rule `#show: book`?")?;
`198`	`198`
`199`		`- if version != "0.3.0" {`
	`199`	`+ if version != "0.3.1" {`
`200`	`200`	`return Err(error_once!(`
`201`		`- "outdated book package, please import @preview/shiroa:0.3.0", importing_version: version,`
	`201`	`+ "outdated book package, please import @preview/shiroa:0.3.1", importing_version: version,`
`202`	`202`	`));`
`203`	`203`	`}`
`204`	`204`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-#import "@preview/shiroa:0.3.0": *`
	`1`	`+#import "@preview/shiroa:0.3.1": *`
`2`	`2`	`#import "/contrib/typst/gh-pages.typ": part-style, project`
`3`	`3`
`4`	`4`	`#let _page-project = project`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`// This is important for shiroa to produce a responsive layout`
`2`	`2`	`// and multiple targets.`
`3`		`-#import "@preview/shiroa:0.3.0": (`
	`3`	`+#import "@preview/shiroa:0.3.1": (`
`4`	`4`	`get-page-width, is-html-target, is-pdf-target, is-web-target, plain-text, shiroa-sys-target, templates,`
`5`	`5`	`)`
`6`	`6`	`#import templates: *`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`
`2`		`-#import "@preview/shiroa:0.3.0": *`
	`2`	`+#import "@preview/shiroa:0.3.1": *`
`3`	`3`
`4`	`4`	`#show: book`
`5`	`5`