Enable tab completion via CLI to System.CommandLine Migration

[antonrademaker]

Dotnet cli supports tab completion, it would be really handy to have support for template parameters / symbols as well?

https://docs.microsoft.com/en-us/dotnet/core/tools/enable-tab-autocomplete

To allow tab completion, dotnet new CLI needs to migrate to System.CommandLine parser.

Subtasks

Done

• [Tab Completion] Create root command #3802
• [Tab Completion] Move --install to new command line parser #3805
• [Tab Completion] Move --uninstall to new command line parser #3806
• [Tab Completion] Move --update-apply & --update-check to new command line parser #3807
• [Tab Completion] Move --search to new command line parser #3804
• [Tab Completion] Move --list to new command line parser #3803
• [Tab Completion] Display curated list for 'dotnet new' using new command line parser #3811
• [Tab Completion] Write tests to ensure that the backwards compatibility will be preserved. #2983
• [Tab Completion] Move --help to new command line parser #3810
• dotnet new help should show choice parameter even when one choice is defined #3263
• [Tab Completion] Move template instantiation to new command line parser #3809
• [Tab completion] final cleanup #4060
• binding arguments for host/telemetry [system-command-line] replaced host and telemetry logger parameters to NewCommand with delegates #4254
• [Tab Completion] Move global options to new command line parser #3812
• add tests for debug: arguments to dotnet.new3.UnitTests #3053
• [Tab Completion] Refactor CommandExamples to use Command definition instead #4034
• [Tab Completion] Integrate dotnet new based on new parser into dotnet CLI. #3814 - done by @baronfel
• [Tab Completion] Move hidden commands to new command line parser #3813

Not started / moved to separate issues

• consider creating TemplatePackageManager.GetTemplates version which uses cache only for tab completion and help
  • consider implementing non async version for GetTemplatePackage based on cache to be used in HandleAmbiguousTemplateGroup and HandleAmbiguousResult methods. At the moment help delegate is not async, also not possible to use async methods in renderer. [system-command-line] error handling for ambiguous results on template instantiation #4227 (comment)
    • default if option without value should not be parsed / validated at parser level. Instead the parser should just pass null in this case and TemplateCreator should handle this case properly. However if default if option without value is not set for parameter, having no value for option should not be allowed.
    • consider not parsing hex values on parser level. It's a specific format of current generator. Either utilize generator to see if value can be parsed or try to convert any value to hex in format needed by generator and fail if it's not possible.
    • points above should allow to remove custom parse logic for most cases.

Justification

Customer impact

1. better and more intuitive CLI UX, including help
2. enables tab completion
   Engineering impact
3. removes dependency on old parser, requiring workarounds for source-build and separate repo maintanence costs
4. easier cost of adding new commands and options for new features

[rainersigwald]

Another upvote from Twitter: https://twitter.com/buhakmeh/status/1235581946853392386?s=20

cc @donJoseLuis

[donJoseLuis]

we need to find the right place for this issue.

[donJoseLuis]

Discussion:

• Evaluate supporting baseline in dotnet new and template engine #4062
  Outcome: baseline is supported with new parser, but remains hidden. Issue remains open outside of this epic.
• [Tab completion] support of template parameters matching for list and search  #4061
  Outcome: won't be implement as is, and for the first preview. Consider doing new syntax and implement later.
• Decision on whether parsing should be case-sensitive #3237
  Outcome: the parser remains case sensitive now, but issue remains open for later.
• Decision on should short alias on template parameter be generated by default #3238
  Outcome: the behavior remains is, but the issue remains open for later.
• probing the template options via -h ("configured values").
  Outcome: won't be implemented.
• "default if option without value" support.
  Outcome: implemented for new parser.
• Consider showing a warning in case old dotnet new command syntax is used  #4260

May also resolve:

• Can't pass a name to filter with dotnet new --list #1926
• Escaped quotes in symbol parameter values lost or cause errors #1704
• Unexpected blank lines when dotnet new foo --help run in PowerShell #1544
• dotnet new - duplicate templates and template uninstall recommendation #4128 - uninstall recommendation on conflict part (duplicate: Revise error message on conflicting templates #3275)
• Caching issue impacting local folder templates #4155 - issue with improper help display
• Allow to pick up certain template group or certain template to be run in case of ambiguity  #4135

Blocks:

• [CLI] Revise using colors and output streams used #2720
• Validating parameter using RegExp #2038
• Force parameters to be specified if another is specified #2173
• CLI - allow second parameter to specify name of project/item template #3009

[vlada-shubina]

This effort is considered to be done. Outstanding items from description / comments are moved to separate issues and will be done later.