summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/pages/9 - Contrib Modules.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/pages/9 - Contrib Modules.md b/docs/pages/9 - Contrib Modules.md
index 418978a7..44883959 100644
--- a/docs/pages/9 - Contrib Modules.md
+++ b/docs/pages/9 - Contrib Modules.md
@@ -275,6 +275,7 @@ There's an [example project](https://github.com/lihaoyi/cask/tree/master/example
This module adds basic Play Framework support to mill:
- configures mill for Play default directory layout,
- integrates the Play routes compiler,
+- provides helpers for commonly used framework libraries,
- optionally: integrates the Twirl template engine,
- optionally: configures mill for single module play applications.
@@ -390,6 +391,40 @@ The Play modules themselves don't have specific configuration options at this po
module configuration options](#router-configuration-options) and the [Twirl module configuration
options](#twirl-configuration-options) are applicable.
+#### Additional play libraries
+
+The following helpers are available to provide additional Play Framework dependencies:
+- `core()` - added by default ,
+- `guice()` - added by default,
+- `server()` - added by default,
+- `logback()` - added by default,
+- `evolutions()` - optional,
+- `jdbc()` - optional,
+- `filters()` - optional,
+- `ws()` - optional,
+- `caffeine()` - optional.
+
+If you want to add an optional library using the helper you can do so by overriding `ivyDeps`
+like in the following example build:
+
+```scala
+// build.sc
+import mill._
+// You have to replace VERSION
+import $ivy.`com.lihaoyi::mill-contrib-playlib:VERSION`, mill.playlib._
+
+
+object core extends PlayApiModule {
+ //config
+ override def scalaVersion= T{"2.12.8"}
+ override def playVersion= T{"2.7.0"}
+
+ object test extends PlayTests
+
+ override def ivyDeps = T{ super.ivyDeps() ++ Agg(ws(), filters()) }
+}
+```
+
#### Commands equivalence
Mill commands are targets on a named build. For example if your build is called `core`: