bring various settings up-to-date with the template, especially with tytanic and tidy 0.4

Author: SillyFreak

.github/workflows/tests.yml

@@ -10,11 +10,13 @@ jobs:
     strategy:
       matrix:
         # add any other Typst versions that your package should support
-        typst-version: ["0.11", "0.12"]
+        typst-version:
+          - typst: 0.12
+            tytanic: 0.1
         # the docs don't need to build with all versions supported by the package;
         # the latest one is enough
         include:
-          - typst-version: "0.12"
+          - typst-version: {typst: 0.12, tytanic: 0.1}
             doc: 1
     runs-on: ubuntu-latest
     steps:
@@ -24,43 +26,37 @@ jobs:
       - name: Probe runner package cache
         uses: awalsh128/cache-apt-pkgs-action@v1
         with:
-          packages: imagemagick cargo
+          packages: cargo
           version: 1.0
 
-      - name: Install oxipng from crates.io
-        uses: baptiste0928/cargo-install@v3
-        with:
-          crate: oxipng
-
       - name: Install just from crates.io
         uses: baptiste0928/cargo-install@v3
         with:
           crate: just
 
-      - name: Install typst-test from github
+      - name: Install tytanic from crates.io
         uses: baptiste0928/cargo-install@v3
         with:
-          crate: typst-test
-          git: https://github.com/tingerrr/typst-test.git
-          tag: ci-semi-stable
+          crate: tytanic
+          version: ${{ matrix.typst-version.tytanic }}
 
       - name: Setup typst
         id: setup-typst
         uses: typst-community/setup-typst@v3
         with:
-          typst-version: ${{ matrix.typst-version }}
+          typst-version: ${{ matrix.typst-version.typst }}
 
       - name: Install package locally
         run: just install-preview
 
       - name: Run test suite
         run: just test
 
-      - name: Archive diffs
+      - name: Archive test results
         uses: actions/upload-artifact@v4
         if: always()
         with:
