Fix toggle for including sample content in template (#25549)

Redth · web-flow · commit ad6f752f70ce · 2024-10-28T20:28:55.000-04:00
### Description of Change This fixes the toggle for including sample content in the template. In #25419 some last-minute changes were made to not make the sample content show up by default, but that introduced a bug where you couldn't get the sample content to show up at all using Visual Studio. With this change the sample content can optionally be included again in Visual Studio by using the checkbox and through the CLI by specifying either `--sample-content` or `-sc`. Also the not used `Empty` switch was removed as well as the `SampleContent` variable which did not serve any additional purpose.
diff --git a/src/Templates/src/templates/maui-mobile/.template.config/dotnetcli.host.json b/src/Templates/src/templates/maui-mobile/.template.config/dotnetcli.host.json
@@ -4,11 +4,10 @@
       "Framework": {
         "longName": "framework"
       },
-      "Empty": {
-        "longName": "empty"
-      },
       "IncludeSampleContent": {
-        "isHidden": true
+
+        "longName":  "sample-content",
+        "shortName": "sc"
       },
       "skipRestore": {
         "longName": "no-restore",
diff --git a/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.cs.json b/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.cs.json
@@ -10,6 +10,5 @@
   "symbols/Framework/choices/DOTNET_TFM_VALUE/description": "Target DOTNET_TFM_VALUE",
   "symbols/IncludeSampleContent/displayName": "_Include sample content",
   "symbols/IncludeSampleContent/description": "Configures whether to add sample pages and functionality to demonstrate basic usage patterns.",
-  "symbols/Empty/description": "Configures whether to omit sample pages and styling that demonstrate basic usage patterns.",
   "symbols/skipRestore/description": "If specified, skips the automatic restore of the project on create."
 }
diff --git a/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.de.json b/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.de.json
@@ -10,6 +10,5 @@
   "symbols/Framework/choices/DOTNET_TFM_VALUE/description": "Target DOTNET_TFM_VALUE",
   "symbols/IncludeSampleContent/displayName": "_Include sample content",
   "symbols/IncludeSampleContent/description": "Configures whether to add sample pages and functionality to demonstrate basic usage patterns.",
-  "symbols/Empty/description": "Configures whether to omit sample pages and styling that demonstrate basic usage patterns.",
   "symbols/skipRestore/description": "If specified, skips the automatic restore of the project on create."
 }
diff --git a/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.en.json b/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.en.json
@@ -10,6 +10,5 @@
   "symbols/Framework/choices/DOTNET_TFM_VALUE/description": "Target DOTNET_TFM_VALUE",
   "symbols/IncludeSampleContent/displayName": "_Include sample content",
   "symbols/IncludeSampleContent/description": "Configures whether to add sample pages and functionality to demonstrate basic usage patterns.",
-  "symbols/Empty/description": "Configures whether to omit sample pages and styling that demonstrate basic usage patterns.",
   "symbols/skipRestore/description": "If specified, skips the automatic restore of the project on create."
 }
diff --git a/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.es.json b/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.es.json
@@ -10,6 +10,5 @@
   "symbols/Framework/choices/DOTNET_TFM_VALUE/description": "Target DOTNET_TFM_VALUE",
   "symbols/IncludeSampleContent/displayName": "_Include sample content",
   "symbols/IncludeSampleContent/description": "Configures whether to add sample pages and functionality to demonstrate basic usage patterns.",
-  "symbols/Empty/description": "Configures whether to omit sample pages and styling that demonstrate basic usage patterns.",
   "symbols/skipRestore/description": "If specified, skips the automatic restore of the project on create."
 }
diff --git a/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.fr.json b/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.fr.json
@@ -10,6 +10,5 @@
   "symbols/Framework/choices/DOTNET_TFM_VALUE/description": "Target DOTNET_TFM_VALUE",
   "symbols/IncludeSampleContent/displayName": "_Include sample content",
   "symbols/IncludeSampleContent/description": "Configures whether to add sample pages and functionality to demonstrate basic usage patterns.",
