Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ptrdom/scalajs-vite
Bundles Scala.js projects and their npm dependencies with Vite
https://github.com/ptrdom/scalajs-vite
npm scala-js vite
Last synced: 4 days ago
JSON representation
Bundles Scala.js projects and their npm dependencies with Vite
- Host: GitHub
- URL: https://github.com/ptrdom/scalajs-vite
- Owner: ptrdom
- License: mit
- Created: 2022-12-11T15:15:26.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T21:43:11.000Z (14 days ago)
- Last Synced: 2024-10-24T08:22:02.873Z (13 days ago)
- Topics: npm, scala-js, vite
- Language: Scala
- Homepage:
- Size: 297 KB
- Stars: 14
- Watchers: 3
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# scalajs-vite
scalajs-vite is a module bundler for Scala.js projects that use npm packages: it bundles the .js files emitted by the
Scala.js compiler with their npm dependencies into a single .js file using Vite.
[](https://index.scala-lang.org/ptrdom/scalajs-vite/sbt-scalajs-vite)
## Getting started
Plugin should feel quite familiar to the users of well known [scalajs-bundler](https://scalacenter.github.io/scalajs-bundler),
with the main difference being that there is no special handling of `npmDependencies` - they must be provided through
`package.json` placed within `vite` directory in project's base.
### Basic setup
1. Setup project layout, following is a minimal example:
```
src
main
scala
example
Main.scala # Scala.js entrypoint
vite
index.html # Vite entrypoint
package.json # devDependencies must provide Vite package
```
1. Add plugin to sbt project:
```scala
addSbtPlugin("me.ptrdom" % "sbt-scalajs-vite" % scalaJSViteVersion)
```
1. Enable plugin in `build.sbt`:
```
enablePlugins(ScalaJSVitePlugin)
```
1. Specify that Scala.js project is an application with an entrypoint:
```
scalaJSUseMainModuleInitializer := true
```
Such configuration would allow `main.js` bundle to be used in Vite entrypoint:
```html
```
1. Use sbt tasks to compile Scala.js code and run Vite:
- For development-like `vite dev`:
- `fastLinkJS/startVite;~fastLinkJS/viteCompile;fastLinkJS/stopVite`
- For production-like `vite preview`:
- `fullLinkJS/startPreview;~fullLinkJS/viteBuild;fullLinkJS/stopPreview`
Running `fullLinkJS/viteBuild` produces a production-ready `vite build` in `/target/${scalaVersion}/vite/main/dist`
directory.
All files in `vite` directory are copied to Vite working directory, so any other web resources and relevant configuration
files can be put there.
See [sbt-scalajs-vite/src/sbt-test/sbt-scalajs-vite/basic-project](sbt-scalajs-vite/src/sbt-test/sbt-scalajs-vite/basic-project) directory for basic example project.
### Integrating with sbt-web
1. Add plugin to sbt project:
```scala
addSbtPlugin("me.ptrdom" % "sbt-web-scalajs-vite" % scalaJSViteVersion)
```
1. Enable plugin in `build.sbt`:
```scala
lazy val server = project
.settings(
scalaJSProjects := Seq(client),
pipelineStages := Seq(scalaJSPipeline)
)
.enablePlugins(WebScalaJSVitePlugin)
lazy val client = project.enablePlugins(ScalaJSVitePlugin)
```
See [sbt-web-scalajs-vite/src/sbt-test/sbt-web-scalajs-vite/basic-project](sbt-web-scalajs-vite/src/sbt-test/sbt-web-scalajs-vite/basic-project) directory for basic example project.
## Package managers
Uses [npm](https://www.npmjs.com/) by default, but provided `PackageManager` abstraction allows configuration of other
package managers.
```scala
//for yarn
vitePackageManager := new scalajsvite.PackageManager {
override def name = "yarn"
override def lockFile = "yarn.lock"
override def installCommand = "install"
}
// for pnpm
vitePackageManager := new scalajsvite.PackageManager {
override def name = "pnpm"
override def lockFile = "pnpm-lock.yaml"
override def installCommand = "install"
}
```
## Electron
Plugin is also suitable for working with [Electron](https://www.electronjs.org/) projects. Each Electron script should
be specified as a separate module in `scalaJSModuleInitializers`:
```scala
scalaJSModuleInitializers := Seq(
ModuleInitializer
.mainMethodWithArgs("example.Main", "main")
.withModuleID("main"),
ModuleInitializer
.mainMethodWithArgs("example.Preload", "main")
.withModuleID("preload"),
ModuleInitializer
.mainMethodWithArgs("example.Renderer", "main")
.withModuleID("renderer")
)
```
Then the typical Electron workflows can be executed
with the use of [vite-plugin-electron](https://github.com/electron-vite/vite-plugin-electron).
See [sbt-scalajs-vite/src/sbt-test/sbt-scalajs-vite/electron-project](sbt-scalajs-vite/src/sbt-test/sbt-scalajs-vite/electron-project) directory for example project.
## License
This software is licensed under the MIT license