Use relative paths to resolve single-experiment labs

Author: Arlodotexe

common/CommunityToolkit.Labs.Core.SourceGenerators/ToolkitSampleMetadataGenerator.Sample.cs

@@ -121,7 +121,7 @@ void Execute(IncrementalValuesProvider<ISymbol> types, bool skipDiagnostics = fa
                     );
 
                 var docFrontMatter = GatherDocumentFrontMatter(ctx, markdownFileData);
-
+                
                 if (isExecutingInSampleProject && !skipDiagnostics)
                 {
                     ReportSampleDiagnostics(ctx, toolkitSampleAttributeData, optionsPaneAttribute, generatedOptionPropertyData);

common/CommunityToolkit.Labs.Shared/Renderers/ToolkitDocumentationRenderer.xaml.cs

@@ -153,7 +153,31 @@ private void SampleListHyperlink_Click(object sender, RoutedEventArgs e)
 
         private static async Task<string> GetDocumentationFileContents(ToolkitFrontMatter metadata)
         {
-            var fileUri = new Uri($"ms-appx:///SourceAssets/{metadata.FilePath}");
+            // MSBuild uses wildcard to find the files, and the wildcards decide where they end up
+            // Single experiments use relative paths, the allExperiment head uses absolute paths that grab from all experiments
+            // The wildcard captures decide the paths. This discrepency is accounted for manually.
+            // Logic here is the exact same that MSBuild uses to find and include the files we need.
+            var assemblyName = typeof(ToolkitSampleRenderer).Assembly.GetName().Name;
+            if (string.IsNullOrWhiteSpace(assemblyName))
+                throw new InvalidOperationException();
+
+            var isAllExperimentHead = assemblyName.StartsWith("CommunityToolkit.Labs.", StringComparison.OrdinalIgnoreCase);
+            var isProjectTemplateHead = assemblyName.StartsWith("ProjectTemplate");
+            var isSingleExperimentHead = !isAllExperimentHead && !isProjectTemplateHead;
+
+            if (metadata.FilePath is null || string.IsNullOrWhiteSpace(metadata.FilePath))
+                throw new InvalidOperationException("Missing or malformed path to markdown file. Unable to continue;");
+
+            var path = metadata.FilePath;
+
+            if (isSingleExperimentHead || isProjectTemplateHead)
+            {
+                var experimentName = assemblyName.Split(".")[0];
+                path = path.Split($"\\{experimentName}.Sample")[1];
+                path = $"{experimentName}.Sample{path}";
+            }
+
+            var fileUri = new Uri($"ms-appx:///SourceAssets/{path}");
 
             try
             {

common/CommunityToolkit.Labs.Shared/Renderers/ToolkitSampleRenderer.xaml.cs

@@ -89,7 +89,6 @@ public UIElement? SampleControlInstance
             set => SetValue(SampleControlInstanceProperty, value);
         }
 
-
         /// <summary>
         /// The options pane for the sample being displayed.
         /// </summary>
@@ -203,9 +202,12 @@ private static string GetRelativePathToFileWithoutExtension(Type type)
         {
             // MSBuild uses wildcard to find the files, and the wildcards decide where they end up
             // Single experiments use relative paths, the allExperiment head uses absolute paths that grab from all experiments
-            // The discrepency is accounted for manually.
+            // The wildcard captures decide the paths. This discrepency is accounted for manually.
             // Logic here is the exact same that MSBuild uses to find and include the files we need.
             var assemblyName = typeof(ToolkitSampleRenderer).Assembly.GetName().Name;
+            if (string.IsNullOrWhiteSpace(assemblyName))
+                throw new InvalidOperationException();
+
             var isAllExperimentHead = assemblyName.StartsWith("CommunityToolkit.Labs.", StringComparison.OrdinalIgnoreCase);
             var isProjectTemplateHead = assemblyName.StartsWith("ProjectTemplate");
             var isSingleExperimentHead = !isAllExperimentHead && !isProjectTemplateHead;

common/Labs.Head.props

@@ -25,10 +25,10 @@
   <PropertyGroup>
     <IsAllExperimentHead Condition="$(MSBuildProjectName.StartsWith('CommunityToolkit.Labs.')) == 'true'">true</IsAllExperimentHead>
     <IsProjectTemplateHead Condition="$(MSBuildProjectName.StartsWith('ProjectTemplate')) == 'true'">true</IsProjectTemplateHead>
-    <IsSingleExperimentHead Condition="$(IsAllExperimentHead) == 'false' AND $(IsProjectTemplateHead) == 'false'">true</IsSingleExperimentHead>
+    <IsSingleExperimentHead Condition="'$(IsAllExperimentHead)' != 'true' AND '$(IsProjectTemplateHead)' != 'true'">true</IsSingleExperimentHead>
   </PropertyGroup>
 
-  <ItemGroup Condition="$(IsAllExperimentHead) == 'true'">
+  <ItemGroup Condition="'$(IsAllExperimentHead)' == 'true'">
     <!-- These are also included in Labs.Samples.props, but added here to workaround https://github.com/unoplatform/uno/issues/2502 -->
     <Content Include="$(RepositoryDirectory)labs\**\samples\*.Sample\**\*.md" Exclude="$(RepositoryDirectory)**\**\samples\*.Sample\obj\**\*.md;$(RepositoryDirectory)**\**\samples\*.Sample\bin\**\*.md;$(RepositoryDirectory)\**\SourceAssets\**\*.md"  Link="SourceAssets/%(RecursiveDir)%(FileName)%(Extension)"/>
     <Content Include="$(RepositoryDirectory)labs\**\samples\*.Sample\**\*.xaml" Exclude="$(RepositoryDirectory)**\**\samples\*.Sample\obj\**\*.xaml;$(RepositoryDirectory)**\**\samples\*.Sample\bin\**\*.xaml;$(RepositoryDirectory)\**\SourceAssets\**\*.xaml"  Link="SourceAssets/%(RecursiveDir)%(FileName)%(Extension)"/>
@@ -40,7 +40,7 @@
     <AdditionalFiles Include="$(RepositoryDirectory)labs\**\samples\*.Sample\**\*.md"  Exclude="$(RepositoryDirectory)**\**\samples\**\obj\**\*.md;$(RepositoryDirectory)**\**\samples\**\bin\**\*.md"/>
   </ItemGroup>
 
-  <ItemGroup Condition="$(IsSingleExperimentHead) == 'true'">
+  <ItemGroup Condition="'$(IsSingleExperimentHead)' == 'true' or '$(IsProjectTemplateHead)' == 'true'">
     <!-- These are also included in Labs.Samples.props, but added here to workaround https://github.com/unoplatform/uno/issues/2502 -->
     <Content Include="..\*.Sample\**\*.md" Exclude="..\*.Sample\obj\**\*.md;..\*.Sample\bin\**\*.md;..\**\SourceAssets\**\*.md"  Link="SourceAssets/%(RecursiveDir)%(FileName)%(Extension)"/>
     <Content Include="..\*.Sample\**\*.xaml" Exclude="..\*.Sample\obj\**\*.xaml;..\*.Sample\bin\**\*.xaml;..\**\SourceAssets\**\*.xaml"  Link="SourceAssets/%(RecursiveDir)%(FileName)%(Extension)"/>
@@ -49,19 +49,7 @@
     <Content Include="..\*.Sample\**\*.cs" Exclude="..\*.Sample\obj\**\*.cs;..\*.Sample\bin\**\*.cs" Link="SourceAssets/%(RecursiveDir)%(FileName)%(Extension).dat" />
 
     <!-- Include markdown files from all samples so the head can access them in the source generator -->
-    <AdditionalFiles Include="..\*.Sample\**\*.md"  Exclude="..\**\obj\**\*.md;..\**\bin\**\*.md"/>
-  </ItemGroup>
-
-  <ItemGroup Condition="$(IsProjectTemplateHead) == 'true'">
-    <!-- These are also included in Labs.Samples.props, but added here to workaround https://github.com/unoplatform/uno/issues/2502 -->
-    <Content Include="$(RepositoryDirectory)template\**\samples\*.Sample\**\*.md" Exclude="$(RepositoryDirectory)**\**\samples\*.Sample\obj\**\*.md;$(RepositoryDirectory)**\**\samples\*.Sample\bin\**\*.md;$(RepositoryDirectory)\**\SourceAssets\**\*.md"  Link="SourceAssets/%(RecursiveDir)%(FileName)%(Extension)"/>
-    <Content Include="$(RepositoryDirectory)template\**\samples\*.Sample\**\*.xaml" Exclude="$(RepositoryDirectory)**\**\samples\*.Sample\obj\**\*.xaml;$(RepositoryDirectory)**\**\samples\*.Sample\bin\**\*.xaml;$(RepositoryDirectory)\**\SourceAssets\**\*.xaml"  Link="SourceAssets/%(RecursiveDir)%(FileName)%(Extension)"/>
-
-    <!-- Link/.dat is a workaround for https://github.com/unoplatform/uno/issues/8649 -->
-    <Content Include="$(RepositoryDirectory)template\**\samples\*.Sample\**\*.cs" Exclude="$(RepositoryDirectory)**\**\samples\*.Sample\obj\**\*.cs;$(RepositoryDirectory)**\**\samples\*.Sample\bin\**\*.cs" Link="SourceAssets/%(RecursiveDir)%(FileName)%(Extension).dat" />
-  
-    <!-- Include markdown files from al lsamples so the head can access them in the source generator -->
-    <AdditionalFiles Include="$(RepositoryDirectory)template\**\samples\*.Sample\**\*.md" Exclude="$(RepositoryDirectory)**\**\samples\*.Sample\obj\**\*.md;$(RepositoryDirectory)**\**\samples\*.Sample\bin\**\*.md"/>  
+    <AdditionalFiles Include="$(MSBuildProjectDirectory)\..\*.Sample\**\*.md"  Exclude="$(MSBuildProjectDirectory)\..\**\obj\**\*.md;$(MSBuildProjectDirectory)\..\**\bin\**\*.md"/>
   </ItemGroup>
 
   <PropertyGroup>