-  "symbols/Empty/description": "Configures whether to omit sample pages and styling that demonstrate basic usage patterns.",
   "symbols/skipRestore/description": "If specified, skips the automatic restore of the project on create."
 }
diff --git a/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.it.json b/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.it.json
@@ -10,6 +10,5 @@
   "symbols/Framework/choices/DOTNET_TFM_VALUE/description": "Target DOTNET_TFM_VALUE",
   "symbols/IncludeSampleContent/displayName": "_Include sample content",
   "symbols/IncludeSampleContent/description": "Configures whether to add sample pages and functionality to demonstrate basic usage patterns.",
-  "symbols/Empty/description": "Configures whether to omit sample pages and styling that demonstrate basic usage patterns.",
   "symbols/skipRestore/description": "If specified, skips the automatic restore of the project on create."
 }
diff --git a/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.ja.json b/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.ja.json
@@ -10,6 +10,5 @@
   "symbols/Framework/choices/DOTNET_TFM_VALUE/description": "Target DOTNET_TFM_VALUE",
   "symbols/IncludeSampleContent/displayName": "_Include sample content",
   "symbols/IncludeSampleContent/description": "Configures whether to add sample pages and functionality to demonstrate basic usage patterns.",
-  "symbols/Empty/description": "Configures whether to omit sample pages and styling that demonstrate basic usage patterns.",
   "symbols/skipRestore/description": "If specified, skips the automatic restore of the project on create."
 }
diff --git a/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.json b/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.json
@@ -10,6 +10,5 @@
   "symbols/Framework/choices/DOTNET_TFM_VALUE/description": "Target DOTNET_TFM_VALUE",
   "symbols/IncludeSampleContent/displayName": "_Include sample content",
   "symbols/IncludeSampleContent/description": "Configures whether to add sample pages and functionality to demonstrate basic usage patterns.",
-  "symbols/Empty/description": "Configures whether to omit sample pages and styling that demonstrate basic usage patterns.",
   "symbols/skipRestore/description": "If specified, skips the automatic restore of the project on create."
 }
diff --git a/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.ko.json b/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.ko.json
@@ -10,6 +10,5 @@
   "symbols/Framework/choices/DOTNET_TFM_VALUE/description": "Target DOTNET_TFM_VALUE",
   "symbols/IncludeSampleContent/displayName": "_Include sample content",
   "symbols/IncludeSampleContent/description": "Configures whether to add sample pages and functionality to demonstrate basic usage patterns.",
-  "symbols/Empty/description": "Configures whether to omit sample pages and styling that demonstrate basic usage patterns.",
   "symbols/skipRestore/description": "If specified, skips the automatic restore of the project on create."
 }
diff --git a/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.pl.json b/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.pl.json
@@ -10,6 +10,5 @@
   "symbols/Framework/choices/DOTNET_TFM_VALUE/description": "Target DOTNET_TFM_VALUE",
   "symbols/IncludeSampleContent/displayName": "_Include sample content",
   "symbols/IncludeSampleContent/description": "Configures whether to add sample pages and functionality to demonstrate basic usage patterns.",
-  "symbols/Empty/description": "Configures whether to omit sample pages and styling that demonstrate basic usage patterns.",
   "symbols/skipRestore/description": "If specified, skips the automatic restore of the project on create."
 }
diff --git a/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.pt-BR.json b/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.pt-BR.json
@@ -10,6 +10,5 @@
   "symbols/Framework/choices/DOTNET_TFM_VALUE/description": "Target DOTNET_TFM_VALUE",
   "symbols/IncludeSampleContent/displayName": "_Include sample content",
   "symbols/IncludeSampleContent/description": "Configures whether to add sample pages and functionality to demonstrate basic usage patterns.",
-  "symbols/Empty/description": "Configures whether to omit sample pages and styling that demonstrate basic usage patterns.",
   "symbols/skipRestore/description": "If specified, skips the automatic restore of the project on create."
 }
