joerdav / xc

Markdown defined task runner.
https://xcfile.dev/
MIT License
1.14k stars 27 forks source link

Support short/long option aliases #56

Closed waldyrious closed 1 year ago

waldyrious commented 1 year ago

Most options of the CLI have both a short and a long version. Notable exceptions are -version, which only has a long version, and -y, which only has a short one. For consistency, these two could have both variants.

Here's what I'd suggest:

Additionally, perhaps consider changing -md to -n/-dry-run, since the format of the task definition document should not be relevant — i.e., it should be possible to eventually make xc support AsciiDoc, reStructuredText, and other lightweight markup formats.

joerdav commented 1 year ago

Agree there is a bit of inconsistency. I think usually there is short form for commonly used flags, so may not be applicable for all. But I definitely agree this could be improved.

joerdav commented 1 year ago

Taken onboard your comments, however left completion flags as is, at the moment xc uses an external completion lib, so will need to refactor that into xc to have more control.

waldyrious commented 1 year ago

Sure, thanks! I've submitted #65 for additional consistency in the option descriptions.

By the way, do you have any thoughts about the suggestion I made above to make xc support formats other than markdown? I could create a separate issue to track that if it's something you'd consider.

joerdav commented 1 year ago

Thanks! We can keep a ticket open for other formats, but at this point I think sticking to markdown and getting it working well with that format is where I want to work on for the time being.

waldyrious commented 1 year ago

Cool, makes sense. I've opened #66 to track that.