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

Command line options should be more alike other dotnet core tools #323

Closed
skolima opened this Issue Jul 10, 2018 · 6 comments

Comments

Projects
None yet
2 participants
@skolima
Collaborator

skolima commented Jul 10, 2018

The way that dotnet does it is that a main command verb has no dash at all, e.g. dotnet build so NuKeeper inspect would work like that.
Then the options have a short form with one dash and a long form with 2 dashes, e.g. -v, --verbosity
And no equals signs
e.g. dotnet build -v q and dotnet build --verbosity quiet

CommandLineUtils at https://github.com/natemcmaster/CommandLineUtils is a fork of the (no longer published) dotnetcore command line library and would allow us to get much closer to being consistent with other tools.

This should probably be split into multiple PRs, but published in a single new release, so as to not have multiple releases one after the other, each breaking compatibility.

Status:

  • inspect starts
  • inspect accepts options and help
  • logging levels can be set
  • update command works
  • repository command works
  • organisation command works
  • various smaller configuration settings
  • version output correct
  • review by native speakers / feedback on option names
  • documentation update
  • configuration file support (perhaps response file? that's built in)
  • code cleanup (final removal of old settings handling

@skolima skolima added the feature label Jul 10, 2018

@AnthonySteele

This comment has been minimized.

Member

AnthonySteele commented Jul 10, 2018

I totally agree. Being a dotnet global tool has greatly increased the utility of using the same commandline syntax as other tools.

There's a good case for using natemcmaster/CommandLineUtils to do this.

@skolima skolima referenced this issue Jul 10, 2018

Merged

Moving to CommandLineUtils #324

6 of 9 tasks complete
@AnthonySteele

This comment has been minimized.

Member

AnthonySteele commented Jul 12, 2018

Is there a document somewhere that defines how this command line syntax is supposed to look? Would help to know if we're following it.

@skolima

This comment has been minimized.

Collaborator

skolima commented Jul 12, 2018

I don't have anything regarding spec - mostly following https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-restore?tabs=netcore2x to be honest.

@skolima

This comment has been minimized.

Collaborator

skolima commented Jul 25, 2018

Main help screen
image

Inspect
image

Update
image

Repository
image

Organisation
image

Global
image

@AnthonySteele

This comment has been minimized.

Member

AnthonySteele commented Jul 25, 2018

We should change commands to repo and org now.

AnthonySteele added a commit to AnthonySteele/NuKeeper that referenced this issue Jul 28, 2018

Review Wording
Review wording on commands and options.
for NuKeeperDotNet#323

AnthonySteele added a commit that referenced this issue Jul 29, 2018

Review Wording (#354)
Review wording on commands and options.
for #323
@AnthonySteele

This comment has been minimized.

Member

AnthonySteele commented Aug 5, 2018

Done in version 0.6.0 🥇

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment