Automatic conversion from underscore to hyphen

[nguyenvulong]

This is not really a bug report but a "behavior note". As requested by Brian, I created an issue here for further reference. You may want to mention it in the README section.

Original discussion tiangolo/typer#233 (comment)

This behavior comes from Click

The workaround is using a lambda function as mentioned here tiangolo/typer#341 (comment)

I think if there're many requests from user, please consider adding an option to keep the opt name as-is. Thank you.

[BrianPugh]

Hey @nguyenvulong! Thank you for opening up this issue! I'm actually thinking about tackling it in a similar way here in Cyclopts. Both App and Parameter would take in an optional argument, name_transform, which defaults to the following function:

def default_name_transform(name: str) -> str:
    return name.lower().replace("_", "-").strip("-")

You could then set your own like:

app = App(
    name_transform=lambda name: name,  # don't modify the name at all. This applies to command names.
    default_parameter=Parameter(name_transform=lambda name: name),  # This applies to parameter names.
)

What do you think of this proposal?

[nguyenvulong]

Hi @BrianPugh
Yeah that looks good to me.

Thank you.

[BrianPugh]

Addressed in #150 and is now part of release v2.6.0