Skip to content

Commit

Permalink
Add the displayName Property to Project Template Parameters (#40105)
Browse files Browse the repository at this point in the history
# Add the `displayName` Property to Project Template Parameters

Improves display of project template parameters by providing an easily readable parameter name.

Currently:
![image](https://user-images.githubusercontent.com/14852843/153301454-dfb5f44b-00b6-45d5-90aa-e8656cc97036.png)

After:
![image](https://user-images.githubusercontent.com/14852843/153320880-e897986c-b5fc-4a4b-b9df-28e93e7a3c16.png)

## Description

Recent changes which enabled template localization (#38867) omitted the new `displayName` property, which led to VS using the parameter id/name instead. This is non-localized and comes in the form of `camelCase`, `UpperCamelCase` or `kebab-case`.

Fixes https://github.com/aspnet/AspNetCore-ManualTests/issues/1154

## Customer Impact

The property id/name is being used instead of a more legible property display name. This can manifest itself in `camelCase`, `UpperCamelCase` or `kebab-case` case like below:

![image](https://user-images.githubusercontent.com/14852843/153301454-dfb5f44b-00b6-45d5-90aa-e8656cc97036.png)

## Regression?

- [x] Yes
- [ ] No

Visual Studio 17 Preview 1.

## Risk

- [ ] High
- [x] Medium
- [ ] Low


## Verification

- [x] Manual (required)
- [ ] Automated

## Packaging changes reviewed?

- [ ] Yes
- [ ] No
- [x] N/A
  • Loading branch information
TanayParikh authored Feb 10, 2022
1 parent 116addb commit 36f34b3
Show file tree
Hide file tree
Showing 49 changed files with 65 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@
"description": "A Razor page with or without a page model",
"symbols/namespace/description": "namespace for the generated code",
"symbols/no-pagemodel/description": "create page without a PageModel",
"symbols/no-pagemodel/displayName": "Exclude PageModel",
"postActions/openInEditor/description": "Opens Index.cshtml in the editor"
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@
"description": "A Razor page with or without a page model",
"symbols/namespace/description": "namespace for the generated code",
"symbols/no-pagemodel/description": "create page without a PageModel",
"symbols/no-pagemodel/displayName": "Exclude PageModel",
"postActions/openInEditor/description": "Opens Index.cshtml in the editor"
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@
"description": "A Razor page with or without a page model",
"symbols/namespace/description": "namespace for the generated code",
"symbols/no-pagemodel/description": "create page without a PageModel",
"symbols/no-pagemodel/displayName": "Exclude PageModel",
"postActions/openInEditor/description": "Opens Index.cshtml in the editor"
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@
"description": "A Razor page with or without a page model",
"symbols/namespace/description": "namespace for the generated code",
"symbols/no-pagemodel/description": "create page without a PageModel",
"symbols/no-pagemodel/displayName": "Exclude PageModel",
"postActions/openInEditor/description": "Opens Index.cshtml in the editor"
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@
"description": "A Razor page with or without a page model",
"symbols/namespace/description": "namespace for the generated code",
"symbols/no-pagemodel/description": "create page without a PageModel",
"symbols/no-pagemodel/displayName": "Exclude PageModel",
"postActions/openInEditor/description": "Opens Index.cshtml in the editor"
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@
"description": "A Razor page with or without a page model",
"symbols/namespace/description": "namespace for the generated code",
"symbols/no-pagemodel/description": "create page without a PageModel",
"symbols/no-pagemodel/displayName": "Exclude PageModel",
"postActions/openInEditor/description": "Opens Index.cshtml in the editor"
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@
"description": "A Razor page with or without a page model",
"symbols/namespace/description": "namespace for the generated code",
"symbols/no-pagemodel/description": "create page without a PageModel",
"symbols/no-pagemodel/displayName": "Exclude PageModel",
"postActions/openInEditor/description": "Opens Index.cshtml in the editor"
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@
"description": "A Razor page with or without a page model",
"symbols/namespace/description": "namespace for the generated code",
"symbols/no-pagemodel/description": "create page without a PageModel",
"symbols/no-pagemodel/displayName": "Exclude PageModel",
"postActions/openInEditor/description": "Opens Index.cshtml in the editor"
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@
"description": "A Razor page with or without a page model",
"symbols/namespace/description": "namespace for the generated code",
"symbols/no-pagemodel/description": "create page without a PageModel",
"symbols/no-pagemodel/displayName": "Exclude PageModel",
"postActions/openInEditor/description": "Opens Index.cshtml in the editor"
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@
"description": "A Razor page with or without a page model",
"symbols/namespace/description": "namespace for the generated code",
"symbols/no-pagemodel/description": "create page without a PageModel",
"symbols/no-pagemodel/displayName": "Exclude PageModel",
"postActions/openInEditor/description": "Opens Index.cshtml in the editor"
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@
"description": "A Razor page with or without a page model",
"symbols/namespace/description": "namespace for the generated code",
"symbols/no-pagemodel/description": "create page without a PageModel",
"symbols/no-pagemodel/displayName": "Exclude PageModel",
"postActions/openInEditor/description": "Opens Index.cshtml in the editor"
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@
"description": "A Razor page with or without a page model",
"symbols/namespace/description": "namespace for the generated code",
"symbols/no-pagemodel/description": "create page without a PageModel",
"symbols/no-pagemodel/displayName": "Exclude PageModel",
"postActions/openInEditor/description": "Opens Index.cshtml in the editor"
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@
"description": "A Razor page with or without a page model",
"symbols/namespace/description": "namespace for the generated code",
"symbols/no-pagemodel/description": "create page without a PageModel",
"symbols/no-pagemodel/displayName": "Exclude PageModel",
"postActions/openInEditor/description": "Opens Index.cshtml in the editor"
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@
"description": "A Razor page with or without a page model",
"symbols/namespace/description": "namespace for the generated code",
"symbols/no-pagemodel/description": "create page without a PageModel",
"symbols/no-pagemodel/displayName": "Exclude PageModel",
"postActions/openInEditor/description": "Opens Index.cshtml in the editor"
}
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
},
"no-pagemodel": {
"description": "create page without a PageModel",
"displayName": "Exclude PageModel",
"type": "parameter",
"datatype": "bool",
"defaultValue": "false"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
"parameter.Hosted.name": "ASP.NET Core _hosted",
"parameter.PWA.name": "_Progressive Web Application"
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -36,16 +36,10 @@
"symbolInfo": [
{
"id": "Hosted",
"name": {
"text": "ASP.NET Core _hosted"
},
"isVisible": "true"
},
{
"id": "PWA",
"name": {
"text": "_Progressive Web Application"
},
"isVisible": "true"
}
]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"symbols/Framework/description": "The target framework for the project.",
"symbols/Framework/choices/net7.0/description": "Target net7.0",
"symbols/skipRestore/description": "If specified, skips the automatic restore of the project on create.",
"symbols/Hosted/displayName": "ASP.NET Core Hosted",
"symbols/Hosted/description": "If specified, includes an ASP.NET Core host for the Blazor WebAssembly app.",
"symbols/auth/choices/None/description": "No authentication",
"symbols/auth/choices/Individual/description": "Individual authentication",
Expand All @@ -28,6 +29,7 @@
"symbols/kestrelHttpsPort/description": "Port number to use for the HTTPS endpoint in launchSettings.json. This option is only applicable when the parameter no-https is not used (no-https will be ignored if either IndividualAuth or OrganizationalAuth is used).",
"symbols/iisHttpPort/description": "Port number to use for the IIS Express HTTP endpoint in launchSettings.json.",
"symbols/iisHttpsPort/description": "Port number to use for the IIS Express HTTPS endpoint in launchSettings.json. This option is only applicable when the parameter no-https is not used (no-https will be ignored if either IndividualAuth or OrganizationalAuth is used).",
"symbols/PWA/displayName": "Progressive Web Application",
"symbols/PWA/description": "If specified, produces a Progressive Web Application (PWA) supporting installation and offline use.",
"symbols/NoHttps/description": "Whether to turn off HTTPS. This option only applies if Individual, IndividualB2C, SingleOrg, or MultiOrg aren't used for --auth.",
"symbols/UseLocalDB/description": "Whether to use LocalDB instead of SQLite. This option only applies if --auth Individual or --auth IndividualB2C is specified.",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"symbols/Framework/description": "The target framework for the project.",
"symbols/Framework/choices/net7.0/description": "Target net7.0",
"symbols/skipRestore/description": "If specified, skips the automatic restore of the project on create.",
"symbols/Hosted/displayName": "ASP.NET Core Hosted",
"symbols/Hosted/description": "If specified, includes an ASP.NET Core host for the Blazor WebAssembly app.",
"symbols/auth/choices/None/description": "No authentication",
"symbols/auth/choices/Individual/description": "Individual authentication",
Expand All @@ -28,6 +29,7 @@
"symbols/kestrelHttpsPort/description": "Port number to use for the HTTPS endpoint in launchSettings.json. This option is only applicable when the parameter no-https is not used (no-https will be ignored if either IndividualAuth or OrganizationalAuth is used).",
"symbols/iisHttpPort/description": "Port number to use for the IIS Express HTTP endpoint in launchSettings.json.",
"symbols/iisHttpsPort/description": "Port number to use for the IIS Express HTTPS endpoint in launchSettings.json. This option is only applicable when the parameter no-https is not used (no-https will be ignored if either IndividualAuth or OrganizationalAuth is used).",
"symbols/PWA/displayName": "Progressive Web Application",
"symbols/PWA/description": "If specified, produces a Progressive Web Application (PWA) supporting installation and offline use.",
"symbols/NoHttps/description": "Whether to turn off HTTPS. This option only applies if Individual, IndividualB2C, SingleOrg, or MultiOrg aren't used for --auth.",
"symbols/UseLocalDB/description": "Whether to use LocalDB instead of SQLite. This option only applies if --auth Individual or --auth IndividualB2C is specified.",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"symbols/Framework/description": "The target framework for the project.",
"symbols/Framework/choices/net7.0/description": "Target net7.0",
"symbols/skipRestore/description": "If specified, skips the automatic restore of the project on create.",
"symbols/Hosted/displayName": "ASP.NET Core _Hosted",
"symbols/Hosted/description": "If specified, includes an ASP.NET Core host for the Blazor WebAssembly app.",
"symbols/auth/choices/None/description": "No authentication",
"symbols/auth/choices/Individual/description": "Individual authentication",
Expand All @@ -28,6 +29,7 @@
"symbols/kestrelHttpsPort/description": "Port number to use for the HTTPS endpoint in launchSettings.json. This option is only applicable when the parameter no-https is not used (no-https will be ignored if either IndividualAuth or OrganizationalAuth is used).",
"symbols/iisHttpPort/description": "Port number to use for the IIS Express HTTP endpoint in launchSettings.json.",
"symbols/iisHttpsPort/description": "Port number to use for the IIS Express HTTPS endpoint in launchSettings.json. This option is only applicable when the parameter no-https is not used (no-https will be ignored if either IndividualAuth or OrganizationalAuth is used).",
"symbols/PWA/displayName": "_Progressive Web Application",
"symbols/PWA/description": "If specified, produces a Progressive Web Application (PWA) supporting installation and offline use.",
"symbols/NoHttps/description": "Whether to turn off HTTPS. This option only applies if Individual, IndividualB2C, SingleOrg, or MultiOrg aren't used for --auth.",
"symbols/UseLocalDB/description": "Whether to use LocalDB instead of SQLite. This option only applies if --auth Individual or --auth IndividualB2C is specified.",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"symbols/Framework/description": "The target framework for the project.",
"symbols/Framework/choices/net7.0/description": "Target net7.0",
"symbols/skipRestore/description": "If specified, skips the automatic restore of the project on create.",
"symbols/Hosted/displayName": "ASP.NET Core Hosted",
"symbols/Hosted/description": "If specified, includes an ASP.NET Core host for the Blazor WebAssembly app.",
"symbols/auth/choices/None/description": "No authentication",
"symbols/auth/choices/Individual/description": "Individual authentication",
Expand All @@ -28,6 +29,7 @@
"symbols/kestrelHttpsPort/description": "Port number to use for the HTTPS endpoint in launchSettings.json. This option is only applicable when the parameter no-https is not used (no-https will be ignored if either IndividualAuth or OrganizationalAuth is used).",
"symbols/iisHttpPort/description": "Port number to use for the IIS Express HTTP endpoint in launchSettings.json.",
"symbols/iisHttpsPort/description": "Port number to use for the IIS Express HTTPS endpoint in launchSettings.json. This option is only applicable when the parameter no-https is not used (no-https will be ignored if either IndividualAuth or OrganizationalAuth is used).",
"symbols/PWA/displayName": "Progressive Web Application",
"symbols/PWA/description": "If specified, produces a Progressive Web Application (PWA) supporting installation and offline use.",
"symbols/NoHttps/description": "Whether to turn off HTTPS. This option only applies if Individual, IndividualB2C, SingleOrg, or MultiOrg aren't used for --auth.",
"symbols/UseLocalDB/description": "Whether to use LocalDB instead of SQLite. This option only applies if --auth Individual or --auth IndividualB2C is specified.",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"symbols/Framework/description": "The target framework for the project.",
"symbols/Framework/choices/net7.0/description": "Target net7.0",
"symbols/skipRestore/description": "If specified, skips the automatic restore of the project on create.",
"symbols/Hosted/displayName": "ASP.NET Core Hosted",
"symbols/Hosted/description": "If specified, includes an ASP.NET Core host for the Blazor WebAssembly app.",
"symbols/auth/choices/None/description": "No authentication",
"symbols/auth/choices/Individual/description": "Individual authentication",
Expand All @@ -28,6 +29,7 @@
"symbols/kestrelHttpsPort/description": "Port number to use for the HTTPS endpoint in launchSettings.json. This option is only applicable when the parameter no-https is not used (no-https will be ignored if either IndividualAuth or OrganizationalAuth is used).",
"symbols/iisHttpPort/description": "Port number to use for the IIS Express HTTP endpoint in launchSettings.json.",
"symbols/iisHttpsPort/description": "Port number to use for the IIS Express HTTPS endpoint in launchSettings.json. This option is only applicable when the parameter no-https is not used (no-https will be ignored if either IndividualAuth or OrganizationalAuth is used).",
"symbols/PWA/displayName": "Progressive Web Application",
"symbols/PWA/description": "If specified, produces a Progressive Web Application (PWA) supporting installation and offline use.",
"symbols/NoHttps/description": "Whether to turn off HTTPS. This option only applies if Individual, IndividualB2C, SingleOrg, or MultiOrg aren't used for --auth.",
"symbols/UseLocalDB/description": "Whether to use LocalDB instead of SQLite. This option only applies if --auth Individual or --auth IndividualB2C is specified.",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"symbols/Framework/description": "The target framework for the project.",
"symbols/Framework/choices/net7.0/description": "Target net7.0",
"symbols/skipRestore/description": "If specified, skips the automatic restore of the project on create.",
"symbols/Hosted/displayName": "ASP.NET Core Hosted",
"symbols/Hosted/description": "If specified, includes an ASP.NET Core host for the Blazor WebAssembly app.",
"symbols/auth/choices/None/description": "No authentication",
"symbols/auth/choices/Individual/description": "Individual authentication",
Expand All @@ -28,6 +29,7 @@
"symbols/kestrelHttpsPort/description": "Port number to use for the HTTPS endpoint in launchSettings.json. This option is only applicable when the parameter no-https is not used (no-https will be ignored if either IndividualAuth or OrganizationalAuth is used).",
"symbols/iisHttpPort/description": "Port number to use for the IIS Express HTTP endpoint in launchSettings.json.",
"symbols/iisHttpsPort/description": "Port number to use for the IIS Express HTTPS endpoint in launchSettings.json. This option is only applicable when the parameter no-https is not used (no-https will be ignored if either IndividualAuth or OrganizationalAuth is used).",
"symbols/PWA/displayName": "Progressive Web Application",
"symbols/PWA/description": "If specified, produces a Progressive Web Application (PWA) supporting installation and offline use.",
"symbols/NoHttps/description": "Whether to turn off HTTPS. This option only applies if Individual, IndividualB2C, SingleOrg, or MultiOrg aren't used for --auth.",
"symbols/UseLocalDB/description": "Whether to use LocalDB instead of SQLite. This option only applies if --auth Individual or --auth IndividualB2C is specified.",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"symbols/Framework/description": "The target framework for the project.",
"symbols/Framework/choices/net7.0/description": "Target net7.0",
"symbols/skipRestore/description": "If specified, skips the automatic restore of the project on create.",
"symbols/Hosted/displayName": "ASP.NET Core Hosted",
"symbols/Hosted/description": "If specified, includes an ASP.NET Core host for the Blazor WebAssembly app.",
"symbols/auth/choices/None/description": "No authentication",
"symbols/auth/choices/Individual/description": "Individual authentication",
Expand All @@ -28,6 +29,7 @@
"symbols/kestrelHttpsPort/description": "Port number to use for the HTTPS endpoint in launchSettings.json. This option is only applicable when the parameter no-https is not used (no-https will be ignored if either IndividualAuth or OrganizationalAuth is used).",
"symbols/iisHttpPort/description": "Port number to use for the IIS Express HTTP endpoint in launchSettings.json.",
"symbols/iisHttpsPort/description": "Port number to use for the IIS Express HTTPS endpoint in launchSettings.json. This option is only applicable when the parameter no-https is not used (no-https will be ignored if either IndividualAuth or OrganizationalAuth is used).",
"symbols/PWA/displayName": "Progressive Web Application",
"symbols/PWA/description": "If specified, produces a Progressive Web Application (PWA) supporting installation and offline use.",
"symbols/NoHttps/description": "Whether to turn off HTTPS. This option only applies if Individual, IndividualB2C, SingleOrg, or MultiOrg aren't used for --auth.",
"symbols/UseLocalDB/description": "Whether to use LocalDB instead of SQLite. This option only applies if --auth Individual or --auth IndividualB2C is specified.",
Expand Down
Loading

0 comments on commit 36f34b3

Please sign in to comment.