scalajs all in one template

All-in-One-Vorlage für statische Scala.js-Webprojekte

Dieses Repository ist eine Vorlage der Grundstruktur für ein Scala.js-Webprojekt und enthält die besten Technologien der Scala.js-Community bis 2023:

• Sbt ist das Build-Tool.
• Scala.js zum Kompilieren von Scala zu JavaScript.
• html.scala für reaktives HTML-Templating.
• Binding.scala für die Datenbindung.
• sbt-sassify zum Kompilieren von Sass zu CSS.
• Font Awesome als Beispiel für Sass-Abhängigkeit.
• Bootstrap für responsive UI-Komponenten.
• sbt-scala-js-map für die Quellzuordnung.
• Scalajs-Bundler für Webpack und NPM (oder YARN).
• ScalablyTyped zur Typdefinition von NPM-Abhängigkeiten.
• pad als Beispiel für NPM-Abhängigkeit.
• sbt-web für WebJars.
• sbt-buildinfo, um SBT-Einstellungen zur Laufzeit verfügbar zu machen.
• Coursier für schnelles Herunterladen von Maven- und Ivy-Abhängigkeiten.
• sbt-example zum Generieren von ScalaTest aus Beispielen in Scaladoc-Kommentaren.
• sbt-dynver, um die Build-Version anhand von Git-Tags zu ermitteln.

Beachten Sie, dass der Standardzweig dieses Repositorys in Scala 3 geschrieben ist. Schauen Sie sich den Zweig scala-2.13 an, um eine Projektvorlage in Scala 2.13 zu finden.

Weitere Bibliotheken und Tools finden Sie in den SBT-Einstellungen.

Diese Vorlage enthält Einstellungen für ein statisches Webprojekt, und Sie können zusätzlich Play- oder Akka-HTTP-Abhängigkeiten in web/build.sbt konfigurieren, um daraus ein dynamisches Webprojekt zu machen.

Verzeichnisstruktur

• web/

  Das sbt-web-Projekt für Web-Assets

  • build.sbt

    Sbt-Einstellungen für das sbt-web-Projekt, das WebJars-Abhängigkeitskonfigurationen enthält, einschließlich SASS/SCSS-Abhängigkeiten und statische Ressourcen aus externen Bibliotheken.

  • src/main/assets/

    Das Stammverzeichnis der statischen Asset-Quellen.

    • index.html

      Die Hauptseite im Release-Modus, die auf hässliche CSS- und JS-Ressourcen verweist.

    • devMod.html

      Die Hauptseite im Entwicklungsmodus, die auf eingerückte CSS- und JS-Ressourcen verweist.

    • style.scss

      Das von der Hauptseite verwendete Stylesheet in SCSS-Syntax, das von einer SBT-Web-Pipeline zu style.css kompiliert wird.

  • target/web/public/main/

    Das Stammverzeichnis der Ausgabe statischer Assets.

    • lib/

      Das Ausgabeverzeichnis für Webjars-Abhängigkeiten.

• js/

  Das Scala.js-Projekt zum Erstellen der im sbt-web-Projekt verwendeten JS-Ausgabe.

  • build.sbt

    Sbt-Einstellungen für das Scala.js-Projekt, das Scala.js-Einstellungen, NPM-Abhängigkeiten und Typdefinitionen enthält.

  • src/main/scala/

    Das Verzeichnis enthält Scala.js-Quelldateien.

• Projekt/

  • Plugins.sbt

    Abhängigkeiten von SBT-Plugins.

Anforderungen

• Java 8+
• SBT-Launcher
• Node.js oder nodenv

Wie verwende ich diese Vorlage?

Klonen Sie einfach dieses Repository und die folgenden SBT-Aufgaben sind verfügbar.

Bauen

Führen Sie den folgenden Befehl aus:

sbt assets

Besuchen Sie dann web/target/web/public/main/devMod.html um die Hauptseite zu durchsuchen.

Build im Release-Modus

Standardmäßig erstellt der Befehl assets Scala.js im Entwicklungsmodus. Um dieses Projekt im Release-Modus zu erstellen

sbt " set scalaJSStage := FullOptStage " assets

Besuchen Sie dann web/target/web/public/main/index.html um die Hauptseite im Release-Modus zu durchsuchen.

Prüfen

Führen Sie den folgenden Befehl aus:

sbt test

Anschließend werden die Beispiele in Scaladoc-Kommentaren von ScalaTest ausgeführt.