Website (#123)

* Add doc * Clean samples * Simpler * Add twirl index page generation for server demo. * Fix dev * Useless import
cheleb · Nov 26, 2023 · d55708a · d55708a
1 parent 7a58d39
commit d55708a
Show file tree

Hide file tree

Showing 29 changed files with 468 additions and 306 deletions.
diff --git a/build.sbt b/build.sbt
@@ -1,10 +1,6 @@
-//import ProjectDef._
 import java.nio.charset.StandardCharsets
 import org.scalajs.linker.interface.ModuleSplitStyle
 
-lazy val currentYear: String =
-  java.util.Calendar.getInstance().get(java.util.Calendar.YEAR).toString
-
 val scala33 = "3.3.1"
 
 inThisBuild(
@@ -43,6 +39,15 @@ inThisBuild(
   )
 )
 
+lazy val generator = project
+  .in(file("examples/generator"))
+  .enablePlugins(SbtTwirl)
+  .settings(
+    libraryDependencies += "com.github.scopt" %% "scopt" % "4.1.0",
+    libraryDependencies += "com.lihaoyi" %% "os-lib" % "0.9.2",
+    libraryDependencies += "org.slf4j" % "slf4j-simple" % "1.7.32"
+  )
+
 val dev = sys.env.get("DEV").isDefined
 
 val serverPlugins = dev match {
@@ -63,6 +68,7 @@ val serverSettings = dev match {
 lazy val root = project
   .in(file("."))
   .aggregate(
+    generator,
     server,
     core,
     ui5,
@@ -74,9 +80,36 @@ lazy val root = project
     publish / skip := true
   )
 
+val staticGenerationSettings =
+  if (dev) Seq()
+  else
+    Seq(
+      Assets / resourceGenerators += Def
+        .taskDyn[Seq[File]] {
+          val baseDir = baseDirectory.value
+          val rootFolder = (Assets / resourceManaged).value / "public"
+          rootFolder.mkdirs()
+          (generator / Compile / runMain)
+            .toTask {
+              Seq(
+                "BuildIndex",
+                "--title",
+                s""""Laminar Form Derivation v ${version.value}"""",
+                "--resource-managed",
+                rootFolder
+              ).mkString(" ", " ", "")
+            }
+            .map(_ => (rootFolder ** "*.html").get)
+        }
+        .taskValue
+    )
+
 lazy val server = project
   .in(file("examples/server"))
   .enablePlugins(serverPlugins: _*)
+  .settings(
+    staticGenerationSettings
+  )
   .settings(
     fork := true,
     scalaJSProjects := Seq(example),
@@ -102,7 +135,8 @@ val usedScalacOptions = Seq(
   "-unchecked",
   "-language:higherKinds",
   "-language:implicitConversions",
-  "-Xmax-inlines:64"
+  "-Xmax-inlines:64",
+  "-Wunused:all"
 )
 lazy val core = scalajsProject("core", false)
   .settings(
@@ -222,35 +256,3 @@ Global / onLoad := {
 
   (Global / onLoad).value
 }
-enablePlugins(
-  SiteScaladocPlugin,
-  SitePreviewPlugin,
-  ScalaUnidocPlugin,
-  GhpagesPlugin
-)
-
-ScalaUnidoc / siteSubdirName := ""
-addMappingsToSiteDir(
-  ScalaUnidoc / packageDoc / mappings,
-  ScalaUnidoc / siteSubdirName
-)
-git.remoteRepo := "[email protected]:cheleb/laminar-form-derivation.git"
-ghpagesNoJekyll := true
-Compile / doc / scalacOptions ++= Seq(
-  "-siteroot",
-  "docs",
-  "-project",
-  "Laminar Form Derivation",
-  "-groups",
-  "-project-version",
-  version.value,
-  "-revision",
-  version.value,
-  "-default-templates",
-  "static-site-main",
-  "-project-footer",
-  s"Copyright (c) 2022-$currentYear, Olivier NOUGUIER",
-  "-Ygenerate-inkuire",
-  "-skip-by-regex:demo\\..*",
-  "-skip-by-regex:samples\\..*"
-)
diff --git a/docs/_docs/getting-started.md b/docs/_docs/getting-started.md
@@ -0,0 +1,47 @@
+# Getting Started
+
+## Installation
+
+```sbt
+libraryDependencies += "dev.cheleb" %%% "laminar-form-derivation" % "{{ version }}"
+```
+
+### Requirements
+
+### Sample
+
+```scala sc:nocompile
+
+import dev.cheleb.scalamigen.{*, given}
+import dev.cheleb.scalamigen.ui5.UI5WidgetFactory
+
+import com.raquo.laminar.api.L.*
+
+import com.raquo.airstream.state.Var
+
+given WidgetFactory = UI5WidgetFactory
+
+case class Cat(name: String, age: Int)
+case class Dog(name: String, age: Int)
+
+val either = {
+
+  case class EitherSample(
+      either: Either[Cat, Dog],
+      optionalInt: Option[Int]
+  )
+
+  val eitherVar = Var(EitherSample(Left(Cat("Scala le chat", 6)), Some(1)))
+
+  div(
+    child <-- eitherVar.signal.map { item =>
+      div(
+        s"$item"
+      )
+    },
+    Form.renderVar(eitherVar)
+  )
+}
+
+
+```
diff --git a/docs/_docs/test.md b/docs/_docs/test.md
@@ -0,0 +1,8 @@
+```scala mdoc
+import java.time.Instant
+
+def now() = Instant.now()
+object Foo extends App{
+    println(now())
+}
+```
diff --git a/examples/client/package-lock.json b/examples/client/package-lock.json
diff --git a/examples/client/src/main/scala/HelloWorld.scala b/examples/client/src/main/scala/HelloWorld.scala
@@ -1,13 +1,29 @@
-package demo
+package samples
 
 import org.scalajs.dom
 import com.raquo.laminar.api.L.*
 import be.doeraene.webcomponents.ui5.*
-import samples.tree
+
+case class Sample(name: String, component: HtmlElement)
 
 object App extends App {
 
-  val sample = Var(samples.enums)
+  val sample = Var(samples.enums.component)
+
+  private def item(name: String) = SideNavigation.item(
+    _.text := name,
+    dataAttr("component-name") := name
+  )
+
+  private val demos = Seq(
+    samples.simple,
+    samples.either,
+    samples.enums,
+    samples.person,
+    samples.validation,
+    samples.list,
+    samples.tree
+  )
 
   val myApp =
     div(
@@ -23,51 +39,14 @@ object App extends App {
           _.events.onSelectionChange
             .map(_.detail.item.dataset.get("componentName")) --> Observer[
             Option[String]
-          ] {
-            case e @ Some("Either") =>
-              sample.set(samples.either)
-            case e @ Some("Enums") =>
-              sample.set(samples.enums)
-            case v @ Some("Person") =>
-              sample.set(samples.person)
-            case v @ Some("Validation") =>
-              sample.set(samples.validation)
-            case v @ Some("Lists") =>
-              sample.set(
-                samples.component
-              )
-            case v @ Some("Tree") =>
-              sample.set(tree.component)
-            case _ =>
-              sample.set(div("????"))
+          ] { name =>
+            val el = name
+              .flatMap(n => demos.find(_.name == n))
+
+            sample.set(el.map(_.component).getOrElse(div("Not found")))
 
           },
-          Seq(
-            SideNavigation.item(
-              _.text := "Either",
-              dataAttr("component-name") := "Either"
-            ),
-            SideNavigation.item(
-              _.text := "Enums",
-              dataAttr("component-name") := "Enums"
-            ),
-            SideNavigation.item(
-              _.text := "Person",
-              dataAttr("component-name") := "Person"
-            ),
-            SideNavigation.item(
-              _.text := "Validation",
-              dataAttr("component-name") := "Validation"
-            ),
-            SideNavigation.item(
-              _.text := "List",
-              dataAttr("component-name") := "Lists"
-            ),
-            SideNavigation.item(
-              _.text := "Tree",
-              dataAttr("component-name") := "Tree"
-            )
-          )
+          demos.map(_.name).map(item)
         )
       ),
       div(

diff --git a/examples/client/src/main/scala/WebSocketDemo.scala b/examples/client/src/main/scala/WebSocketDemo.scala
@@ -1,6 +1,6 @@
-package polyui
+package samples
 
-import com.raquo.laminar.api.L.{*, given}
+import com.raquo.laminar.api.L.*
 import be.doeraene.webcomponents.ui5.*
 import be.doeraene.webcomponents.ui5.configkeys.*
 import io.laminext.websocket._

diff --git a/examples/client/src/main/scala/samples/EitherSample.scala b/examples/client/src/main/scala/samples/EitherSample.scala
@@ -6,21 +6,23 @@ import com.raquo.laminar.api.L.*
 
 import com.raquo.airstream.state.Var
 
-val either = {
+val either = Sample(
+  "Either", {
 
-  case class EitherSample(
-      either: Either[Cat, Dog],
-      optionalInt: Option[Int]
-  )
+    case class EitherSample(
+        either: Either[Cat, Dog],
+        optionalInt: Option[Int]
+    )
 
-  val eitherVar = Var(EitherSample(Left(Cat("Scala le chat", 6)), Some(1)))
+    val eitherVar = Var(EitherSample(Left(Cat("Scala le chat", 6)), Some(1)))
 
-  div(
-    child <-- eitherVar.signal.map { item =>
-      div(
-        s"$item"
-      )
-    },
-    Form.renderVar(eitherVar)
-  )
-}
+    div(
+      child <-- eitherVar.signal.map { item =>
+        div(
+          s"$item"
+        )
+      },
+      Form.renderVar(eitherVar)
+    )
+  }
+)
diff --git a/examples/client/src/main/scala/samples/EnumSample.scala b/examples/client/src/main/scala/samples/EnumSample.scala
@@ -6,32 +6,34 @@ import com.raquo.laminar.api.L.*
 
 import com.raquo.airstream.state.Var
 
-val enums = {
-
-  enum Color(code: String):
-    case Black extends Color("000")
-    case White extends Color("FFF")
-    case Isabelle extends Color("???")
-
-  case class Basket(@EnumValues(Color.values) color: Color, cat: Cat)
-
-  case class Cat(
-      name: String,
-      age: Int,
-      @EnumValues(Color.values)
-      color: Color
-  )
-
-  val eitherVar = Var(
-    Basket(Color.Black, Cat("Scala", 10, Color.White))
-  )
-
-  div(
-    child <-- eitherVar.signal.map { item =>
-      div(
-        s"$item"
-      )
-    },
-    Form.renderVar(eitherVar)
-  )
-}
+val enums = Sample(
+  "Enums", {
+
+    enum Color(val code: String):
+      case Black extends Color("000")
+      case White extends Color("FFF")
+      case Isabelle extends Color("???")
+
+    case class Basket(@EnumValues(Color.values) color: Color, cat: Cat)
+
+    case class Cat(
+        name: String,
+        age: Int,
+        @EnumValues(Color.values)
+        color: Color
+    )
+
+    val eitherVar = Var(
+      Basket(Color.Black, Cat("Scala", 10, Color.White))
+    )
+
+    div(
+      child <-- eitherVar.signal.map { item =>
+        div(
+          s"$item"
+        )
+      },
+      Form.renderVar(eitherVar)
+    )
+  }
+)