wip: 2024 edition

book.toml

@@ -21,6 +21,7 @@ edit-url-template = "https://github.com/KaiserY/trpl-zh-cn/edit/main/{path}"
 [output.typst-pdf]
 pdf = true
 section-number = true
+rust-book = true
 
 [rust]
 edition = "2021"

ferris.css

@@ -43,3 +43,25 @@ body.ayu .not_desired_behavior {
 .ferris-explain {
   width: 100px;
 }
+
+/*
+  A bit of a hack to make small Ferris use the existing buttons container but
+  only show/hide the buttons on hover over the `pre`. Targeting `.listing`
+  increases the specificity of this rule.
+*/
+pre > .buttons {
+  visibility: visible;
+  opacity: 1;
+  transition: none;
+}
+
+pre > .buttons button {
+  visibility: hidden;
+  opacity: 0;
+  transition: visibility 0.1s linear, opacity 0.1s linear;
+}
+
+pre:hover > .buttons button {
+  visibility: visible;
+  opacity: 1;
+}

ferris.js

@@ -1,65 +1,102 @@
-var ferrisTypes = [
+// @ts-check
+
+/**
+ * @typedef {{ attr: string, title: string }} FerrisType
+ */
+
+/** @type {Array<FerrisType>} */
+const FERRIS_TYPES = [
   {
-    attr: 'does_not_compile',
+    attr: "does_not_compile",
-    title: '这段代码无法通过编译！'
+    title: "This code does not compile!",
   },
   {
-    attr: 'panics',
+    attr: "panics",
-    title: '这段代码会 Panic！'
+    title: "This code panics!",
   },
   {
-    attr: 'not_desired_behavior',
+    attr: "not_desired_behavior",
-    title: '这段代码的运行结果不符合预期。'
+    title: "This code does not produce the desired behavior.",
-  }
+  },
-]
+];
 
-document.addEventListener('DOMContentLoaded', () => {
+document.addEventListener("DOMContentLoaded", () => {
-  for (var ferrisType of ferrisTypes) {
+  for (let ferrisType of FERRIS_TYPES) {
-    attachFerrises(ferrisType)
+    attachFerrises(ferrisType);
   }
-})
+});
 
+/**
+ * @param {FerrisType} type
+ */
 function attachFerrises(type) {
-  var elements = document.getElementsByClassName(type.attr)
+  let elements = document.getElementsByClassName(type.attr);
+
+  for (let codeBlock of elements) {
+    // Skip SVG etc.: in principle, these should never be attached to those, but
+    // this means if someone happens to have a browser extension which *is*
+    // attaching them, it will not break the code.
+    if (!(codeBlock instanceof HTMLElement)) {
+      continue;
+    }
+
+    let codeLines = codeBlock.innerText;
+    let extra = codeLines.endsWith("\n") ? 1 : 0;
+    let numLines = codeLines.split("\n").length - extra;
+
+    /** @type {'small' | 'large'} */
+    let size = numLines < 4 ? "small" : "large";
 
-  for (var codeBlock of elements) {
+    let container = prepareFerrisContainer(codeBlock, size == "small");
-    var lines = codeBlock.innerText.replace(/\n$/, '').split(/\n/).length
+    if (!container) {
-    var size = 'large'
+      continue;
-    if (lines < 4) {
-      size = 'small'
     }
 
-    var container = prepareFerrisContainer(codeBlock, size == 'small')
+    container.appendChild(createFerris(type, size));
-    container.appendChild(createFerris(type, size))
   }
 }
 
+/**
+ * @param {HTMLElement} element - Code block element to attach a Ferris to.
+ * @param {boolean} useButtons - Whether to attach to existing buttons.
+ * @returns {Element | null} - The container element to use.
+ */
 function prepareFerrisContainer(element, useButtons) {
-  var foundButtons = element.parentElement.querySelector('.buttons')
+  let foundButtons = element.parentElement?.querySelector(".buttons");
   if (useButtons && foundButtons) {
-    return foundButtons
+    return foundButtons;
   }
 
-  var div = document.createElement('div')
+  let div = document.createElement("div");
-  div.classList.add('ferris-container')
+  div.classList.add("ferris-container");
+
+  if (!element.parentElement) {
+    console.error(`Could not install Ferris on ${element}, which is missing a parent`);
+    return null;
+  }
 
-  element.parentElement.insertBefore(div, element)
+  element.parentElement.insertBefore(div, element);
 
-  return div
+  return div;
 }
 
+/**
+ * @param {FerrisType} type
+ * @param {'small' | 'large'} size
+ * @returns {HTMLAnchorElement} - The generated anchor element.
+ */
 function createFerris(type, size) {
-  var a = document.createElement('a')
+  let a = document.createElement("a");
-  a.setAttribute('href', 'ch00-00-introduction.html#ferris')
+  a.setAttribute("href", "ch00-00-introduction.html#ferris");
-  a.setAttribute('target', '_blank')
+  a.setAttribute("target", "_blank");
 
-  var img = document.createElement('img')
+  let img = document.createElement("img");
-  img.setAttribute('src', 'img/ferris/' + type.attr + '.svg')
+  img.setAttribute("src", "img/ferris/" + type.attr + ".svg");
-  img.setAttribute('title', type.title)
+  img.setAttribute("title", type.title);
-  img.classList.add('ferris')
+  img.classList.add("ferris");
-  img.classList.add('ferris-' + size)
+  img.classList.add("ferris-" + size);
 
-  a.appendChild(img)
+  a.appendChild(img);
 
-  return a
+  return a;
 }

theme/2018-edition.css

@@ -1,5 +1,5 @@
 span.caption {
-    font-size: .8em;
+  font-size: 0.8em;
   font-weight: 600;
 }
 

theme/listing.css

@@ -3,6 +3,6 @@ figure.listing {
 }
 
 .listing figcaption {
-    font-size: .8em;
+  font-size: 0.8em;
   font-weight: 600;
 }