Spago docs, now with indexing and search

.github/workflows/build.yml

@@ -75,8 +75,8 @@ jobs:
       - name: Bootstrap executable
         run: ./bin/index.dev.js bundle -p spago-bin
 
-      - name: Check code format
-        run: npm run format:check
+      - name: Bundle docs-search client
+        run: ./bin/index.dev.js bundle -p docs-search-client-halogen
 
       - name: Run tests
         run: spago test

docs-search/client-halogen/spago.yaml

@@ -33,3 +33,12 @@ package:
     - web-html
     - web-storage
     - web-uievents
+  bundle:
+    type: "app"
+    minify: true
+    sourceMaps: true
+    module: Docs.Search.App
+    outfile: "../../output/Docs.Search.IndexBuilder/docs-search-app.js"
+    platform: browser
+    extra_args:
+      - "--alias:punycode=punycode/"

docs-search/client-halogen/src/Docs/Search/App.purs

@@ -199,7 +199,7 @@ insertVersionInfo = do
       prefix <- Document.createTextNode " - patched by " doc <#> Text.toNode
       linkElement <- Document.createElement "a" doc
       let linkNode = Element.toNode linkElement
-      Element.setAttribute "href" "https://github.com/purescript/purescript-docs-search" linkElement
+      Element.setAttribute "href" "https://github.com/purescript/spago/tree/master/docs-search" linkElement
       Element.setAttribute "target" "_blank" linkElement
       linkText <- Document.createTextNode ("docs-search") doc <#> Text.toNode
       suffix <- Document.createTextNode (" " <> Config.version) doc <#> Text.toNode

docs-search/common/src/Docs/Search/Config.purs

@@ -84,13 +84,22 @@ penalties =
   , excessiveConstraint: 1
   }
 
-defaultPackageName :: PackageName
-defaultPackageName = wrap "<local package>"
-
 -- | Find in which part of the index this path can be found.
 getPartId :: List Char -> PartId
 getPartId (a : b : _) =
   PartId $ (Char.toCharCode a + Char.toCharCode b) `mod` numberOfIndexParts
 getPartId (a : _) =
   PartId $ Char.toCharCode a `mod` numberOfIndexParts
 getPartId _ = PartId 0
+
+defaultPackageName :: PackageName
+defaultPackageName = wrap "<local package>"
+
+defaultDocsFiles :: Array String
+defaultDocsFiles = [ "output/**/docs.json" ]
+
+defaultBowerFiles :: Array String
+defaultBowerFiles = [ ".spago/*/*/bower.json", "bower_components/purescript-*/bower.json" ]
+
+defaultSourceFiles :: Array String
+defaultSourceFiles = [ "src/**/*.purs" ]

docs-search/index/src/Docs/Search/IndexBuilder.js

@@ -1,13 +1,17 @@
 /* global __dirname require exports */
 
 import globMain from "glob";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
 
-export function getDirname () {
-  return __dirname;
-};
+export function getDirname() {
+  const fileName = fileURLToPath(import.meta.url);
+  const dirName = path.dirname(fileName);
+  return dirName;
+}
 
-export function glob (pattern) {
+export function glob(pattern) {
   return function () {
     return globMain.sync(pattern);
   };
-};
+}

docs-search/index/src/Docs/Search/IndexBuilder.purs

@@ -92,8 +92,7 @@ run' cfg = do
         <> show countOfModules
         <> " modules from "
         <> show countOfPackages
-        <>
-          " packages..."
+        <> " packages..."
 
   let
     scores = mkScores packageMetas
@@ -169,14 +168,18 @@ decodeDocsJsons cfg@{ docsFiles } = do
     if doesExist then do
 
       contents <- readTextFile UTF8 jsonFile
-      let eiResult = jsonParser contents >>= left JsonCodec.printDecodeError <<< decodeDocModule
+      let
+        eiResult :: Either String DocModule
+        eiResult =
+          jsonParser contents >>=
+            (Docs.toDocModule >>> left JsonCodec.printDecodeError)
 
       case eiResult of
         Left error -> do
           liftEffect $ log $
             "\"docs.json\" decoding failed failed for " <> jsonFile <> ": " <> error
           pure Nothing
