score icon indicating copy to clipboard operation
score copied to clipboard

Adding `dotnet tool` scoring

Open pdevito3 opened this issue 4 years ago • 1 comments

This is scoring is really cool. I'd think that the criteria would be a little different for dotnet tools though versus a traditional library. Curious what you think of adding a scoring system in for tools?

To start, how would the command know what scoring mechanism to use? For me, two options come to mind:

  1. check the csproj for a <PackAsTool>true</PackAsTool> setting
  2. add a flag to the command (e.g. -t | --type that could take tool or library, defaulting to library if none is given). This seems okay, but #1 seems preferable

As far as what criteria to look at, I honestly don't know. I've only built one myself and would love to run something like this to learn more about what I should be doing 🙃

pdevito3 avatar Mar 06 '21 15:03 pdevito3

There is a packageType property that can be used!

image

https://docs.microsoft.com/en-us/nuget/create-packages/set-package-type

I haven't really looked into tooling scenarios much, but there definitely are some best practices such as what frameworks are supported

image

I think most of the general package best practices will apply. Additionally, maybe there are some best practices from https://docs.microsoft.com/en-us/dotnet/core/tools/troubleshoot-usage-issues which can be used?

Other than that, I think static analysis of the actual contents of the tools/ folder would be ideal. I don't know exactly what that might be yet though!

JonDouglas avatar Mar 06 '21 15:03 JonDouglas