Inconsistent casing of template parameters

[nohwnd]

Is there an existing issue for this?

• I have searched the existing issues

Describe the bug

Template for grpc uses Framwork, which becomes --Framework and -F rather than --framework and -f that other templates use, e.g. console, mstest, winforms.

https://github.com/dotnet/aspnetcore/blob/main/src/ProjectTemplates/Web.ProjectTemplates/content/GrpcService-CSharp/.template.config/template.json#L53

The settings are case-sensitive on purpose:

dotnet/templating#3237
dotnet/templating#3238

Expected Behavior

Please consider using, -f framework.

Steps To Reproduce

C:\t\grpc1> dotnet --version
7.0.100-preview.2.22153.17

C:\t\grpc1> dotnet new grpc --help
ASP.NET Core gRPC Service (C#)
Author: Microsoft
Description: A project template for creating a gRPC ASP.NET Core service.

Usage:
  dotnet new grpc [options] [template options]

Options:
  -n, --name <name>       The name for the output being created. If no name is specified, the name of the output directory is used.
  -o, --output <output>   Location to place the generated output.
  --dry-run               Displays a summary of what would happen if the given command line were run if it would result in a template creation.
  --force                 Forces content to be generated even if it would change existing files.
  --no-update-check       Disables checking for the template package updates when instantiating a template.
  -lang, --language <C#>  Specifies the template language to instantiate.
  --type <project>        Specifies the template type to instantiate.

Template options:
  -F, --Framework <net5.0|net6.0|net7.0|netcoreapp3.1>  The target framework for the project.
                                                        Type: choice
                                                          net7.0         Target net7.0
                                                          net6.0         Target net6.0
                                                          net5.0         Target net5.0
                                                          netcoreapp3.1  Target netcoreapp3.1
                                                        Default: net7.0

Exceptions (if any)

No response

.NET Version

7.0.100-preview.2.22153.17

Anything else?

No response

[javiercn]

@nohwnd thanks for contacting us.

That's a good catch, feel free to send us a PR if you want to address it.

/cc: @JamesNK

[JamesNK]

This isn't unique to gRPC template. All the web templates have Framework.

e.g.

aspnetcore/src/ProjectTemplates/Web.ProjectTemplates/content/EmptyWeb-CSharp/.template.config/template.json

Line 142 in 4966b6c

"Framework": {

[javiercn]

@JamesNK so is there inconsistency then or not? 😄.

As long as the parameter shows as --framework on the output I think its correct.

I believe you need to look at this file or equivalent in the GRPC template.

It might be that on the GRPC template is missing the parameter definition

[JamesNK]

Ah, so the inconsistency is this is missing from grpc's dotnetcli.host.json:

aspnetcore/src/ProjectTemplates/Web.ProjectTemplates/content/BlazorServerWeb-CSharp/.template.config/dotnetcli.host.json

Lines 47 to 49 in 4966b6c

	"Framework": {
	"longName": "framework"
	},

[nohwnd]

FWIW all the templates I have locally use --framework except for grpc.

This is the full list of templates that have capitalized parameters, are some other managed here as well? :)

C:\Users\jajares> dotnet new web --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new grpc --help | sls -CaseSensitive "-[A-Z]"

  -F, --Framework <net5.0|net6.0|net7.0|netcoreapp3.1>  The target framework for the project.

C:\Users\jajares> dotnet new webapi --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new webapp --help | sls -CaseSensitive "-[A-Z]"

  -S, --SignedOutCallbackPath <SignedOutCallbackPath>         The global signout callback (use with IndividualB2C auth).

C:\Users\jajares> dotnet new mvc --help | sls -CaseSensitive "-[A-Z]"

ASP.NET Core Web App (Model-View-Controller) (C#)
  -S, --SignedOutCallbackPath <SignedOutCallbackPath>         The global signout callback (use with IndividualB2C auth).

C:\Users\jajares> dotnet new angular --help | sls -CaseSensitive "-[A-Z]"

  -P, --ProxyPort <ProxyPort>          Port number to use for the SPA front-end development proxy.

C:\Users\jajares> dotnet new react --help | sls -CaseSensitive "-[A-Z]"

  -P, --ProxyPort <ProxyPort>          Port number to use for the SPA front-end development proxy.

C:\Users\jajares> dotnet new reactredux --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new blazorserver --help | sls -CaseSensitive "-[A-Z]"

  -S, --SignedOutCallbackPath <SignedOutCallbackPath>         The global signout callback (use with IndividualB2C auth).

C:\Users\jajares> dotnet new blazorwasm --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new classlib --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new console --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new gitignore --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new tool --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new editorconfig --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new globaljson --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new mstest --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new viewimports --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new viewstart --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new nugetconfig --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new nunit --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new nunit --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new proto --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new proto --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new razorclasslib --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new razorcomponent --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new page --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new sln --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new webconfig --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new winforms --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new winformslib --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new winformscontrollib --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new worker --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new wpf --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new wpflib --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new wpfcustomcontrollib --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new wpfusercontrollib --help | sls -CaseSensitive "-[A-Z]"
C:\Users\jajares> dotnet new xunit --help | sls -CaseSensitive "-[A-Z]"

I got the full list using dotnet new --list, and then just edited that using the VSCode multiselection magic...

[rafikiassumani-msft]

Triage: Should we make all these cases insensitive? @DamianEdwards

[DamianEdwards]

@rafikiassumani-msft yeah I think that makes sense.

[ghost]

We've moved this issue to the Backlog milestone. This means that it is not going to be worked on for the coming release. We will reassess the backlog following the current release and consider this item at that time. To learn more about our issue management process and to have better expectation regarding different types of issues you can read our Triage Process.

[JamesNK]

gRPC is fixed (--Framework vs --framework)

I've renamed this issue to be generic to other templates with parameters than need to be looked at.