Groups the cells of a results file for display: by language, then by where the input came from, then by size and mode. A home input is grouped by the library whose samples it is, never pooled with another library's, so a summary over a group can't hide whose home turf it was measured on.
12 declarations
CellGroup import type {CellGroup} from '@ryanatkn/syntax-highlighter-bench/cell_groups.js'; The cells of one language from one source.
keytype string
langtype BenchLang
source_keytype string
cellstype BenchCell[]
CellSelection import type {CellSelection} from '@ryanatkn/syntax-highlighter-bench/cell_groups.js'; Which cells to show.
langstype readonly string[]
sizestype readonly string[]
sourcestype readonly string[]
modestype readonly string[]
(group: CellGroup): string import {format_cell_group_label} from '@ryanatkn/syntax-highlighter-bench/cell_groups.js'; The label of a cell group: its language and its source.
groupstring (key: string): string import {format_source_key} from '@ryanatkn/syntax-highlighter-bench/cell_groups.js'; A source key's label: the source, naming the owner of a home input.
keystringstring (key: string): string import {format_source_note} from '@ryanatkn/syntax-highlighter-bench/cell_groups.js'; What a source key's inputs are, naming whose samples a home input is.
keystringstring (results: Pick<MatrixResults, "langs" | "cells">, selection: CellSelection): CellGroup[] import {group_cells} from '@ryanatkn/syntax-highlighter-bench/cell_groups.js'; The selected cells in groups of one language and one source, in roster and source order. Within a group the cells are ordered by size, then file, then mode.
resultsPick<MatrixResults, "langs" | "cells">selection(cell: Pick<{ id: string; metric: "throughput"; lang: string; size: "micro" | "small" | "medium" | "large"; mode: "tokenize" | "html"; source: "neutral" | "shiki" | "home" | "harness" | "stress"; ... 8 more ...; compressed: Record<...>; }, "file">): string import {to_cell_label} from '@ryanatkn/syntax-highlighter-bench/cell_groups.js'; A cell's row label: its file name. A group holds one source and one language, which is all the rest of the path says, and one directory never holds two files of one name, so the name tells a group's rows apart.
cellPick<BenchCell, "file">string (cell: string, library: string): string import {to_excluded_key} from '@ryanatkn/syntax-highlighter-bench/cell_groups.js'; The key of one library in one cell.
cellstringlibrarystringstring (results: Pick<MatrixResults, "meta">): Map<string, string> import {to_excluded_reasons} from '@ryanatkn/syntax-highlighter-bench/cell_groups.js'; The reason each excluded library has in each cell, by to_excluded_key.
resultsPick<MatrixResults, "meta">Map<string, string>
(results: Pick<MatrixResults, "coverage">, excluded: ReadonlyMap<string, string>, cell: Pick<{ id: string; metric: "throughput"; lang: string; size: "micro" | ... 2 more ... | "large"; ... 10 more ...; compressed: Record<...>; }, "id" | "lang">, library: string): MatrixEntry import {to_missing_cell_entry} from '@ryanatkn/syntax-highlighter-bench/cell_groups.js'; Why a library has no number in a cell: excluded with its reason, unsupported when it doesn't claim the cell's language, and otherwise unmeasured.
resultsPick<MatrixResults, "coverage">excludedReadonlyMap<string, string>cellPick<BenchCell, "id" | "lang">librarystring(input: Pick<{ id: string; metric: "throughput"; lang: string; size: "micro" | "small" | "medium" | "large"; mode: "tokenize" | "html"; source: "neutral" | "shiki" | "home" | "harness" | "stress"; ... 8 more ...; compressed: Record<...>; }, "home" | "source">): string import {to_source_key} from '@ryanatkn/syntax-highlighter-bench/cell_groups.js'; The key of an input's source on the site: the source, with the owner
appended for a home input, as home:<library>.
inputPick<BenchCell, "home" | "source">string (cells: readonly Pick<{ id: string; metric: "throughput"; lang: string; size: "micro" | "small" | "medium" | "large"; mode: "tokenize" | "html"; source: "neutral" | "shiki" | "home" | "harness" | "stress"; ... 8 more ...; compressed: Record<...>; }, "home" | "source">[]): string[] import {to_source_keys} from '@ryanatkn/syntax-highlighter-bench/cell_groups.js'; The source keys of a file's cells, in the order of BENCH_SOURCES, then by owner.
cellsreadonly Pick<BenchCell, "home" | "source">[]string[]