feat: Optimize reference images

When storing reference images are now optimized by default again which can be
disabled with `--no-optimize-references`.

Closes #72.

Author: tingerrr

Cargo.lock

@@ -36,6 +36,7 @@ insta = "1.39.0"
 ignore = "0.4.22"
 native-tls = "0.2.12"
 once_cell = "1.19.0"
+oxipng = "9.1.3"
 pest_derive = "2.7.10"
 pest = "2.7.10"
 png = "0.17.13"

Cargo.toml

@@ -35,6 +35,7 @@ fontdb.workspace = true
 insta = { workspace = true, features = ["yaml"] }
 native-tls.workspace = true
 once_cell.workspace = true
+oxipng.workspace = true
 rayon.workspace = true
 semver.workspace = true
 serde.workspace = true

crates/typst-test-cli/Cargo.toml

@@ -1,4 +1,5 @@
 use std::io::Write;
+use std::ops::Not;
 
 use color_eyre::eyre;
 use lib::doc::render::ppi_to_ppp;
@@ -8,9 +9,9 @@ use termcolor::Color;
 use typst::diag::Warned;
 use typst_syntax::{FileId, Source, VirtualPath};
 
-use super::{CompileArgs, Context, RenderArgs};
+use super::{CompileArgs, Context, ExportArgs};
 use crate::cli::OperationFailure;
-use crate::ui;
+use crate::{ui, DEFAULT_OPTIMIZE_OPTIONS};
 
 #[derive(clap::Args, Debug, Clone)]
 #[group(id = "add-args")]
@@ -34,7 +35,7 @@ pub struct Args {
     pub compile: CompileArgs,
 
     #[command(flatten)]
-    pub render: RenderArgs,
+    pub export: ExportArgs,
 
     /// The name of the test to add
     pub test: Id,
@@ -72,11 +73,22 @@ pub fn run(ctx: &mut Context, args: &Args) -> eyre::Result<()> {
             } = Document::compile(
                 Source::new(FileId::new_fake(VirtualPath::new("")), template.to_owned()),
                 &world,
-                ppi_to_ppp(args.render.pixel_per_inch),
+                ppi_to_ppp(args.export.render.pixel_per_inch),
             );
             let doc = output?;
 
-            Test::create(paths, id, template, Some(Reference::Persistent(doc)))?;
+            Test::create(
+                paths,
+                id,
+                template,
+                Some(Reference::Persistent(
+                    doc,
+                    args.export
+                        .no_optimize_references
+                        .not()
+                        .then(|| Box::new(DEFAULT_OPTIMIZE_OPTIONS.clone())),
+                )),
+            )?;
         };
     } else {
         Test::create_default(paths, id)?;

crates/typst-test-cli/src/cli/add.rs

@@ -392,9 +392,13 @@ pub struct ExportArgs {
     #[command(flatten)]
     pub render: RenderArgs,
 
-    /// Whether to save temporary output, such as ephemeral references
+    /// Whether to skip saving temporary output, such as ephemeral references
     #[arg(long, global = true)]
     pub no_save_temporary: bool,
+
+    /// Whether to skip optimizing reference images
+    #[arg(long, global = true)]
+    pub no_optimize_references: bool,
 }
 
 #[derive(clap::Args, Debug, Clone)]

crates/typst-test-cli/src/cli/mod.rs

@@ -60,6 +60,7 @@ pub fn run(ctx: &mut Context, args: &Args) -> eyre::Result<()> {
         &world,
         RunnerConfig {
             promote_warnings: args.compile.promote_warnings,
+            optimize: !args.export.no_optimize_references,
             fail_fast: !args.run.no_fail_fast,
             pixel_per_pt: render::ppi_to_ppp(args.export.render.pixel_per_inch),
             action: Action::Run {

crates/typst-test-cli/src/cli/run.rs

@@ -40,6 +40,7 @@ pub fn run(ctx: &mut Context, args: &Args) -> eyre::Result<()> {
         &world,
         RunnerConfig {
             promote_warnings: args.compile.promote_warnings,
+            optimize: !args.export.no_optimize_references,
             fail_fast: !args.run.no_fail_fast,
             pixel_per_pt: render::ppi_to_ppp(args.export.render.pixel_per_inch),
             action: Action::Update {
@@ -66,13 +67,6 @@ pub fn run(ctx: &mut Context, args: &Args) -> eyre::Result<()> {
     );
     let result = runner.run(&reporter)?;
 
-    if project.vcs().is_some() {
-        ctx.ui.warning_hinted(
-            "Updated references are not compressed, but persisted in a repository",
-            "Consider using a program like `oxipng` to reduce repository bloat",
-        )?;
-    }
-
     if !result.is_complete_pass() {
         eyre::bail!(TestFailure);
     }

crates/typst-test-cli/src/cli/update.rs

@@ -8,6 +8,7 @@ use clap::Parser;
 use cli::Context;
 use color_eyre::eyre;
 use lib::config::{Config, ConfigLayer};
+use once_cell::sync::Lazy;
 use termcolor::{StandardStream, WriteColor};
 use tracing::level_filters::LevelFilter;
 use tracing_subscriber::filter::Targets;
@@ -26,6 +27,10 @@ mod runner;
 mod ui;
 mod world;
 
+/// The default optimization options to use.
+pub static DEFAULT_OPTIMIZE_OPTIONS: Lazy<oxipng::Options> =
+    Lazy::new(oxipng::Options::max_compression);
+
 fn main() -> ExitCode {
     match main_impl() {
         Ok(code) => code,