change targets to work for multiple TFMs

ionide · Oct 30, 2023 · 9b82d41 · 9b82d41
1 parent 79da4aa
commit 9b82d41
Showing 1 changed file with 56 additions and 9 deletions.
diff --git a/docs/content/Getting Started Using.fsx b/docs/content/Getting Started Using.fsx
@@ -81,15 +81,17 @@ This adds the package reference to all `.fsproj` files that are in a subfolder o
 </ItemGroup>
 ```
 
-Likewise we add the following custom target to the [Directory.Build.targets](https://learn.microsoft.com/en-us/visualstudio/msbuild/customize-by-directory?view=vs-2022) file.  
+Likewise we add the following custom target to the [Directory.Build.targets](https://learn.microsoft.com/en-us/visualstudio/msbuild/customize-by-directory?view=vs-2022) file.
 This is effectively the same as adding a target to each `*proj` file which exists in a subfolder.
 ```xml
 <Project>
 
+    <!-- Contract: only one TFM.
+         This actually calls the analyzer CLI -->
     <Target
-        Name="AnalyzeProject">
-        
-        <Message Importance="normal" Text="fsc arguments: @(FscCommandLineArgs)" />
+        Name="_AnalyzeProjectInner">
+
+        <Message Importance="Normal" Text="fsc arguments: @(FscCommandLineArgs)" />
         <Message Importance="High" Text="Analyzing $(MSBuildProjectFile)"/>
         <Exec
             ContinueOnError="true"
@@ -100,6 +102,29 @@ This is effectively the same as adding a target to each `*proj` file which exist
 
     </Target>
 
+    <Target
+        Name="AnalyzeProject" >
+
+        <!-- TFMs but no TF -> multitarget, analyzing for each TFM -->
+        <ItemGroup Condition="'$(TargetFrameworks)' != ''
+                            and '$(TargetFramework)' == ''" >
+            <_TFMItems Include="$(TargetFrameworks)" />
+            <_SingleTfmAnalysis Include="$(MSBuildProjectFullPath)"
+                AdditionalProperties="TargetFramework=%(_TFMItems.Identity);"
+                UndefineProperties="TargetFrameworks" />
+        </ItemGroup>
+
+        <!-- TF but no TFMs -> single analysis -->
+        <ItemGroup Condition="'$(TargetFramework)' != ''">
+            <_SingleTfmAnalysis Include="$(MSBuildProjectFullPath)" />
+        </ItemGroup>
+
+        <!-- Now fire off those analyses -->
+        <MSBuild Projects="@(_SingleTfmAnalysis)"
+            Targets="_AnalyzeProjectInner"
+            BuildInParallel="true" />
+    </Target>
+
 </Project>
 ```
 
@@ -154,6 +179,7 @@ Here's how the `Directory.Solution.targets` file would look like to make the use
         <MSBuild
                 Projects="@(ProjectsToAnalyze)"
                 Targets="AnalyzeProject"
+                BuildInParallel="true"
                 Properties="DesignTimeBuild=True;Configuration=Release;ProvideCommandLineArgs=True;SkipCompilerExecution=True" />
     </Target>
 
@@ -163,20 +189,41 @@ Here's how the `Directory.Solution.targets` file would look like to make the use
 And here's the `Directory.Build.targets`:
 ```xml
 <Project>
-
-    <Target
-        Name="AnalyzeProject" 
+    <!-- Contract: only one TFM.
+         This actually calls the analyzer CLI -->
+    <Target Name="_AnalyzeProjectInner"
         DependsOnTargets="Restore;ResolveAssemblyReferencesDesignTime;ResolveProjectReferencesDesignTime;ResolvePackageDependenciesDesignTime;FindReferenceAssembliesForReferences;_GenerateCompileDependencyCache;_ComputeNonExistentFileProperty;BeforeBuild;BeforeCompile;CoreCompile">
-        
-        <Message Importance="normal" Text="fsc arguments: @(FscCommandLineArgs)" />
+        <Message Importance="Normal" Text="fsc arguments: @(FscCommandLineArgs)" />
         <Message Importance="High" Text="Analyzing $(MSBuildProjectFile)"/>
         <Exec
             ContinueOnError="true"
             Command="dotnet fsharp-analyzers --fsc-args &quot;@(FscCommandLineArgs)&quot; --analyzers-path &quot;$(PkgG-Research_FSharp_Analyzers)\analyzers\dotnet\fs&quot; --exclude-analyzer PartialAppAnalyzer --fail-on-warnings GRA-STRING-001 --verbose --report &quot;$(MSBuildProjectName)-analysis.sarif&quot;">
             <Output TaskParameter="ExitCode" PropertyName="LastExitCode" />
         </Exec>
         <Error Condition="'$(LastExitCode)' == '-2'" Text="Problems were found $(MSBuildProjectFile)" />
+    </Target>
 
+    <Target
+        Name="AnalyzeProject" >
+
+        <!-- TFMs but no TF -> multitarget, analyzing for each TFM -->
+        <ItemGroup Condition="'$(TargetFrameworks)' != ''
+                            and '$(TargetFramework)' == ''" >
+            <_TFMItems Include="$(TargetFrameworks)" />
+            <_SingleTfmAnalysis Include="$(MSBuildProjectFullPath)"
+                AdditionalProperties="TargetFramework=%(_TFMItems.Identity);"
+                UndefineProperties="TargetFrameworks" />
+        </ItemGroup>
+
+        <!-- TF but no TFMs -> single analysis -->
+        <ItemGroup Condition="'$(TargetFramework)' != ''">
+            <_SingleTfmAnalysis Include="$(MSBuildProjectFullPath)" />
+        </ItemGroup>
+
+        <!-- Now fire off those analyses -->
+        <MSBuild Projects="@(_SingleTfmAnalysis)"
+            Targets="_AnalyzeProjectInner"
+            BuildInParallel="true" />
     </Target>
 
 </Project>