diff --git a/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.ru.json b/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.ru.json
@@ -10,6 +10,5 @@
   "symbols/Framework/choices/DOTNET_TFM_VALUE/description": "Target DOTNET_TFM_VALUE",
   "symbols/IncludeSampleContent/displayName": "_Include sample content",
   "symbols/IncludeSampleContent/description": "Configures whether to add sample pages and functionality to demonstrate basic usage patterns.",
-  "symbols/Empty/description": "Configures whether to omit sample pages and styling that demonstrate basic usage patterns.",
   "symbols/skipRestore/description": "If specified, skips the automatic restore of the project on create."
 }
diff --git a/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.tr.json b/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.tr.json
@@ -10,6 +10,5 @@
   "symbols/Framework/choices/DOTNET_TFM_VALUE/description": "Target DOTNET_TFM_VALUE",
   "symbols/IncludeSampleContent/displayName": "_Include sample content",
   "symbols/IncludeSampleContent/description": "Configures whether to add sample pages and functionality to demonstrate basic usage patterns.",
-  "symbols/Empty/description": "Configures whether to omit sample pages and styling that demonstrate basic usage patterns.",
   "symbols/skipRestore/description": "If specified, skips the automatic restore of the project on create."
 }
diff --git a/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.zh-Hans.json b/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.zh-Hans.json
@@ -10,6 +10,5 @@
   "symbols/Framework/choices/DOTNET_TFM_VALUE/description": "Target DOTNET_TFM_VALUE",
   "symbols/IncludeSampleContent/displayName": "_Include sample content",
   "symbols/IncludeSampleContent/description": "Configures whether to add sample pages and functionality to demonstrate basic usage patterns.",
-  "symbols/Empty/description": "Configures whether to omit sample pages and styling that demonstrate basic usage patterns.",
   "symbols/skipRestore/description": "If specified, skips the automatic restore of the project on create."
 }
diff --git a/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.zh-Hant.json b/src/Templates/src/templates/maui-mobile/.template.config/localize/templatestrings.zh-Hant.json
@@ -10,6 +10,5 @@
   "symbols/Framework/choices/DOTNET_TFM_VALUE/description": "Target DOTNET_TFM_VALUE",
   "symbols/IncludeSampleContent/displayName": "_Include sample content",
   "symbols/IncludeSampleContent/description": "Configures whether to add sample pages and functionality to demonstrate basic usage patterns.",
-  "symbols/Empty/description": "Configures whether to omit sample pages and styling that demonstrate basic usage patterns.",
   "symbols/skipRestore/description": "If specified, skips the automatic restore of the project on create."
 }
