Update site

.github/workflows/ci.yml

@@ -102,46 +102,47 @@ jobs:
           MILL_SONATYPE_PASSWORD: ${{ secrets.PUBLISH_PASSWORD }}
           MILL_SONATYPE_USERNAME: ${{ secrets.PUBLISH_USER }}
 
-  # site:
-  #   if: github.event_name != 'pull_request' && (github.ref == 'refs/heads/main' || github.ref == 'refs/tags/')
-  #   needs: build
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - uses: coursier/setup-action@main
-  #       with:
-  #         jvm: temurin@21
-  #         apps: scala-cli
-  #     - uses: actions/checkout@main
-  #       with:
-  #         fetch-depth: 0
-  #         fetch-tags: true
-  #     - run: ./mill site.publishDocs
-  #     - name: Setup Pages
-  #       uses: actions/configure-pages@main
-  #     - uses: actions/upload-artifact@main
-  #       with:
-  #         name: page
-  #         path: out/site/publishDocs.dest
-  #         if-no-files-found: error
-
-  # deploy:
-  #   needs: site
-  #   permissions:
-  #     pages: write
-  #     id-token: write
-  #   environment:
-  #     name: github-pages
-  #     url: ${{ steps.deployment.outputs.page_url }}
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #   - uses: actions/download-artifact@main
-  #     with:
-  #       name: page
-  #       path: .
-  #   - uses: actions/configure-pages@main
-  #   - uses: actions/upload-pages-artifact@main
-  #     with:
-  #       path: .
-  #   - name: Deploy to GitHub Pages
-  #     id: deployment
-  #     uses: actions/deploy-pages@main
+  site:
+    if: github.event_name == 'pull_request' || github.ref == 'refs/heads/main'
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: coursier/setup-action@main
+        with:
+          jvm: temurin@21
+          apps: scala-cli
+      - uses: actions/checkout@main
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+      - run: ./mill site.siteGen
+      - name: Setup Pages
+        uses: actions/configure-pages@main
+      - uses: actions/upload-artifact@main
+        with:
+          name: page
+          path: out/site/laika/generateSite.dest
+          if-no-files-found: error
+
+  deploy:
+    if: github.ref == 'refs/heads/main'
+    needs: site
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/download-artifact@main
+      with:
+        name: page
+        path: .
+    - uses: actions/configure-pages@main
+    - uses: actions/upload-pages-artifact@main
+      with:
+        path: .
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@main

.scalafmt.conf

@@ -1,4 +1,4 @@
-version = "3.9.7"
+version = "3.9.9"
 project.git = true
 
 runner.dialect = scala3

build.mill

@@ -1,21 +1,21 @@
 //| mill-jvm-version: 21
-//| mill-version: 1.0.3
+//| mill-version: 1.0.4
 //| mvnDeps:
 //| - com.lihaoyi::mill-contrib-buildinfo:$MILL_VERSION
 //| - com.goyeau::mill-scalafix::0.6.0
-
-
-package build
+//| - io.github.quafadas:millSite_mill1_3.7:0.0.50
 
 import os.copy.over
 // import io.github.quafadas.millSite._
 import mill._, scalalib._, publish._, scalanativelib._
 import mill.scalalib.scalafmt.ScalafmtModule
 import mill.util.*
+import mill.util.BuildInfo.millVersion
 
 import com.goyeau.mill.scalafix.ScalafixModule
 import java.text.Format
