Prevent WinUI item templates from showing up in other project types #2289
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
added
the
|
Adding Ryan and Evelyn since I don't own the templates and they've worked on them in the past, but LGTM 👍 |
RealTommyKlein
approved these changes
Mar 18, 2022
|
@evelynwu-msft @ShashankNay I tested the VSIX that has my changes. The results can be found in the PR description. It appears to be working correctly now. How can I run the status checks for this PR? |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
ShashankNay
approved these changes
Mar 22, 2022
evelynwu-msft
pushed a commit
that referenced
this pull request
Jun 17, 2022
…ates ## Problem In a [previous PR](#2289), I attempted to prevent the WinUI C# templates from appearing in projects unrelated to WinUI. To do so, I set the [ShowByDefault](https://docs.microsoft.com/en-us/visualstudio/extensibility/showbydefault-visual-studio-templates?view=vs-2022) property to `false`. When this property is `false`, the decision to show/hide the item templates falls to the [AppliesTo](https://docs.microsoft.com/en-us/visualstudio/extensibility/appliesto-element-visual-studio-templates?view=vs-2022) and [TemplateGroupID](https://docs.microsoft.com/en-us/visualstudio/extensibility/templategroupid-element-visual-studio-templates?view=vs-2022) properties. The C# templates currently hold the value `CSharp + SharedAssetsProject`. However, an examination of the capabilities for a WinUI project reveals that `SharedAssetsProject` is no longer present:  The C++ templates currently hold no value for `AppliesTo` and `TemplateGroupID`. ## Solution For the C# templates, we can adjust the value for `AppliesTo` to be `CSharp + WindowsAppSdk`. For the C++ templates, we can add the property `AppliesTo` with value `VisualC + WindowsAppSdk`. We can also add the property `TemplateGroupID` with value `WinRT-Native-UAP`, which comes from this table ([link](https://docs.microsoft.com/en-us/visualstudio/extensibility/templategroupid-element-visual-studio-templates?view=vs-2022)):  ## C#  ## C++  ## Work Item microsoft/microsoft-ui-xaml#7148 (cherry picked from commit ea92f45)
evelynwu-msft
added a commit
that referenced
this pull request
Jun 17, 2022
…ates (#2641) ## Problem In a [previous PR](#2289), I attempted to prevent the WinUI C# templates from appearing in projects unrelated to WinUI. To do so, I set the [ShowByDefault](https://docs.microsoft.com/en-us/visualstudio/extensibility/showbydefault-visual-studio-templates?view=vs-2022) property to `false`. When this property is `false`, the decision to show/hide the item templates falls to the [AppliesTo](https://docs.microsoft.com/en-us/visualstudio/extensibility/appliesto-element-visual-studio-templates?view=vs-2022) and [TemplateGroupID](https://docs.microsoft.com/en-us/visualstudio/extensibility/templategroupid-element-visual-studio-templates?view=vs-2022) properties. The C# templates currently hold the value `CSharp + SharedAssetsProject`. However, an examination of the capabilities for a WinUI project reveals that `SharedAssetsProject` is no longer present:  The C++ templates currently hold no value for `AppliesTo` and `TemplateGroupID`. ## Solution For the C# templates, we can adjust the value for `AppliesTo` to be `CSharp + WindowsAppSdk`. For the C++ templates, we can add the property `AppliesTo` with value `VisualC + WindowsAppSdk`. We can also add the property `TemplateGroupID` with value `WinRT-Native-UAP`, which comes from this table ([link](https://docs.microsoft.com/en-us/visualstudio/extensibility/templategroupid-element-visual-studio-templates?view=vs-2022)):  ## C#  ## C++  ## Work Item microsoft/microsoft-ui-xaml#7148 (cherry picked from commit ea92f45) Co-authored-by: James Parsons <japarson@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
WinUI item templates are appearing in projects where they do not belong. For example, here they are appearing in a C# console application:
Solution
In the .vstemplate files for each project item, there is a TemplateGroupID property that specifies what kind of project an item templates will show up in. The WinUI item templates correctly set this property. However, there is a ShowByDefault property which specifies that the template will only be displayed under the specified
TemplateGroupIDwhen set tofalse.The current WinUI item templates have
ShowByDefaultset totrueand the solution here it to set them tofalse.Demo
The item templates no longer appear in a C# console application:
And they still appear in a WinUI app:
Work Item
Bug 1433670: WinUI C# templates are available to incompatible projects