id = "hyperfine"
name = "hyperfine"
description = "A command-line benchmarking tool."
homepage = "https://github.com/sharkdp/hyperfine"
executables = ["hyperfine"]

[commands]
format = 1
label = "Benchmark commands"
description = "Benchmark one or more shell commands. Parameter scans and lists are left out."
quality = "ai-draft"
base = "fig:hyperfine"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.source]]
id = "fig"
kind = "completion"
url = "https://github.com/withfig/autocomplete/blob/master/src/hyperfine.ts"
license = "MIT"

[[commands.field]]
id = "commands"
label = "Commands"
description = "Each entry is one command to benchmark."
type = "string"
position = 0
multiple = true
sources = ["fig"]

[[commands.field]]
id = "warmup"
label = "Warmup runs"
type = "integer"
option = ["--warmup", "-w"]
sources = ["fig"]

[[commands.field]]
id = "runs"
label = "Exact runs"
type = "integer"
option = ["--runs", "-r"]
sources = ["fig"]

[[commands.field]]
id = "min_runs"
label = "Minimum runs"
type = "integer"
option = ["--min-runs", "-m"]
sources = ["fig"]

[[commands.field]]
id = "max_runs"
label = "Maximum runs"
type = "integer"
option = ["--max-runs", "-M"]
sources = ["fig"]

[[commands.field]]
id = "setup"
label = "Setup command"
type = "string"
option = ["--setup", "-s"]
sources = ["fig"]

[[commands.field]]
id = "prepare"
label = "Prepare command"
description = "Runs before each timing run, for example to clear caches."
type = "string"
option = ["--prepare", "-p"]
sources = ["fig"]

[[commands.field]]
id = "cleanup"
label = "Cleanup command"
type = "string"
option = ["--cleanup", "-c"]
sources = ["fig"]

[[commands.field]]
id = "shell"
label = "Shell"
type = "string"
option = ["--shell", "-S"]
suggestions = [{ value = "bash", label = "bash" }, { value = "zsh", label = "zsh" }, { value = "sh", label = "sh" }, { value = "fish", label = "fish" }]
sources = ["fig"]

[[commands.field]]
id = "ignore_failure"
label = "Ignore failures"
type = "boolean"
option = ["--ignore-failure", "-i"]
sources = ["fig"]

[[commands.field]]
id = "show_output"
label = "Show command output"
type = "boolean"
option = ["--show-output"]
sources = ["fig"]

[[commands.field]]
id = "export_markdown"
label = "Export Markdown"
type = "path"
option = ["--export-markdown"]
path = { kind = "file", role = "output", must_exist = false }
effect = "overwrite"
sources = ["fig"]

[[commands.field]]
id = "export_json"
label = "Export JSON"
type = "path"
option = ["--export-json"]
path = { kind = "file", role = "output", must_exist = false }
effect = "overwrite"
sources = ["fig"]

[[commands.task]]
id = "compare"
label = "Compare commands"
fields = ["commands", "warmup", "runs", "export_markdown"]
required = ["commands"]

[[commands.task]]
id = "with-prepare"
label = "Benchmark with prepare step"
fields = ["commands", "prepare", "warmup", "runs"]
required = ["commands", "prepare"]

[[commands.group]]
id = "basic"
label = "Basic"
fields = ["commands", "warmup", "runs", "prepare", "export_markdown"]

[[commands.group]]
id = "advanced"
label = "Advanced"
fields = ["min_runs", "max_runs", "setup", "cleanup", "shell", "ignore_failure", "show_output", "export_json"]