diff --git a/src/Templates/src/templates/maui-mobile/.template.config/template.json b/src/Templates/src/templates/maui-mobile/.template.config/template.json
@@ -58,7 +58,7 @@
         "copyOnly": [ "**/*.svg", "**/*.ttf" ],
         "modifiers": [
         {
-          "condition": "(!SampleContent)",
+          "condition": "(!IncludeSampleContent)",
           "exclude": [
             "Data/**",
             "GlobalUsings.cs",
@@ -75,7 +75,7 @@
           ]
         },
         {
-          "condition": "(SampleContent)",
+          "condition": "(IncludeSampleContent)",
           "exclude": [
             "MainPage.xaml",
             "MainPage.xaml.cs"
@@ -180,16 +180,6 @@
         "defaultValue": "false",
         "displayName": "_Include sample content",
         "description": "Configures whether to add sample pages and functionality to demonstrate basic usage patterns."
-      },  
-      "Empty": {
-        "type": "parameter",
-        "datatype": "bool",
-        "defaultValue": "true",
-        "description": "Configures whether to omit sample pages and styling that demonstrate basic usage patterns."
-      },
-      "SampleContent": {
-        "type": "computed",
-        "value": "((IncludeSampleContent && (HostIdentifier == \"dotnetcli\" || HostIdentifier == \"dotnetcli-preview\")))"
       },
       "skipRestore": {
         "type": "parameter",
diff --git a/src/Templates/src/templates/maui-mobile/App.xaml b/src/Templates/src/templates/maui-mobile/App.xaml
@@ -8,7 +8,7 @@
             <ResourceDictionary.MergedDictionaries>
                 <ResourceDictionary Source="Resources/Styles/Colors.xaml" />
                 <ResourceDictionary Source="Resources/Styles/Styles.xaml" />
-<!--#if (SampleContent) -->
+<!--#if (IncludeSampleContent) -->
                 <ResourceDictionary Source="Resources/Styles/AppStyles.xaml" />
 <!--#endif -->
             </ResourceDictionary.MergedDictionaries>
diff --git a/src/Templates/src/templates/maui-mobile/AppShell.xaml b/src/Templates/src/templates/maui-mobile/AppShell.xaml
@@ -3,23 +3,23 @@
     x:Class="MauiApp._1.AppShell"
     xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
     xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
-<!--#if (SampleContent) -->
+<!--#if (IncludeSampleContent) -->
     xmlns:sf="clr-namespace:Syncfusion.Maui.Toolkit.SegmentedControl;assembly=Syncfusion.Maui.Toolkit"
     xmlns:pages="clr-namespace:MauiApp._1.Pages"
 <!--#endif -->
-<!--#if (!SampleContent) -->
+<!--#if (!IncludeSampleContent) -->
     xmlns:local="clr-namespace:MauiApp._1"
 <!--#endif -->
     Shell.FlyoutBehavior="Flyout"
     Title="MauiApp._1">
 
-<!--#if (!SampleContent) -->
+<!--#if (!IncludeSampleContent) -->
     <ShellContent
         Title="Home"
         ContentTemplate="{DataTemplate local:MainPage}"
         Route="MainPage" />
 <!--#endif -->
-<!--#if (SampleContent) -->
+<!--#if (IncludeSampleContent) -->
     <ShellContent
         Title="Dashboard"
         Icon="{StaticResource IconDashboard}"
diff --git a/src/Templates/src/templates/maui-mobile/AppShell.xaml.cs b/src/Templates/src/templates/maui-mobile/AppShell.xaml.cs
@@ -1,4 +1,4 @@
-﻿#if (SampleContent)
+﻿#if (IncludeSampleContent)
 using CommunityToolkit.Maui.Alerts;
 using CommunityToolkit.Maui.Core;
 using Font = Microsoft.Maui.Font;
@@ -10,12 +10,12 @@ public partial class AppShell : Shell
 	public AppShell()
 	{
 		InitializeComponent();
-#if (SampleContent)
+#if (IncludeSampleContent)
 		var currentTheme = Application.Current!.UserAppTheme;		
 		ThemeSegmentedControl.SelectedIndex = currentTheme == AppTheme.Light ? 0 : 1;
 #endif
 	}
-#if (SampleContent)
+#if (IncludeSampleContent)
 	public static async Task DisplaySnackbarAsync(string message)
 	{
 		CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();
diff --git a/src/Templates/src/templates/maui-mobile/MauiApp.1.csproj b/src/Templates/src/templates/maui-mobile/MauiApp.1.csproj
@@ -19,7 +19,7 @@
 		<SingleProject>true</SingleProject>
 		<ImplicitUsings>enable</ImplicitUsings>
 		<Nullable>enable</Nullable>
-<!--#if (SampleContent) -->
+<!--#if (IncludeSampleContent) -->
 		<!-- https://github.com/CommunityToolkit/Maui/issues/2205 -->
 		<NoWarn>XC0103</NoWarn>
 		<MauiEnableXamlCBindingWithSourceCompilation>true</MauiEnableXamlCBindingWithSourceCompilation>
@@ -69,7 +69,7 @@
 		<PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="MS_EXT_LOG_DEBUG_VERSION" />
 	</ItemGroup>
 
-<!--#if (SampleContent) -->
+<!--#if (IncludeSampleContent) -->
 	<ItemGroup>
 		<PackageReference Include="CommunityToolkit.Mvvm" Version="8.3.2" />
 		<PackageReference Include="CommunityToolkit.Maui" Version="9.1.0" />
diff --git a/src/Templates/src/templates/maui-mobile/MauiProgram.cs b/src/Templates/src/templates/maui-mobile/MauiProgram.cs
@@ -1,8 +1,8 @@
-﻿#if (SampleContent)
+﻿#if (IncludeSampleContent)
 using CommunityToolkit.Maui;
 #endif
 using Microsoft.Extensions.Logging;
-#if (SampleContent)
+#if (IncludeSampleContent)
 using Syncfusion.Maui.Toolkit.Hosting;
 #endif
 
@@ -15,7 +15,7 @@ public static MauiApp CreateMauiApp()
 		var builder = MauiApp.CreateBuilder();
 		builder
 			.UseMauiApp<App>()
-#if (SampleContent)
+#if (IncludeSampleContent)
 			.UseMauiCommunityToolkit()
 			.ConfigureSyncfusionToolkit()
 			.ConfigureMauiHandlers(handlers =>
@@ -29,7 +29,7 @@ public static MauiApp CreateMauiApp()
 			{
 				fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");
 				fonts.AddFont("OpenSans-Semibold.ttf", "OpenSansSemibold");
-#if (SampleContent)
+#if (IncludeSampleContent)
 				fonts.AddFont("SegoeUI-Semibold.ttf", "SegoeSemibold");
 				fonts.AddFont("FluentSystemIcons-Regular.ttf", FluentUI.FontFamily);
 #endif
@@ -39,14 +39,14 @@ public static MauiApp CreateMauiApp()
 #if DEBUG
 		builder.Logging.AddDebug();
 //+:cnd:noEmit
-#if (SampleContent)
+#if (IncludeSampleContent)
 		builder.Services.AddLogging(configure => configure.AddDebug());
 #endif
 //-:cnd:noEmit
 #endif
 //+:cnd:noEmit
 
-#if (SampleContent)
+#if (IncludeSampleContent)
 		builder.Services.AddSingleton<ProjectRepository>();
 		builder.Services.AddSingleton<TaskRepository>();
 		builder.Services.AddSingleton<CategoryRepository>();
diff --git a/src/Templates/src/templates/maui-mobile/Resources/Styles/Colors.xaml b/src/Templates/src/templates/maui-mobile/Resources/Styles/Colors.xaml
@@ -13,7 +13,7 @@
     <Color x:Key="SecondaryDarkText">#9880e5</Color>
     <Color x:Key="Tertiary">#2B0B98</Color>
 
-<!--#if (SampleContent) -->
+<!--#if (IncludeSampleContent) -->
     <Color x:Key="DarkBackground">#17171a</Color>
     <Color x:Key="LightOnDarkBackground">#C3C3C3</Color>
     <Color x:Key="LightBackground">#F2F2F2</Color>
diff --git a/src/Templates/src/templates/maui-mobile/Resources/Styles/Styles.xaml b/src/Templates/src/templates/maui-mobile/Resources/Styles/Styles.xaml
diff --git a/src/TestUtils/src/Microsoft.Maui.IntegrationTests/SimpleTemplateTest.cs b/src/TestUtils/src/Microsoft.Maui.IntegrationTests/SimpleTemplateTest.cs

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,5 @@`
`10`	`10`	`"symbols/Framework/choices/DOTNET_TFM_VALUE/description": "Target DOTNET_TFM_VALUE",`
`11`	`11`	`"symbols/IncludeSampleContent/displayName": "_Include sample content",`
`12`	`12`	`"symbols/IncludeSampleContent/description": "Configures whether to add sample pages and functionality to demonstrate basic usage patterns.",`
`13`		`- "symbols/Empty/description": "Configures whether to omit sample pages and styling that demonstrate basic usage patterns.",`
`14`	`13`	`"symbols/skipRestore/description": "If specified, skips the automatic restore of the project on create."`
`15`	`14`	`}`