-// import io.github.quafadas.millSite.SiteModule
+import io.github.quafadas.millSite.SiteModule
+import mill.util.VcsVersion
 
 
 object V{
@@ -27,10 +27,13 @@ object V{
   val laminar = "17.2.1"
   val scalaJsDom = "2.8.1"
   val scalaJs = "1.19.0"
+  val fs2 = "3.11.0"
+  val millLibs = mvn"com.lihaoyi::mill-libs:$millVersion"
 }
 
 trait FormatFix extends ScalafmtModule with ScalafixModule with ScalaModule
 
+
 trait FormatFixPublish extends ScalaModule with FormatFix with PublishModule{
   override def scalaVersion = V.scalaVersion
 
@@ -67,19 +70,6 @@ trait Testy extends TestModule.Munit with FormatFix {
 }
 
 
-// object site extends SiteModule {
-
-//   def scalaVersion = V.scalaVersion
-//   def unidocDeps = Seq(build.sjsls, build.routes)
-//   override def unidocTitle = "Scala JS Live Server API"
-
-//   override def repoLink = "https://github.com/Quafadas/live-server-scala-cli-js"
-
-//   override def latestVersion = "0.2.11"
-
-
-// }
-
 // SN deps which aren't yet there.
 /**
 1 targets failed

plugin/package.mill

@@ -0,0 +1,45 @@
+package build.plugin
+
+import mill.util.BuildInfo. millBinPlatform
+import mill._, scalalib._, publish._
+import mill.util.VcsVersion
+import build.V
+import build.FormatFixPublish
+
+object `package` extends ScalaModule with FormatFixPublish:
+  def platformSuffix = s"_mill$millBinPlatform"
+
+  def scalaVersion = build.V.scalaVersion
+
+  def scalaArtefactVersion: Task[String] =
+    scalaVersion.map(_.split("\\.").take(2).mkString("."))
+
+  override def artifactName = "sjsls_plugin"
+
+  def mvnDeps = Task{
+    super.mvnDeps() ++
+    Seq(
+      V.millLibs,
+      mvn"co.fs2:fs2-io_3:${V.fs2}"
+    )
+  }
+
+  def moduleDeps = Seq(build.sjsls)
+
+  def artifactSuffix = s"${platformSuffix()}_${scalaArtefactVersion()}"
+
+  def publishVersion = VcsVersion.vcsState().format()
+  // def publishVersion = "DONTUSEME"
+
+  override def pomSettings = Task {
+    PomSettings(
+      description = "Mill plugin for mdoc, static site generation",
+      organization = "io.github.quafadas",
+      url = "https://github.com/Quafadas/millSite",
+      licenses = Seq(License.`Apache-2.0`),
+      versionControl = VersionControl.github("quafadas", "millSite"),
+      developers = Seq(
+        Developer("quafadas", "Simon Parten", "https://github.com/quafadas")
+      )
+    )
+  }

plugin/src/refresh_plugin.scala

@@ -0,0 +1,96 @@
+package io.github.quafadas
+import fs2.concurrent.Topic
+
+import cats.effect.IO
+import cats.effect.unsafe.implicits.global
+
+import io.github.quafadas.sjsls.LiveServerConfig
+import mill.*
+import mill.api.BuildCtx
+import mill.api.Task.Simple
+import mill.scalajslib.*
+import mill.scalajslib.api.Report
+implicit val ec: scala.concurrent.ExecutionContext = scala.concurrent.ExecutionContext.global
+
+trait ScalaJsRefreshModule extends ScalaJSModule:
+
+  lazy val updateServer = Topic[IO, Unit].unsafeRunSync()
+
+  def indexHtml = Task {
+    os.write.over(Task.dest / "index.html", io.github.quafadas.sjsls.vanillaTemplate(withStyles()))
+    PathRef(Task.dest / "index.html")
+  }
+
+  def assetsDir =
+    super.moduleDir / "assets"
+
+  def withStyles = Task(true)
+
+  def assets = Task.Source {
+    assetsDir
+  }
+
+  def port = Task {
+    8080
+  }
+
+  def openBrowser = Task {
+    true
+  }
+
+  def logLevel = Task {
+    "warn"
+  }
+
+  def dezombify = Task {
+    true
+  }
+
+  def siteGen = Task {
+    val assets_ = assets()
+    val path = fastLinkJS().dest.path
+    os.copy.over(indexHtml().path, Task.dest / "index.html")
+    os.copy(assets_.path, Task.dest, mergeFolders = true)
+    updateServer.publish1(println("publish update")).unsafeRunSync()
+    (Task.dest.toString(), assets_.path.toString(), path.toString())
+
+  }
+
+  def lcs = Task.Worker {
+    val (site, assets, js) = siteGen()
+    println("Gen lsc")
+    LiveServerConfig(
+      baseDir = None,
+      outDir = Some(js),
+      port =
+        com.comcast.ip4s.Port.fromInt(port()).getOrElse(throw new IllegalArgumentException(s"invalid port: ${port()}")),
+      indexHtmlTemplate = Some(site),
+      buildTool = io.github.quafadas.sjsls.NoBuildTool(), // Here we are a slave to the build tool
+      openBrowserAt = "/index.html",
+      preventBrowserOpen = !openBrowser(),
+      dezombify = dezombify(),
+      logLevel = logLevel(),
+      customRefresh = Some(updateServer)
+    )
+  }
+
+  def serve = Task.Worker {
+
+    println(lcs())
+    BuildCtx.withFilesystemCheckerDisabled {
+      new RefreshServer(lcs())
+    }
+  }
+
+  class RefreshServer(lcs: LiveServerConfig) extends AutoCloseable:
+    val server = io.github.quafadas.sjsls.LiveServer.main(lcs).allocated
+
+    server.map(_._1).unsafeRunSync()
+
+    override def close(): Unit =
+      // This is the shutdown hook for http4s
+      println("Shutting down server...")
+      server.map(_._2).flatten.unsafeRunSync()
+    end close
+  end RefreshServer
+end ScalaJsRefreshModule

site/docs/Configuration/config.md

@@ -1,9 +1,9 @@
 # Config
 
-The server is a CLI. It has a number of flags that can be used to configure it. Here is the current list of flags and what they do. You can see these flags by running ` --help` in your terminal.
+The CLI launches an http server. It has a number of flags that can be used to configure it. Here is the current list of flags and what they do. You can see these flags by running ` --help` in your terminal.
 
-```
-cs launch io.github.quafadas::sjsls:{{projectVersion}} -- --help
+```sh
+cs launch io.github.quafadas::sjsls:latest.version -- --help
 
 ```
 
@@ -56,7 +56,7 @@ Fire up a terminal in projectDir
 ```
 
 ```sh
-cs launch io.github.quafadas::sjsls:{{projectVersion}}
+cs launch io.github.quafadas::sjsls:latest.version
 ```
 This is the classic [viteless](https://github.com/Quafadas/viteless/tree/main) example
 
@@ -73,7 +73,7 @@ With styles.
 Run
 
 ```sh
-cs launch io.github.quafadas::sjsls:{{projectVersion}} -- --styles-dir --fully/qualified/dir/to/styles
+cs launch io.github.quafadas::sjsls:latest.version -- --styles-dir --fully/qualified/dir/to/styles
 ```
 
 ## Did I mention I want a full blown SPA?
@@ -89,7 +89,7 @@ With client side routing under `/app`?
 Run
 
 ```sh
-cs launch io.github.quafadas::sjsls:{{projectVersion}} -- --client-routes-prefix app
+cs launch io.github.quafadas::sjsls:latest.version -- --client-routes-prefix app
 ```
 
 ## Stop generating my HTML. I want to bring my own.
@@ -105,7 +105,7 @@ Okay.
 ```
 With
 ```sh
-cs launch io.github.quafadas::sjsls:{{projectVersion}} -- --path-to-index-html fully/qualified/path/to/assets
+cs launch io.github.quafadas::sjsls:latest.version -- --path-to-index-html fully/qualified/path/to/assets
 ```
 
 Note: if you're brining your own html, drop the `--styles` flag - reference `index.less` from your html and read [docs](https://lesscss.org) to get it working in browser.
@@ -134,7 +134,7 @@ With a backend running on `8080` and a frontend on `3000`, it is configured that
 Also, we're now using mill. We need to tell the cli the frontend module name and the directory the compiles JS ends up in.
 
 ```sh
-cs launch io.github.quafadas::sjsls:{{projectVersion}} -- \
+cs launch io.github.quafadas::sjsls:latest.version -- \
     --path-to-index-html /Users/simon/Code/mill-full-stack/frontend/ui \
     --build-tool mill \
     --mill-module-name frontend \
@@ -153,7 +153,6 @@ This would serve the static site build with the `docJar` tool.
 C:\temp\live-server-scala-cli-js> cs launch io.github.quafadas::sjsls:0.2.0 -- --path-to-index-html C:\\temp\\live-server-scala-cli-js\\out\\site\\live.dest\\site --build-tool none --browse-on-open-at /docs/index.html
 ```
 
-***
 You need to include this javascript script tag in the body html - otherwise no page refresh.
 
 ```html
@@ -167,5 +166,4 @@ You need to include this javascript script tag in the body html - otherwise no p
     if ("PageRefresh" in msg) location.reload();
     });
 </script>
-```
-***
+```

site/docs/Configuration/library.md

@@ -0,0 +1,3 @@
+# Library
+
+The LiveServerConfig can also accept an `fs2.Topic` as a parameter. This allows any tool which can instantiate an `fs2.Topic` to emit a pulse, which will refresh the client. Have a look at the mill plugin code for details.

site/docs/advantages.md

@@ -8,7 +8,7 @@ Here are the key advantages of this approach:
 
 - Because there's no seperate ecosystem or NPM to configure, configuring build and CI is a lot easier. No `node_modules` to worry about. I found that this simplicity infected everything around it.
 
-- In terms of performance; NPM dependancies are loaded out the CDN. This is slow the first time - but seriously - check the network browser tools when you refresh the page. The second time they are all served out of browser cache - it takes 0ms. Even better, that cache _survives application redeployment!_. If you pre-load the (fat) "internal-" xxx dependancies scalaJS produces, this combination crushes page load times.
+- In terms of performance; NPM dependancies are loaded out the CDN. This is slow the first time, but check the network browser tools when you refresh the page. The second time they are all served out of browser cache - it takes 0ms. Even better, that cache _survives application redeployment!_.
 
 - You can use the same build tool for both backend and frontend, and share code between them.