Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support short/long option aliases #56

Closed
waldyrious opened this issue Mar 7, 2023 · 5 comments
Closed

Support short/long option aliases #56

waldyrious opened this issue Mar 7, 2023 · 5 comments
Labels
enhancement New feature or request

Comments

@waldyrious
Copy link
Contributor

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:

  • -V as the short variant of -version (since -v is often used for --verbose)
  • -noprompt as the long variant of -y

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 joerdav added the enhancement New feature or request label Mar 7, 2023
@joerdav
Copy link
Owner

joerdav commented Mar 7, 2023

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
Copy link
Owner

joerdav commented Mar 10, 2023

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.

@joerdav joerdav closed this as completed Mar 10, 2023
@waldyrious
Copy link
Contributor Author

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
Copy link
Owner

joerdav commented Mar 10, 2023

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
Copy link
Contributor Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants