badness 0.8.0

A language server, formatter, and linter for LaTeX
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201

// Renders the benchmark dot plot(s) on the Benchmarks page with Vega-Lite.
// One block per `.bench-chart-block`, so the formatter and linter charts share
// this code (each carries its own inline data payload).
//
// Data is injected by the `doc-utils` mdbook preprocessor as an inline
// `<script type="application/json" class="bench-data">` next to a
// `<div class="bench-chart">` (see docs/doc-utils/src/lib.rs). The Vega runtime
// is vendored under theme/vendor/ and loaded before this file via book.toml's
// `additional-js`, so nothing is fetched at view time.
//
// Chart: x = tool, y = time relative to badness (log scale, baseline = 1),
// color = document, one dot per (document, tool), with a hover tooltip.
(function () {
  "use strict";

  // mdBook keeps the active theme as a class on <html>; these three are dark.
  function isDark() {
    var c = document.documentElement.classList;
    return c.contains("coal") || c.contains("navy") || c.contains("ayu");
  }

  // Unique values in first-appearance (corpus / results) order, so the axis and
  // legend read badness -> tex-fmt -> latexindent rather than alphabetized.
  function orderedUnique(rows, key) {
    var seen = Object.create(null);
    var out = [];
    rows.forEach(function (r) {
      if (!(r[key] in seen)) {
        seen[r[key]] = true;
        out.push(r[key]);
      }
    });
    return out;
  }

  // Exact powers of ten spanning the data's ratio range, so the log axis ticks
  // (and grid) land only on 10ⁿ values the label expression can render cleanly.
  function powersOfTenTicks(points) {
    var ratios = points
      .map(function (p) {
        return p.ratio;
      })
      .filter(function (r) {
        return r > 0;
      });
    if (!ratios.length) {
      return [1];
    }
    var lo = Math.floor(Math.log10(Math.min.apply(null, ratios)));
    var hi = Math.ceil(Math.log10(Math.max.apply(null, ratios)));
    var ticks = [];
    for (var e = lo; e <= hi; e++) {
      ticks.push(Math.pow(10, e));
    }
    return ticks;
  }

  function spec(points) {
    var dark = isDark();
    var fg = dark ? "#c8c9db" : "#333333";
    var grid = dark ? "#3b3f5c" : "#dddddd";
    var formatters = orderedUnique(points, "formatter");
    var documents = orderedUnique(points, "document");

    return {
      $schema: "https://vega.github.io/schema/vega-lite/v5.json",
      description:
        "Dot plot of formatting speed relative to badness. Each dot is one " +
        "document formatted by one tool; the vertical axis is mean time as a " +
        "ratio to badness on a log scale, with badness on a dashed baseline " +
        "at 1, faster tools below and slower tools above. See the data table " +
        "for the underlying numbers.",
      width: "container",
      height: 340,
      data: { values: points },
      layer: [
        // Baseline at 1.0 (badness); everything below is faster, above slower.
        {
          mark: { type: "rule", strokeDash: [4, 4], color: grid },
          encoding: { y: { datum: 1, type: "quantitative" } },
        },
        {
          mark: { type: "point", filled: true, size: 130, opacity: 0.9 },
          encoding: {
            x: {
              field: "formatter",
              type: "nominal",
              title: "Tool",
              sort: formatters,
              axis: { labelAngle: 0 },
            },
            // No xOffset: dots for every document share their tool's x position
            // so they stack vertically at their respective ratios. Color still
            // distinguishes documents, and hover disambiguates overlaps.
            y: {
              field: "ratio",
              type: "quantitative",
              title: "Time relative to badness",
              scale: { type: "log" },
              axis: {
                // Pin ticks to exact powers of ten and label them as plain
                // decimals (1000, 100, 10, 1, 0.1, …); "~f" trims trailing zeros.
                values: powersOfTenTicks(points),
                format: "~f",
              },
            },
            color: {
              field: "document",
              type: "nominal",
              title: "Document",
              sort: documents,
            },
            tooltip: [
              { field: "document", title: "Document" },
              { field: "formatter", title: "Tool" },
              { field: "mean_ms", title: "Mean (ms)", format: ".3f" },
              { field: "ratio_label", title: "Relative" },
              { field: "min_ms", title: "Min (ms)", format: ".3f" },
              { field: "max_ms", title: "Max (ms)", format: ".3f" },
              { field: "stddev_ms", title: "Std dev (ms)", format: ".3f" },
            ],
          },
        },
      ],
      config: {
        background: null,
        view: { stroke: null },
        axis: {
          labelColor: fg,
          titleColor: fg,
          gridColor: grid,
          domainColor: grid,
          tickColor: grid,
        },
        legend: { labelColor: fg, titleColor: fg },
      },
    };
  }

  function renderInto(container, points) {
    if (!window.vegaEmbed) {
      return;
    }
    var vlSpec = spec(points);
    // Alt text on the container, mirroring the spec description Vega puts on the
    // rendered SVG, so the chart is labeled for assistive tech either way.
    container.setAttribute("role", "img");
    container.setAttribute("aria-label", vlSpec.description);
    window
      .vegaEmbed(container, vlSpec, { actions: false, renderer: "svg" })
      .catch(function (err) {
        // Leave the fallback table in place; surface the reason for debugging.
        console.error("bench-charts: failed to render", err);
      });
  }

  function init() {
    var blocks = document.querySelectorAll(".bench-chart-block");
    if (!blocks.length) {
      return;
    }
    blocks.forEach(function (block) {
      var container = block.querySelector(".bench-chart");
      var data = block.querySelector("script.bench-data");
      if (!container || !data) {
        return;
      }
      var points;
      try {
        points = JSON.parse(data.textContent);
      } catch (err) {
        console.error("bench-charts: bad data payload", err);
        return;
      }
      if (!Array.isArray(points) || !points.length) {
        return;
      }
      container.__benchPoints = points;
      renderInto(container, points);
    });

    // Re-render on light/dark toggle so axis and legend colors track the theme.
    var observer = new MutationObserver(function () {
      document.querySelectorAll(".bench-chart").forEach(function (container) {
        if (container.__benchPoints) {
          renderInto(container, container.__benchPoints);
        }
      });
    });
    observer.observe(document.documentElement, {
      attributes: true,
      attributeFilter: ["class"],
    });
  }

  if (document.readyState === "loading") {
    document.addEventListener("DOMContentLoaded", init);
  } else {
    init();
  }
})();