Compare commits

..
Author SHA1 Message Date
David Peter 8c40de45f8 Store parameter usage metadata in benchmark results 2026-10-05 12:35:24 +02:00
David Peter 29a0ef164d Merge pull request #841 from starsep/colorful-help
Add colors to --help/-h
2026-10-05 12:19:43 +02:00
Filip Czaplicki bb834ca5aa Add colors to --help 2026-10-05 12:13:37 +02:00
David Peter 87f3905678 Merge pull request #883 from c-tonneslan/docs/modifized-typo
Fix "modifized" typo on modified_zscores docstring
2026-10-05 12:13:07 +02:00
David Peter 0a61e330cf Merge pull request #947 from Likio3000/codex/fix-markdown-backticks
Preserve backticks in Markdown command names
2026-10-05 12:11:51 +02:00
David Peter 9bf42b337d Snapshot test 2026-10-05 12:04:09 +02:00
Eric Soler a760e75f2f Preserve backticks in Markdown command names 2026-10-05 12:01:42 +02:00
6 changed files with 111 additions and 11 deletions

No files matched your search

+10 -1
View File
@@ -2,6 +2,15 @@ use std::collections::BTreeMap;
use serde::Serialize;
/// Parameter value and whether it was used in the command line template
#[derive(Debug, Default, Clone, Serialize, PartialEq)]
#[serde(transparent)]
pub struct Parameter {
pub value: String,
#[serde(skip)]
pub is_unused: bool,
}
/// Set of values that will be exported.
// NOTE: `serde` is used for JSON serialization, but not for CSV serialization due to the
// `parameters` map. Update `src/hyperfine/export/csv.rs` with new fields, as appropriate.
@@ -49,5 +58,5 @@ pub struct BenchmarkResult {
/// Parameter values for this benchmark
#[serde(skip_serializing_if = "BTreeMap::is_empty")]
pub parameters: BTreeMap<String, String>,
pub parameters: BTreeMap<String, Parameter>,
}
+10 -2
View File
@@ -19,7 +19,7 @@ use crate::output::warnings::{OutlierWarningOptions, Warnings};
use crate::parameter::ParameterNameAndValue;
use crate::quantity::{byte, const_time_from_seconds, ratio, second, FormatQuantity, Time, Zero};
use crate::util::exit_code::extract_exit_code;
use benchmark_result::BenchmarkResult;
use benchmark_result::{BenchmarkResult, Parameter};
use measurement::{Measurement, Measurements};
use anyhow::{anyhow, Result};
@@ -474,7 +474,15 @@ impl<'a> Benchmark<'a> {
.command
.get_parameters()
.iter()
.map(|(name, value)| (name.to_string(), value.to_string()))
.map(|(name, value)| {
(
name.to_string(),
Parameter {
value: value.to_string(),
is_unused: self.command.is_parameter_unused(name),
},
)
})
.collect(),
})
}
+11 -2
View File
@@ -1,8 +1,10 @@
use std::ffi::OsString;
use clap::{
builder::NonEmptyStringValueParser, crate_version, Arg, ArgAction, ArgMatches, Command,
ValueHint,
builder::styling::{AnsiColor, Effects},
builder::NonEmptyStringValueParser,
builder::Styles,
crate_version, Arg, ArgAction, ArgMatches, Command, ValueHint,
};
pub fn get_cli_arguments<'a, I, T>(args: I) -> ArgMatches
@@ -14,10 +16,17 @@ where
command.get_matches_from(args)
}
const STYLES: Styles = Styles::styled()
.header(AnsiColor::Green.on_default().effects(Effects::BOLD))
.usage(AnsiColor::Green.on_default().effects(Effects::BOLD))
.literal(AnsiColor::Cyan.on_default().effects(Effects::BOLD))
.placeholder(AnsiColor::Cyan.on_default());
/// Build the clap command for parsing command line arguments
fn build_command() -> Command {
Command::new("hyperfine")
.version(crate_version!())
.styles(STYLES)
.next_line_help(true)
.hide_possible_values(true)
.about("A command-line benchmarking tool.")
+30 -5
View File
@@ -53,7 +53,7 @@ impl Exporter for CsvExporter {
fields.push(Cow::Owned(format!("{f:.CSV_PRECISION$}").into_bytes()))
}
for v in res.parameters.values() {
fields.push(Cow::Borrowed(v.as_bytes()))
fields.push(Cow::Borrowed(v.value.as_bytes()))
}
writer.write_record(fields)?;
}
@@ -64,6 +64,7 @@ impl Exporter for CsvExporter {
#[test]
fn test_csv() {
use crate::benchmark::benchmark_result::Parameter;
use std::collections::BTreeMap;
let exporter = CsvExporter::default();
@@ -83,8 +84,20 @@ fn test_csv() {
exit_codes: vec![Some(0), Some(0), Some(0)],
parameters: {
let mut params = BTreeMap::new();
params.insert("foo".into(), "one".into());
params.insert("bar".into(), "two".into());
params.insert(
"foo".into(),
Parameter {
value: "one".into(),
is_unused: false,
},
);
params.insert(
"bar".into(),
Parameter {
value: "two".into(),
is_unused: false,
},
);
params
},
},
@@ -103,8 +116,20 @@ fn test_csv() {
exit_codes: vec![Some(0), Some(0), Some(0)],
parameters: {
let mut params = BTreeMap::new();
params.insert("foo".into(), "one".into());
params.insert("bar".into(), "seven".into());
params.insert(
"foo".into(),
Parameter {
value: "one".into(),
is_unused: false,
},
);
params.insert(
"bar".into(),
Parameter {
value: "seven".into(),
is_unused: false,
},
);
params
},
},
+29 -1
View File
@@ -24,7 +24,19 @@ impl MarkupExporter for MarkdownExporter {
}
fn command(&self, cmd: &str) -> String {
format!("`{cmd}`")
let longest_backtick_run = cmd
.split(|character| character != '`')
.map(str::len)
.max()
.unwrap_or(0);
if longest_backtick_run == 0 {
format!("`{cmd}`")
} else {
// Use a longer delimiter and keep command backticks separate from it.
let delimiter = "`".repeat(longest_backtick_run + 1);
format!("{delimiter} {cmd} {delimiter}")
}
}
}
@@ -44,3 +56,19 @@ fn test_markdown_formatter_table_divider() {
let divider = formatter.table_divider(&[Alignment::Left, Alignment::Right, Alignment::Left]);
assert_eq!(divider, "|:---|---:|:---|\n");
}
#[test]
fn test_markdown_formatter_command_with_backticks() {
let formatter = MarkdownExporter::default();
for (command, expected) in [
("echo `uname`", "`` echo `uname` ``"),
("echo ``quoted``", "``` echo ``quoted`` ```"),
("`` `quoted` ``", "``` `` `quoted` `` ```"),
("`", "`` ` ``"),
("echo ```", "```` echo ``` ````"),
(" echo `uname` ", "`` echo `uname` ``"),
] {
assert_eq!(formatter.command(command), expected, "{command:?}");
}
}
+21
View File
@@ -929,6 +929,27 @@ fn invalid_command_options_preserve_export_files() {
}
}
#[test]
fn markdown_export_preserves_backticks_and_pipes_in_command_names() {
let _settings = snapshot_settings().bind_to_scope();
assert_cmd_snapshot!(hyperfine_debug()
.arg("--style=none")
.arg("--export-markdown=-")
.arg("--command-name=echo `uname` | cat")
.arg("sleep 1"), @r"
success: true
exit_code: 0
----- stdout -----
| Command | Mean [s] | Min [s] | Max [s] | Relative |
|:---|---:|---:|---:|---:|
| `` echo `uname` \| cat `` | 1.000 ± 0.000 | 1.000 | 1.000 | 1.00 |
----- stderr -----
");
}
#[test]
fn unused_parameters_are_shown_in_benchmark_name() {
hyperfine()