Skip to content

A shorter --export option #691

@Neved4

Description

@Neved4

Currently, the --export variants lack short flags, forcing commands to be verbose. This issue is intended to spark discussion rather than to provide a fixed change.

Inspired by the approach used in pandoc, we could introduce a short flag, -e or -f, as in -f <FORMAT> to reduce repetition. The specific letter isn't crucial, consistency is. Here's an example:

Current Addition
--export-asciidoc
--export-csv
--export-json
--export-markdown
--export-orgmode
-f asciidoc
-f csv
-f json
-f markdown
-f orgmode
This would align with existing flags, such as --sort auto and --output null.

There are multiple ways to implement this addition. For example, we could pass a second argument -f asciidoc <FILE>, or use it in combination with a new option -f asciidoc -o <FILE>.

This also opens the possibility for hyperfine to default to a specific format based on the file extension. Namely, -o file.md would be equivalent to --export-asciidoc <FILE>, simplifying the command further. That default could be overriden by specifying the format explicitly: -f asciidoc -o file.md.

That strategy could also be used with --parameter flags, and it may break compatibility:

Current Addition
--parameter-scan
--parameter-step-size
--parameter-list
-P scan
-P step-size
-P list

Ultimately the maintainers know what's best for the project, make any adjustments you see fit 🚀

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions