Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sbt/sbt-js-engine
Support for sbt plugins that use JavaScript
https://github.com/sbt/sbt-js-engine
Last synced: 5 days ago
JSON representation
Support for sbt plugins that use JavaScript
- Host: GitHub
- URL: https://github.com/sbt/sbt-js-engine
- Owner: sbt
- License: other
- Created: 2014-04-04T12:44:34.000Z (almost 11 years ago)
- Default Branch: main
- Last Pushed: 2024-08-16T21:03:24.000Z (5 months ago)
- Last Synced: 2025-01-10T03:09:01.090Z (12 days ago)
- Language: Scala
- Homepage:
- Size: 214 KB
- Stars: 40
- Watchers: 13
- Forks: 32
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-sbt-plugins - sbt-js-engine - This plugin mainly provides support for the authoring of sbt plugins that require js-engine. (WEB)
README
sbt-js-engine
=============
[](https://github.com/sbt/sbt-js-engine/actions/workflows/build-test.yml)
This plugin mainly provides support for the authoring of sbt plugins that require js-engine.
Of particular note is SbtJsTaskPlugin. This plugin provides an abstract base intended to be used for creating
the various types of plugin for sbt-web. At this time the types of plugin are "source file plugins" and "other".
Source file plugins use the `sources` and `sourceDirectories` sbt keys and process files from there. Plugins of this
type can optionally produce managed resources.
The other types of plugin are ones that wish to just invoke the js engine and so there are helper functions to do
that.
Enable this plugin in your project by adding it to your project's `plugins.sbt` file:
addSbtPlugin("com.github.sbt" % "sbt-js-engine" % "")
The following options are provided:
Option | Description
----------------------------|------------
command | The filesystem location of the command to execute. Commands such as "node" default to being known to your path. However there path can be supplied here."
engineType | The type of engine to use i.e. CommonNode, Node, PhantomJs, Rhino, Trireme, or AutoDetect. The default is AutoDetect, which uses Node if installed or otherwise falls back to Trireme.
npmPreferSystemInstalledNpm | Prefer detecting and using locally installed NPM when using a local engine that provides Node support. Defaults to true.
npmSubcommand | The subcommand that NPM should use i.e. Install, Update, Ci. Defaults to Update.
The following sbt code illustrates how the engine type can be set to Node:
```scala
JsEngineKeys.engineType := JsEngineKeys.EngineType.Node
```
Alternatively, for `command` and `engineType` you can provide a system property via SBT_OPTS, for example:
```bash
export SBT_OPTS="$SBT_OPTS -Dsbt.jse.engineType=Node"
```
and another example:
```bash
export SBT_OPTS="$SBT_OPTS -Dsbt.jse.command=/usr/local/bin/node"
```
## npm
sbt-js-engine also enhances sbt-web with [npm](https://www.npmjs.org/) functionality. If a `package.json` file
is found in the project's base directory then it will cause npm to run.
npm extracts its artifacts into the `node_modules` folder of a base directory and makes the contents available to sbt-web plugins as a whole. Note that sbt-js-engines loads the actual source code of npm via a WebJar and invokes an "npm update". Any external npm activity can therefore be performed interchangeably with sbt-js-engine in place.
> Note that the npm functionality requires JDK 7 when running Trireme given the additional file system support required. If JDK 6 is required then use Node as the engine.
# Releasing sbt-js-engine
1. Tag the release: `git tag -s 1.2.3`
1. Push tag: `git push upstream 1.2.3`
1. GitHub action workflow does the rest: https://github.com/sbt/sbt-js-engine/actions/workflows/publish.yml