-        Right result -> pure result
+        Right result -> pure $ Just result
 
     else do
       liftEffect $ do
@@ -190,10 +193,6 @@ decodeDocsJsons cfg@{ docsFiles } = do
 
   pure docsJsons
 
-  where
-  decodeDocModule :: Json -> Either JsonCodec.DecodeError (Maybe DocModule)
-  decodeDocModule = JsonCodec.toNullNothingOrJust Docs.toDocModule
-
 -- | This function accepts an array of globs pointing to project sources
 -- | and returns a list of module names extracted from these files.
 -- | Unfortunately, we can't get all module names from `docs.json`s, because
@@ -236,9 +235,9 @@ decodeBowerJsons { bowerFiles } = do
       for paths \jsonFileName ->
         join <$> withExisting jsonFileName
           \contents ->
-            either (logError jsonFileName) pure
+            either (logError jsonFileName) (pure <<< Just)
               ( jsonParser contents >>=
-                  CA.decode (CA.maybe PackageIndex.packageMetaCodec) >>>
+                  CA.decode (PackageIndex.packageMetaCodec) >>>
                     left CA.printJsonDecodeError
               )
 
@@ -249,7 +248,7 @@ decodeBowerJsons { bowerFiles } = do
 
   logError fileName error = do
     liftEffect $ log $
-      "\"bower.json\" decoding failed failed for " <> fileName <> ": " <> error
+      "\"bower.json\" decoding failed for " <> fileName <> ": " <> error
     pure Nothing
 
 -- | Write type index parts to files.

package.json

@@ -40,6 +40,7 @@
     "glob": "^7.1.6",
     "markdown-it": "^12.0.4",
     "open": "^9.1.0",
+    "punycode": "^2.3.0",
     "semver": "^7.3.5",
     "spdx-expression-parse": "^3.0.1",
     "ssh2": "^1.14.0",

spago.lock

@@ -283,7 +283,7 @@ workspace:
         - unicode
         - versions
       git: https://github.com/JordanMartinez/purescript-language-purescript.git
-      ref: v0.1.1
+      ref: db4377dea03ba9c5273a93a8368a53f1d87882c1
     markdown-it:
       dependencies:
         - effect
@@ -1206,7 +1206,7 @@ packages:
   language-purescript:
     type: git
     url: https://github.com/JordanMartinez/purescript-language-purescript.git
-    rev: b141a41333226af8702d67eb290470bba599b42a
+    rev: db4377dea03ba9c5273a93a8368a53f1d87882c1
     dependencies:
       - argonaut-core
       - arrays

spago.yaml

@@ -86,7 +86,7 @@ workspace:
       git: https://github.com/nonbili/purescript-jest.git
       ref: caf2032f2e5828337e897a99f5359c00e91cb0ee
     language-purescript:
-      ref: v0.1.1
+      ref: db4377dea03ba9c5273a93a8368a53f1d87882c1
       git: https://github.com/JordanMartinez/purescript-language-purescript.git
       dependencies:
         - argonaut-core

src/Spago/Command/Docs.purs

@@ -7,6 +7,8 @@ import Spago.Prelude
 
 import Control.Promise (Promise)
 import Control.Promise as Promise
+import Docs.Search.IndexBuilder as IndexBuilder
+import Docs.Search.Config as DocConfig
 import Effect.Uncurried (EffectFn1, runEffectFn1)
 import Node.Process as Process
 import Spago.Command.Build as Build
@@ -44,6 +46,15 @@ run = do
     Right _ -> pure unit
 
   when (docsFormat == Html) $ do
+    liftAff $ IndexBuilder.run'
+      { docsFiles: DocConfig.defaultDocsFiles
+      , bowerFiles: DocConfig.defaultBowerFiles
+      , generatedDocs: "./generated-docs/"
+      , noPatch: false
+      , packageName: DocConfig.defaultPackageName
+      , sourceFiles: DocConfig.defaultSourceFiles
+      }
+
     currentDir <- liftEffect Process.cwd
     let link = "file://" <> currentDir <> "/generated-docs/html/index.html"
     logInfo $ "Link: " <> link