-          name: typst-${{ steps.setup-typst.outputs.typst-version }}-diffs
+          name: typst-${{ steps.setup-typst.outputs.typst-version }}-test-results
           path: |
             tests/**/diff/*.png
             tests/**/out/*.png

CHANGELOG.md

@@ -1,26 +1,44 @@
-# [unreleased](https://github.com/SillyFreak/typst-scrutinize/releases/tag/)
-## Added
+# Changelog
 
-## Removed
+All notable changes to this project will be documented in this file.
 
-## Changed
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## Migration Guide from v0.1.X
+## [Unreleased]
 
----
+<details>
+<summary>Migration guide from v0.1.x</summary>
+
+<!-- Write migration guide here -->
+
+</details>
+
+### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### Security
+
+## [0.3.0] - 2024-10-12
 
-# [v0.3.0](https://github.com/SillyFreak/typst-scrutinize/releases/tag/v0.3.0)
 Scrutinize 0.3.0 is a major breaking release and adds compatiblitity checks for Typst 0.12 compatibility (this version was released when 0.12.0-rc1 was available).
 
-## Added
+### Added
 - the README now contains images of an example exam
 - the task kinds `free-form.lines()`, `free-form.grid()` and `gap.gap()` were added
 - `free-form` and `gap` tasks have additional configuration options:
   - `stretch` resizes the response space relative to the size of the sample solution
   - `placeholder` adds content to show in the answer space in the unsolved exam. This is useful for tasks where something existing needs to be completed.
 - tasks can now be fetched in a "scope" of the document, allowing e.g. multiple independent exams
 
-## Changed
+### Changed
 - the module stucture was changed
   - the `question` module was renamed to `task` to be shorter and more general
   - `questions` was renamed to `task-kinds` to match, and to be more descriptive
@@ -29,18 +47,22 @@ Scrutinize 0.3.0 is a major breaking release and adds compatiblitity checks for
 - the `q()` function (now `t()`) does not wrap a whole task but instead attaches to the preceding heading
 - tasks can now have subtasks, by using nested headings
 
----
+## [0.2.0] - 2024-03-16
 
-# [v0.2.0](https://github.com/SillyFreak/typst-scrutinize/releases/tag/v0.2.0)
 Scrutinize 0.2.0 updates it to Typst 0.11.0, using context to simplify the API and --input to more easily specify if a sample solution is to be generated. Some documentation and metadata errors in the 0.1.0 submission were also corrected.
 
-## Added
+### Added
 - specify solution state via `--input solution=true`
 
-## Changed
+### Changed
 - functions that formerly took callback parameters to give access to state now depend on context being provided and simply return a value
 
----
+## [0.1.0] - 2024-01-07
 
-# [v0.1.0](https://github.com/SillyFreak/typst-scrutinize/releases/tag/v0.1.0)
 Initial Release
+
+
+[Unreleased]: https://github.com/SillyFreak/typst-scrutinize/compare/v0.3.0...HEAD
+[0.3.0]: https://github.com/SillyFreak/typst-scrutinize/releases/tag/v0.3.0
+[0.2.0]: https://github.com/SillyFreak/typst-scrutinize/releases/tag/v0.2.0
+[0.1.0]: https://github.com/SillyFreak/typst-scrutinize/releases/tag/v0.1.0

Justfile

@@ -4,32 +4,28 @@ export TYPST_ROOT := root
 
 [private]
 default:
-	@just --list --unsorted
+  @just --list --unsorted
 
 # generate manual
 doc:
-	typst compile docs/manual.typ docs/manual.pdf
-	for f in $(find gallery -maxdepth 1 -name '*.typ'); do \
-		f="$(dirname "$f")/$(basename "$f" .typ)"; \
-		typst compile "$f.typ"; \
-		typst compile "$f.typ" "$f-solved.pdf" --input solution=true; \
-	done
-
-	mkdir -p tmp
-	typst compile --ppi 250 "gallery/example.typ" "tmp/example{n}.png"
-	typst compile --ppi 250 "gallery/example.typ" "tmp/example-solved{n}.png" --input solution=true
-	mv tmp/example1.png thumbnail.png
-	mv tmp/example-solved1.png thumbnail-solved.png
-	rm tmp/example*.png
-	rmdir tmp
+  typst compile docs/manual.typ docs/manual.pdf
+  typst compile --pages 1 gallery/example.typ thumbnail-light.svg
+  typst compile --pages 1 --input theme=dark gallery/example.typ thumbnail-dark.svg
+  typst compile --pages 1 --input solution=true gallery/example.typ thumbnail-light-solved.svg
+  typst compile --pages 1 --input solution=true --input theme=dark gallery/example.typ thumbnail-dark-solved.svg
+  for f in $(find gallery -maxdepth 1 -name '*.typ'); do \
+    f="$(dirname "$f")/$(basename "$f" .typ)"; \
+    typst compile "$f.typ"; \
+    typst compile "$f.typ" "$f-solved.pdf" --input solution=true; \
+  done
 
 # run test suite
 test *args:
-	typst-test run {{ args }}
+  tt run {{ args }}
 
 # update test cases
 update *args:
-	typst-test update {{ args }}
+  tt update {{ args }}
 
 # package the library into the specified destination folder
 package target:

README.md

@@ -17,13 +17,19 @@ See the [manual](docs/manual.pdf) for details.
 <table>
 <tr>
   <td>
-    <a href="gallery/gk-ek-austria.typ">
-      <img src="thumbnail.png">
+    <a href="gallery/example.typ">
+      <picture>
+        <source media="(prefers-color-scheme: dark)" srcset="./thumbnail-dark.svg">
+        <img src="./thumbnail-light.svg">
+      </picture>
     </a>
   </td>
   <td>
-    <a href="gallery/gk-ek-austria.typ">
-      <img src="thumbnail-solved.png">
+    <a href="gallery/example.typ">
+      <picture>
+        <source media="(prefers-color-scheme: dark)" srcset="./thumbnail-dark-solved.svg">
+        <img src="./thumbnail-light-solved.svg">
+      </picture>
     </a>
   </td>
 </tr>

docs/man-style.typ

@@ -1,8 +1,5 @@
 // adapted from https://github.com/Mc-Zen/tidy/blob/v0.3.0/src/styles/minimal.typ
 
-#import "@preview/tidy:0.3.0"
-#import tidy.utilities: *
-
 // ==== internal utilities
 
 #let mono = text.with(font: "DejaVu Sans Mono", size: 0.85em, weight: 340)
@@ -55,15 +52,15 @@
 }
 
 #let preview-block(no-codly: true, ..args) = {
-    import "@preview/codly:1.0.0"
+  import "template.typ": codly
 
-    show: if no-codly { codly.no-codly } else { it => it }
-    block(
-      stroke: 0.5pt + luma(200),
-      radius: preview-radius,
-      ..args
-    )
-  }
+  show: if no-codly { codly.no-codly } else { it => it }
+  block(
+    stroke: 0.5pt + luma(200),
+    radius: preview-radius,
+    ..args
+  )
+}
 
 // ==== functions required from styles
 
@@ -85,15 +82,17 @@
   grid(
     columns: (1fr,) * 3,
     column-gutter: 0.5em,
-    ..entries.chunks(calc.ceil(entries.len() / 3)).map(entries => {
-      block(
-        fill: gray.lighten(80%),
-        width: 100%,
-        inset: (y: 0.6em),
-        radius: radius,
-        list(..entries)
-      )
-    }),
+    ..if entries.len() != 0 {
+      entries.chunks(calc.ceil(entries.len() / 3)).map(entries => {
+        block(
+          fill: gray.lighten(80%),
+          width: 100%,
+          inset: (y: 0.6em),
+          radius: radius,
+          list(..entries)
+        )
+      })
+    },
   )
 }
 
@@ -107,6 +106,9 @@
 #let show-function(
   fn, style-args,
 ) = {
+  import "template.typ": tidy
+  import tidy.utilities: *
+
   block(breakable: style-args.break-param-descriptions, {
     let parameter-list = (style-args.style.show-parameter-list)(fn, style-args)
     let lbl = if style-args.enable-cross-references {
@@ -187,6 +189,9 @@
 #let show-variable(
   var, style-args,
 ) = {
+  import "template.typ": tidy
+  import tidy.utilities: *
+
   signature-block(breakable: style-args.break-param-descriptions, {
     let var-signature = mono-fn(
       var.name,
@@ -208,7 +213,7 @@
 /// Takes given code and both shows it and previews the result of its evaluation.
 ///
 /// The code is by default shown in the language mode `lang: typc` (typst code)
-/// if no language has been specified. Code in typst markup lanugage (`lang: typ`)
+/// if no language has been specified. Code in typst markup language (`lang: typ`)
 /// is automatically evaluated in markup mode.
 ///
 /// - code (raw): Raw object holding the example code.

docs/manual.pdf

@@ -1,6 +1,8 @@
 #import "template.typ" as template: *
 #import "/src/lib.typ": grading, task, solution, task-kinds
 
+#import "@preview/crudo:0.1.1"
+
 #let package-meta = toml("/typst.toml").package
 #let date = datetime(year: 2024, month: 10, day: 12)
 

docs/manual.typ

@@ -1,9 +1,8 @@
 // adapted from https://github.com/Mc-Zen/tidy/blob/98612b847da41ffb0d1dc26fa250df5c17d50054/docs/template.typ
 // licensed under the MIT license
 
-#import "@preview/tidy:0.3.0"
-#import "@preview/codly:1.0.0"
-#import "@preview/crudo:0.1.1"
+#import "@preview/tidy:0.4.1"
+#import "@preview/codly:1.2.0"
 
 #import "man-style.typ"
 
@@ -92,6 +91,7 @@
   show: codly.codly-init
   show raw.where(block: true): set text(size: .9em)
   show raw.where(block: true): pad.with(x: 4%)
+  codly.codly(fill: white)
 
   body
 }
@@ -145,7 +145,7 @@
     block(align(right, text(raw(filename))), width: 100%, inset: 5pt)
     v(1pt, weak: true)
     move(dx: -1pt, line(length: 100% + 2pt, stroke: 1pt + rgb("#239DAE")))
-        v(1pt, weak: true)
+    v(1pt, weak: true)
     pad(x: -4.3%, code)
   }
 ))
@@ -163,7 +163,7 @@
         inset: 20pt,
       )
       show: align.with(left)
-    block(breakable: false, body)
+      block(breakable: false, body)
     }
   )
 }