Merge branch 'main' into repo-assist/fix-issue-924-watch-root-override-c4e35a7b2fb520aa

Author: dsyme

RELEASE_NOTES.md

@@ -4,6 +4,7 @@
 
 ### Added
 * Add `--root` option to `fsdocs watch` to override the root URL for generated pages. Useful for serving docs via GitHub Codespaces, reverse proxies, or other remote hosting where `localhost` URLs are inaccessible. E.g. `fsdocs watch --root /` or `fsdocs watch --root https://example.com/docs/`. When not set, defaults to `http://localhost:<port>/` as before. [#924](https://github.com/fsprojects/FSharp.Formatting/issues/924)
+* Search dialog now auto-focuses the search input when opened, clears on close, and can be triggered with `Ctrl+K` / `Cmd+K` in addition to `/`.
 * Add `dotnet fsdocs convert` command to convert a single `.md`, `.fsx`, or `.ipynb` file to HTML (or another output format) without building a full documentation site. [#811](https://github.com/fsprojects/FSharp.Formatting/issues/811)
 * `fsdocs convert` now accepts the input file as a positional argument (e.g. `fsdocs convert notebook.ipynb -o notebook.html`). [#1019](https://github.com/fsprojects/FSharp.Formatting/pull/1019)
 * `fsdocs convert` infers the output format from the output file extension when `--outputformat` is not specified (e.g. `-o out.md` implies `--outputformat markdown`). [#1019](https://github.com/fsprojects/FSharp.Formatting/pull/1019)

build.fsx

@@ -49,6 +49,17 @@ let testStage =
             $"dotnet test {solutionFile} --configuration {configuration} --no-build --blame --logger trx --results-directory TestResults -tl"
     }
 
+// Standalone doc-script type-check using the locally built fsdocs tool.
+// Assumes the solution has been built (e.g. after running the CI pipeline or
+// `dotnet build`). Catches type errors in .fsx documentation sources early,
+// matching the `--strict` check in the full GenerateDocs stage.
+let fsdocsLocalBin =
+    let ext = if System.OperatingSystem.IsWindows() then ".exe" else ""
+    $"src/fsdocs-tool/bin/Release/net10.0/fsdocs{ext}"
+
+let checkDocScriptsStage =
+    stage "CheckDocScripts" { run $"\"{fsdocsLocalBin}\" build --strict --clean --properties Configuration=Release" }
+
 pipeline "CI" {
     lintStage
 
@@ -68,6 +79,8 @@ pipeline "CI" {
 
     testStage
 
+    checkDocScriptsStage
+
     stage "GenerateDocs" {
         // Skip on Windows CI runners: docs are only deployed from Linux
         whenNot { envVar "RUNNER_OS" "Windows" }
@@ -92,6 +105,7 @@ pipeline "Verify" {
     lintStage
     testStage
     stage "Analyzers" { run "dotnet msbuild /t:AnalyzeSolution" }
+    checkDocScriptsStage
     runIfOnlySpecified true
 }
 

docs/content/fsdocs-search.js

@@ -51,14 +51,23 @@ if (root && searchBtn) {
     const resultsElement = document.querySelector("dialog ul");
     const searchBox = document.querySelector("dialog input[type=search]");
 
-    searchBtn.addEventListener("click", () => {
+    function openSearch() {
         searchDialog.showModal();
-    })
+        searchBox.focus();
+    }
+
+    function closeSearch() {
+        searchBox.value = '';
+        empty.textContent = "Type something to start searching.";
+        clearResults();
+        searchDialog.close();
+    }
+
+    searchBtn.addEventListener("click", openSearch)
 
     searchDialog.addEventListener("click", ev => {
         if (ev.target.tagName === "DIALOG") {
-            searchBox.value = '';
-            searchDialog.close()
+            closeSearch();
         }
     })
 
@@ -112,13 +121,21 @@ if (root && searchBtn) {
         }
     });
 
-    window.addEventListener('keyup', ev => {
+    window.addEventListener('keydown', ev => {
         if (ev.key === 'Escape' && searchDialog.open) {
-            searchDialog.close();
+            ev.preventDefault();
+            closeSearch();
         }
 
-        if (ev.key === '/' && !searchDialog.open) {
-            searchDialog.showModal();
+        const focusedTag = document.activeElement?.tagName;
+        const isTypingInInput = focusedTag === 'INPUT' || focusedTag === 'TEXTAREA';
+        const isShortcut =
+            (ev.key === '/' && !isTypingInInput) ||
+            (ev.key === 'k' && (ev.ctrlKey || ev.metaKey));
+
+        if (isShortcut && !searchDialog.open) {
+            ev.preventDefault();
+            openSearch();
         }
     })
 } else {

docs/evaluation.fsx

@@ -158,7 +158,7 @@ let a = 10
 (*** include-value:a ***)"""
 
 // Create evaluator and parse script
-let fsi = FsiEvaluator()
+let fsi = new FsiEvaluator()
 
 let doc = Literate.ParseScriptString(content, fsiEvaluator = fsi)
 
@@ -192,7 +192,7 @@ This can be done by calling `cref:M:FSharp.Formatting.Literate.Evaluation.FsiEva
 
 *)
 // Create evaluator & register simple formatter for lists
-let fsiEvaluator = FsiEvaluator()
+let fsiEvaluator = new FsiEvaluator()
 
 fsiEvaluator.RegisterTransformation(fun (o, ty, _executionCount) ->
     // If the type of value is an F# list, format it nicely

src/FSharp.Formatting.Literate/ParseScript.fs

@@ -370,14 +370,14 @@ type internal ParseScript(parseOptions, ctx: CompilerContext) =
         let sourceSnippets, diagnostics =
             CodeFormatter.ParseAndCheckSource(filePath, content, ctx.CompilerOptions, defines, onError)
 
-        let mutable fail = false
+        let mutable hasErrors = false
 
         for (SourceError((l0, c0), (l1, c1), kind, msg)) in diagnostics do
             printfn
                 "   %s: %s(%d,%d)-(%d,%d) %s"
                 filePath
                 (if kind = ErrorKind.Error then
-                     fail <- true
+                     hasErrors <- true
                      "error"
                  else
                      "warning")
@@ -387,8 +387,8 @@ type internal ParseScript(parseOptions, ctx: CompilerContext) =
                 c1
                 msg
 
-        if fail then
-            ctx.OnError "errors parsing or checking script"
+        if hasErrors then
+            ctx.OnError(sprintf "errors found in '%s'" filePath)
 
         let parsedBlocks =
             [ for Snippet(name, lines) in sourceSnippets do