fix: use nodejs_jll, use rootpath

Author: pfitzseb

Project.toml

@@ -9,7 +9,7 @@ Git = "d7ba0133-e1db-5d97-8f8c-041e4b3a1eb2"
 Gumbo = "708ec375-b3d6-5a57-a7ce-8257bf98657a"
 HypertextLiteral = "ac1192a8-f4b3-4bfe-ba22-af5b92cd3ab2"
 JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
-NodeJS = "2bd173c7-0d6d-553b-b6af-13a54713934c"
+NodeJS_22_jll = "8fca9ca2-e7a1-5ccf-8c05-43be5a78664f"
 Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
 
 [compat]
@@ -18,7 +18,7 @@ Git = "1"
 Gumbo = "0.8.2"
 HypertextLiteral = "0.9"
 JSON = "0.20,0.21"
-NodeJS = "1, 2"
+NodeJS_22_jll = "22.15.0"
 julia = "1"
 
 [extras]

assets/default/pagefind_integration.js

@@ -4,7 +4,7 @@
     let FOCUSABLE_ELEMENTS = []
     let FOCUSED_ELEMENT_INDEX = 0
 
-    const pagefind = await import("/pagefind/pagefind.js");
+    const pagefind = await import(window.MULTIDOCUMENTER_ROOT_PATH + "pagefind/pagefind.js")
 
     function initialize() {
         pagefind.init()

src/MultiDocumenter.jl

@@ -15,7 +15,7 @@ end
 
 `index_versions` is a vector of relative paths used for generating the search index. Only
 the first matching path is considered.
-`engine` may be `MultiDocumenter.PageFind`, `MultiDocumenter.FlexSearch`, `MultiDocumenter.Stork`, 
+`engine` may be `MultiDocumenter.PageFind`, `MultiDocumenter.FlexSearch`, `MultiDocumenter.Stork`,
 or a module that conforms to the expected API (which is currently undocumented).
 `lowfi = true` will try to minimize search index size. Only relevant for flexsearch.
 """
@@ -137,7 +137,7 @@ include("search/stork.jl")
 include("canonical.jl")
 include("sitemap.jl")
 
-const DEFAULT_ENGINE = SearchConfig(index_versions = ["stable", "dev"], engine = PageFind)
+const DEFAULT_ENGINE = SearchConfig(; index_versions = ["stable", "dev"], engine = PageFind)
 
 """
     make(

src/search/flexsearch.jl

@@ -1,5 +1,6 @@
 module FlexSearch
-import Gumbo, JSON, AbstractTrees, NodeJS
+import Gumbo, JSON, AbstractTrees
+using NodeJS_22_jll: node
 using HypertextLiteral
 import ..walk_outputs
 
@@ -151,7 +152,7 @@ function build_search_index(root, docs, config, rootpath)
     file = config.lowfi ? "gensearch-lowfi.js" : "gensearch.js"
     println("Writing $(config.lowfi ? "lowfi" : "") flexsearch index:")
     cd(root) do
-        run(`$(NodeJS.nodejs_cmd()) $(joinpath(@__DIR__, "..", "..", "flexsearch", file))`)
+        run(`$(node()) $(joinpath(@__DIR__, "..", "..", "flexsearch", file))`)
     end
     return nothing
 end

src/search/pagefind.jl

@@ -1,10 +1,14 @@
 module PageFind
-using NodeJS: NodeJS
-using HypertextLiteral
+using NodeJS_22_jll: npx, npm
+using HypertextLiteral: @htl
 
 function inject_script!(custom_scripts, rootpath)
     pushfirst!(custom_scripts, joinpath("assets", "default", "pagefind_integration.js"))
     pushfirst!(custom_scripts, joinpath("pagefind", "pagefind.js"))
+    pushfirst!(
+        custom_scripts,
+        Docs.HTML("window.MULTIDOCUMENTER_ROOT_PATH = '$(rootpath)'"),
+    )
 end
 
 function inject_styles!(custom_styles)
@@ -23,13 +27,16 @@ function render()
 end
 
 function build_search_index(root, docs, config, rootpath)
-    if !success(`npx pagefind -V`)
-        error("pagefind search engine not found. Aborting. Try running `npm install pagefind --global`")
+    if !success(Cmd(`$(npx) pagefind -V`; dir=root))
+        @info "Installing pagefind into $root."
+        if !success(Cmd(`$(npm) install pagefind`; dir=root))
+            error("Could not install pagefind.")
+        end
     end
 
     pattern = "*/{$(join(config.index_versions, ","))}/**/*.{html}"
 
-    run(`npx pagefind --site $(root) --glob $(pattern) --root-selector article --exclude-selectors pre`)
+    run(`$(npx) pagefind --site $(root) --glob $(pattern) --root-selector article`)
 end
 
 end

test/runtests.jl

@@ -95,7 +95,7 @@ if Sys.iswindows() && !isinteractive()
         docs;
         search_engine = MultiDocumenter.SearchConfig(
             index_versions = ["stable", "dev"],
-            engine = MultiDocumenter.FlexSearch,
+            engine = MultiDocumenter.PageFind,
         ),
         custom_scripts = [
             "foo/bar.js",
@@ -114,7 +114,7 @@ MultiDocumenter.make(
     docs;
     search_engine = MultiDocumenter.SearchConfig(
         index_versions = ["stable", "dev"],
-        engine = MultiDocumenter.FlexSearch,
+        engine = MultiDocumenter.PageFind,
     ),
     custom_scripts = [
         "foo/bar.js",
@@ -210,23 +210,8 @@ MultiDocumenter.make(
         @test occursin(canonical_href, index)
     end
 
-    @testset "flexsearch" begin
-        @test isdir(outpath, "search-data")
-        store_content = read(joinpath(outpath, "search-data", "store.json"), String)
-        @test !isempty(store_content)
-        @test occursin("Infiltrator.jl", store_content)
-        @test occursin("@infiltrate", store_content)
-        # We can't traverse symlinks on Windows, so stable/ things do not get
-        # written into the search index. Instead, it looks like we write dev/
-        if Sys.iswindows()
-            @test !occursin("$(rootpath)inf/stable/", store_content)
-            @test !occursin("$(rootpath)inf/stable/", store_content)
-            @test occursin("/inf/dev/", store_content)
-        else
-            @test occursin("$(rootpath)inf/stable/", store_content)
-            @test occursin("$(rootpath)inf/stable/", store_content)
-            @test !occursin("/inf/dev/", store_content)
-        end
+    @testset "pagefind" begin
+        @test isdir(outpath, "pagefind")
     end
 
     @testset "sitemap" begin