Skip to content
This repository has been archived by the owner on Jul 12, 2022. It is now read-only.

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

Closed
9 of 12 tasks
skolima opened this issue Jul 10, 2018 · 6 comments
Closed
9 of 12 tasks

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

skolima opened this issue Jul 10, 2018 · 6 comments
Labels

Comments

@skolima
Copy link
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
@AnthonySteele
Copy link
Member

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 mentioned this issue Jul 10, 2018
9 tasks
@AnthonySteele
Copy link
Member

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

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

skolima commented Jul 25, 2018

Main help screen
image

Inspect
image

Update
image

Repository
image

Organisation
image

Global
image

@AnthonySteele
Copy link
Member

AnthonySteele commented Jul 25, 2018

We should change commands to repo and org now.

AnthonySteele pushed a commit to AnthonySteele/NuKeeper that referenced this issue Jul 28, 2018
Review wording on commands and options.
for NuKeeperDotNet#323
AnthonySteele added a commit that referenced this issue Jul 29, 2018
Review wording on commands and options.
for #323
@AnthonySteele
Copy link
Member

Done in version 0.6.0 🥇

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

2 participants