Merge pull request #807 from nhirschey/eval

One fsiEvaluator per docs file
fsprojects · Mar 9, 2023 · 55253a4 · 55253a4
2 parents 1f3dab5 + 5be31ca
commit 55253a4
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 11 deletions.
diff --git a/.paket/Paket.Restore.targets b/.paket/Paket.Restore.targets
@@ -111,7 +111,7 @@
     <MSBuild Projects="$(PaketToolsPath)paket.bootstrapper.proj" Targets="Restore" />
   </Target>
 
-  <!-- Official workaround for https://learn.microsoft.com/en-us/visualstudio/msbuild/getfilehash-task?view=vs-2019 -->
+  <!-- Official workaround for https://docs.microsoft.com/en-us/visualstudio/msbuild/getfilehash-task?view=vs-2019 -->
   <UsingTask TaskName="Microsoft.Build.Tasks.GetFileHash" AssemblyName="Microsoft.Build.Tasks.Core, Version=15.1.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" Condition=" '$(MSBuildSupportsHashing)' == 'true' And '$(DetectedMSBuildVersion)' &lt; '16.0.360' " />
   <UsingTask TaskName="Microsoft.Build.Tasks.VerifyFileHash" AssemblyName="Microsoft.Build.Tasks.Core, Version=15.1.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" Condition=" '$(MSBuildSupportsHashing)' == 'true' And '$(DetectedMSBuildVersion)' &lt; '16.0.360' " />
   <Target Name="PaketRestore" Condition="'$(PaketRestoreDisabled)' != 'True'" BeforeTargets="_GenerateDotnetCliToolReferenceSpecs;_GenerateProjectRestoreGraphPerFramework;_GenerateRestoreGraphWalkPerFramework;CollectPackageReferences" DependsOnTargets="SetPaketCommand;PaketBootstrapping">

diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -1,3 +1,7 @@
+## 17.4.0
+
+* One FSI evaluator per docs file [#737](https://github.com/fsprojects/FSharp.Formatting/issues/737)
+
 ## 17.3.0
 
 * Better test project detection [#800](https://github.com/fsprojects/FSharp.Formatting/issues/800)

diff --git a/src/fsdocs-tool/BuildCommand.fs b/src/fsdocs-tool/BuildCommand.fs
@@ -35,7 +35,7 @@ type internal DocContent
         rootOutputFolderAsGiven,
         previous: Map<_, _>,
         lineNumbers,
-        fsiEvaluator,
+        evaluate,
         substitutions,
         saveImages,
         watch,
@@ -252,6 +252,12 @@ type internal DocContent
                       if isFsx then
                           printfn "  generating model for %s --> %s" inputFileFullPath outputFileRelativeToRoot
 
+                          let fsiEvaluator =
+                              (if evaluate then
+                                   Some(FsiEvaluator(onError = onError) :> IFsiEvaluator)
+                               else
+                                   None)
+
                           let model =
                               Literate.ParseAndTransformScriptFile(
                                   inputFileFullPath,
@@ -1579,18 +1585,12 @@ type CoreBuildOptions(watch) =
                      | "all" -> Some true
                      | _ -> None)
 
-                let fsiEvaluator =
-                    (if this.eval then
-                         Some(FsiEvaluator(onError = onError) :> IFsiEvaluator)
-                     else
-                         None)
-
                 let docContent =
                     DocContent(
                         rootOutputFolderAsGiven,
                         latestDocContentResults,
                         Some this.linenumbers,
-                        fsiEvaluator,
+                        this.eval,
                         docsSubstitutions,
                         saveImages,
                         watch,

diff --git a/tests/FSharp.Literate.Tests/DocContentTests.fs b/tests/FSharp.Literate.Tests/DocContentTests.fs
@@ -26,7 +26,7 @@ let ``Can build doc content`` () =
             rootOutputFolderAsGiven,
             Map.empty,
             lineNumbers = None,
-            fsiEvaluator = None,
+            evaluate = false,
             substitutions = [],
             saveImages = None,
             watch = false,
@@ -115,7 +115,7 @@ let ``Can build doc content using relative input path`` () =
             rootOutputFolderAsGiven,
             Map.empty,
             lineNumbers = None,
-            fsiEvaluator = None,
+            evaluate = false,
             substitutions = [],
             saveImages = None,
             watch = false,