diff --git a/README.md b/README.md index 43e5388..dc29dbc 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ __________________________________ ### sbt-vite ```scala -addSbtPlugin("africa.shuwari.sbt" % "sbt-vite" % "0.14.1") +addSbtPlugin("africa.shuwari.sbt" % "sbt-vite" % "0.14.2") ``` | Depends On: | @@ -22,32 +22,32 @@ Preconfigures projects with opinionated project defaults for ScalaJS libraries a Introduces additional sbt `SettingKeys` and `TaskKeys`, specifically: -| Key | Description | Default | -|--------------------------|---------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------| -| `vite` | Task: Compiles, links, and prepares project for packaging and/or processing with external tools." | [Refer to implementation of `jsPrepare`](modules/sbt-js/src/main/scala/africa/shuwari/sbt/plugin.scala) | -| `viteBuild` | Executes `vite build` using the options specified in _sbt-vite_ plugin settings. | _N/A_ | -| `viteStop` | Shuts down any running instances of Vite's development server. | _N/A_ | -| `vite.base` | Setting: Option corresponding to Vite's `--base` setting. See https://vitejs.dev/guide/cli.html. | `None` | -| `vite.config` | Setting: Option corresponding to Vite's `--config` setting. See https://vitejs.dev/guide/cli.html. | `None` | -| `vite.force` | Setting: Option corresponding to Vite's `--force` setting. See https://vitejs.dev/guide/cli.html. | `None` | -| `vite.logLevel` | Setting: Option corresponding to Vite's `--logLevel` setting. See https://vitejs.dev/guide/cli.html. | `Level.Info` | -| `vite.mode` | Setting: Option corresponding to Vite's `--mode` setting. See https://vitejs.dev/guide/cli.html. | ```(if (JSBundlerPlugin.autoImport.jsFullLink.value) ViteImport.Mode.Production else ViteImport.Mode.Development) ``` | -| `vite.host` | Setting: Option corresponding to Vite's `--host` setting. See https://vitejs.dev/guide/cli.html. | `None` | -| `vite.port` | Setting: Option corresponding to Vite's `--port` setting. See https://vitejs.dev/guide/cli.html. | `None` | -| `vite.strictPort` | Setting: Option corresponding to Vite's `--strictPort` setting. See https://vitejs.dev/guide/cli.html. | `None` | -| `vite.cors` | Setting: Option corresponding to Vite's `--cors` setting. See https://vitejs.dev/guide/cli.html. | `None` | -| `vite.assetsDir` | Setting: Option corresponding to Vite's `--assetsDir` setting. See https://vitejs.dev/guide/cli.html. | `None` | -| `vite.assetsInlineLimit` | Setting: Option corresponding to Vite's `--assetsInlineLimit` setting. See https://vitejs.dev/guide/cli.html. | `None` | -| `vite.ssr` | Setting: Option corresponding to Vite's `--ssr` setting. See https://vitejs.dev/guide/cli.html. | `None` | -| `vite.sourcemap` | Setting: Option corresponding to Vite's `--sourcemap` setting. See https://vitejs.dev/guide/cli.html. | `None` | -| `vite.minify` | Setting: Option corresponding to Vite's `--minify` setting. See https://vitejs.dev/guide/cli.html. | `None` | +| Key | Description | Default | +|--------------------------|---------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------| +| `vite` | Task: Compiles, links, and prepares project for packaging and/or processing with external tools." | _N/A_ | +| `viteBuild` | Task: Executes `vite build` using the options specified in _sbt-vite_ plugin settings. | _N/A_ | +| `viteStop` | Task: Shuts down any running instances of Vite's development server. | _N/A_ | +| `vite.base` | Setting: Option corresponding to Vite's `--base` setting. See [Vite documentation](https://vitejs.dev/guide/cli.html). | `None` | +| `vite.config` | Setting: Option corresponding to Vite's `--config` setting. See [Vite documentation](https://vitejs.dev/guide/cli.html). | `None` | +| `vite.force` | Setting: Option corresponding to Vite's `--force` setting. See [Vite documentation](https://vitejs.dev/guide/cli.html). | `None` | +| `vite.logLevel` | Setting: Option corresponding to Vite's `--logLevel` setting. See [Vite documentation](https://vitejs.dev/guide/cli.html). | `Level.Info` | +| `vite.mode` | Setting: Option corresponding to Vite's `--mode` setting. See [Vite documentation](https://vitejs.dev/guide/cli.html). | ```if (JSBundlerPlugin.autoImport.jsFullLink.value) ViteImport.Mode.Production else ViteImport.Mode.Development ``` | +| `vite.host` | Setting: Option corresponding to Vite's `--host` setting. See [Vite documentation](https://vitejs.dev/guide/cli.html). | `None` | +| `vite.port` | Setting: Option corresponding to Vite's `--port` setting. See [Vite documentation](https://vitejs.dev/guide/cli.html). | `None` | +| `vite.strictPort` | Setting: Option corresponding to Vite's `--strictPort` setting. See [Vite documentation](https://vitejs.dev/guide/cli.html). | `None` | +| `vite.cors` | Setting: Option corresponding to Vite's `--cors` setting. See [Vite documentation](https://vitejs.dev/guide/cli.html). | `None` | +| `vite.assetsDir` | Setting: Option corresponding to Vite's `--assetsDir` setting. See [Vite documentation](https://vitejs.dev/guide/cli.html). | `None` | +| `vite.assetsInlineLimit` | Setting: Option corresponding to Vite's `--assetsInlineLimit` setting. See [Vite documentation](https://vitejs.dev/guide/cli.html). | `None` | +| `vite.ssr` | Setting: Option corresponding to Vite's `--ssr` setting. See [Vite documentation](https://vitejs.dev/guide/cli.html). | `None` | +| `vite.sourcemap` | Setting: Option corresponding to Vite's `--sourcemap` setting. See [Vite documentation](https://vitejs.dev/guide/cli.html). | `None` | +| `vite.minify` | Setting: Option corresponding to Vite's `--minify` setting. See [Vite documentation](https://vitejs.dev/guide/cli.html). | `None` | __________________________________ ### sbt-js-core ```scala -addSbtPlugin("africa.shuwari.sbt" % "sbt-js" % "0.14.1") +addSbtPlugin("africa.shuwari.sbt" % "sbt-js" % "0.14.2") ``` Preconfigures projects with opinionated project defaults for ScalaJS libraries and/or applications. Provides a foundation for incremental assembly using external Javascript ecosystem @@ -55,17 +55,17 @@ tools. Introduces additional sbt `SettingKeys` and `TaskKeys`, specifically relevant: -| Key | Description | Default | -|--------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| -| `jsPrepare` | Task: Compiles, links, and prepares project for packaging and/or processing with external tools." | [Refer to implementation of `jsPrepare`](modules/sbt-js/src/main/scala/africa/shuwari/sbt/plugin.scala) | -| `jsFullLink` | Setting: Defines whether _"fullLink"_ or _"fastLink\"_ ScalaJS Linker output is used. | `true` where `NODE_ENV` environment variable is defined with a value of `peoduction`. and `false` otherwise. | -| `js` | Task: Process and/or package assembled project with external tools. | Unimplemented. To be customised by end-user. | -| `js / sourceDirectory` | Setting: Default directory containing sources and resources to be copied as-is to `jsPrepare / target` during `jsPrepare` execution. | `(Compile / sourceDirectory) / js` | -| `js / sourceDirectories` | Setting: List of all directories containing sources and resources to be copied as-is to `jsPrepare / target` during `jsPrepare` execution. | `(Compile / sourceDirectory) / js` | -| `js / target` | Setting: Defines a target directory for the `js` task. Usable if required. | `(Compile / crossTarget) / (js.key.label.toLowerCase + "-" + normalizedName + "-" + (if (jsFullLink.value) "full" else "fast") + "-linked"` | -| `jsPrepare / target` | Setting: Defines a default target directory for the `jsPrepare` task. | `(Compile / crossTarget) / (jsPrepare.key.label.toLowerCase + "-" + normalizedName + "-" + (if (jsFullLink.value) "full" else "fast") + "-linked"` | -| `jsPrepare / fileInputIncludeFilter` | Setting: An sbt `sbt.nio.file.PathFilter` inclusion filter to apply to the input sources and resources copied to the prepared assembly by `jsPrepare`. | `RecursiveGlob` | -| `jsPrepare / fileInputExcludeFilter` | Setting: An sbt `sbt.nio.file.PathFilter` exclusion filter to apply to the input sources and resources copied to the prepared assembly by `jsPrepare`. | `HiddenFileFilter` | +| Key | Description | Default | +|--------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| +| `jsPrepare` | Task: Compiles, links, and prepares project for packaging and/or processing with external tools." | _N/A_ | +| `jsFullLink` | Setting: Defines whether _"fullLink"_ or _"fastLink\"_ ScalaJS Linker output is used. | `true` where `NODE_ENV` environment variable is defined with a value of `peoduction`. and `false` otherwise. | +| `js` | Task: Process and/or package assembled project with external tools. | Unimplemented. To be customised by end-user. | +| `js / sourceDirectory` | Setting: Default directory containing sources and resources to be copied as-is to `jsPrepare / target` during `jsPrepare` execution. | `(Compile / sourceDirectory) / js` | +| `js / sourceDirectories` | Setting: List of all directories containing sources and resources to be copied as-is to `jsPrepare / target` during `jsPrepare` execution. | `(Compile / sourceDirectory) / js` | +| `js / target` | Setting: Defines a target directory for the `js` task. Usable if required. | _N/A_ | +| `jsPrepare / target` | Setting: Defines a default target directory for the `jsPrepare` task. | _N/A_ | +| `jsPrepare / fileInputIncludeFilter` | Setting: An sbt `sbt.nio.file.PathFilter` inclusion filter to apply to the input sources and resources copied to the prepared assembly by `jsPrepare`. | `RecursiveGlob` | +| `jsPrepare / fileInputExcludeFilter` | Setting: An sbt `sbt.nio.file.PathFilter` exclusion filter to apply to the input sources and resources copied to the prepared assembly by `jsPrepare`. | `HiddenFileFilter` | __________________________________