HTML reports & new shaping glue crate

.github/workflows/docs.yml

@@ -0,0 +1,42 @@
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+name: Generate docs
+
+# Make sure CI fails on all warnings, and pretend we're docs.rs
+env:
+  RUSTFLAGS: "-Dwarnings -Adead-code -Aunused-imports -Aunused-macros"
+  # FIXME: in future, use the below to better match docs.rs. At the time of
+  #        writing (2025/10/30), a very common documentation-related nightly
+  #        feature attribute (doc_auto_cfg) has been renamed (to doc_cfg) which
+  #        is resulting in the pipeline failing due to transient dependencies
+  #        using the removed feature (even though I specify --no-deps). Not
+  #        fully matching docs.rs also causes some warnings to get emitted
+  #        while building SLWL, so allow those for now.
+  # RUSTFLAGS: "-Dwarnings --cfg docsrs"
+
+jobs:
+  generate-docs:
+    name: ${{ matrix.crate }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        crate:
+          - fontheight
+          - harfshapedfa
+          - static-lang-word-lists
+    steps:
+      # docs.rs uses nightly rust
+      - name: Setup nightly Rust
+        uses: dtolnay/rust-toolchain@nightly
+      - name: Checkout ${{ github.head_ref || github.ref_name }}
+        uses: actions/checkout@v4
+      - name: Document
+        shell: bash
+        run: cargo +nightly doc --all-features --no-deps --package ${{ matrix.crate }}
+      # TODO: could we deploy this to GitHub pages somehow?
+      #       https://github.com/actions/upload-pages-artifact
+      #       https://github.com/actions/deploy-pages

Cargo.toml

@@ -2,14 +2,20 @@
 resolver = "2"
 members = [
     "cli",
-    "core",
+    "core", "harfshapedfa",
     "static-lang-word-lists",
     "xtask",
 ]
 
 [workspace.dependencies]
+# Note: make sure harfrust's read-fonts matches skrifa's read-fonts
+harfrust = "=0.3.2"
+harfshapedfa = { version = "0.1.0", path = "harfshapedfa", features = ["pens"] }
 log = "0.4.25"
+ordered-float = "5"
 rayon = "1.10"
+# Note: make sure skrifa's read-fonts matches harfrust's read-fonts
+skrifa = "=0.37.0"
 thiserror = "2"
 
 [profile.release]

README.md

@@ -55,6 +55,8 @@ Options:
   -k, --words <WORDS_PER_LIST>  The number of words from each list to test [default: all words]
   -v, --verbose...              Increase logging verbosity
   -q, --quiet...                Decrease logging verbosity
+  -o, --output <OUTPUT_PATH>    Write the reports into the given path. Will print to stdout if not specified
+      --html                    Output all the reports into a single HTML file
   -h, --help                    Print help
   -V, --version                 Print version
 ```

cli/CHANGELOG.md

@@ -1,10 +1,17 @@
 # `fontheight` CLI
 
-## Unreleased
+## v0.1.1
+
+### Added
+
+- LibreOffice word lists
+- HTML reporter, use `--html` to receive a visual report of the exemplar words against various metric lines
+- `-o/--output` flag, to have `fontheight` write into a file
 
 ### Changes
 
 - Update word lists
+- Sort exemplars lexicographically if their vertical extents match
 
 ## v0.1.0 - 2025/09/12
 

cli/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "fontheight-cli"
 description = "Find out the vertical extents your font reaches on shaped words"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2024"
 authors = [
     "Dalton Maag <sd@daltonmaag.com>",
@@ -19,9 +19,15 @@ path = "src/main.rs"
 [dependencies]
 anyhow = "1"
 clap-verbosity-flag = { version = "3", features = ["log"] }
-fontheight = { version = "0.1.5", path = "../core" }
-log = { workspace = true }
-rayon = { workspace = true }
+fontheight = { version = "0.2", path = "../core" }
+harfrust.workspace = true
+harfshapedfa.workspace = true
+log.workspace = true
+maud = "0.27.0"
+ordered-float.workspace = true
+rayon.workspace = true
+skrifa.workspace = true
+svg = "0.18"
 
 [dependencies.static-lang-word-lists]
 version = "0.4"