summaryrefslogtreecommitdiff
path: root/docs/pages/9 - Contrib Modules.md
diff options
context:
space:
mode:
authorbenjaminfrank <ben+github@pipsfrank.de>2018-08-16 21:28:43 +0200
committerGitHub <noreply@github.com>2018-08-16 21:28:43 +0200
commitd4de5f9646cb2005e79dd8f64ac20c66fa2baeda (patch)
tree2a7cddd22a0e868b577e19e21f59d46eef190578 /docs/pages/9 - Contrib Modules.md
parentb9b133610f14cc7207e1a3efad43a06a1521b92a (diff)
downloadmill-d4de5f9646cb2005e79dd8f64ac20c66fa2baeda.tar.gz
mill-d4de5f9646cb2005e79dd8f64ac20c66fa2baeda.tar.bz2
mill-d4de5f9646cb2005e79dd8f64ac20c66fa2baeda.zip
Simple BuildInfo plugin (#325)
* Simple BuildInfo plugin * BuildInfo readme include other known yet external plugins * Add tests
Diffstat (limited to 'docs/pages/9 - Contrib Modules.md')
-rw-r--r--docs/pages/9 - Contrib Modules.md58
1 files changed, 58 insertions, 0 deletions
diff --git a/docs/pages/9 - Contrib Modules.md b/docs/pages/9 - Contrib Modules.md
index 0360cc75..c49f6238 100644
--- a/docs/pages/9 - Contrib Modules.md
+++ b/docs/pages/9 - Contrib Modules.md
@@ -49,3 +49,61 @@ object example extends ScalaPBModule {
override def scalaPBOptions = "flat_package,java_conversions"
}
```
+
+### BuildInfo
+
+Generate scala code from your buildfile.
+This plugin generates a single object containing information from your build.
+
+To declare a module that uses BuildInfo you must extend the `mill.contrib.BuildInfo` trait when defining your module.
+
+Quickstart:
+ ```scala
+ object project extends BuildInfo {
+ val name = "poject-name"
+ def buildInfoMembers: T[Map[String, String]] = T {
+ Map(
+ "name" -> name),
+ "scalaVersion" -> scalaVersion()
+ )
+ }
+ }
+ ```
+
+#### Configuration options
+
+* `def buildInfoMembers: T[Map[String, String]]`
+ The map containing all member names and values for the generated info object.
+
+* `def buildInfoObjectName: String`, default: `BuildInfo`
+ The name of the object which contains all the members from `buildInfoMembers`.
+
+* `def buildInfoPackageName: Option[String]`, default: `None`
+ The package name of the object.
+
+
+### Other Mill Plugins
+
+- [ensime](https://github.com/yyadavalli/mill-ensime "mill-ensime")
+
+ Create an [.ensime](http://ensime.github.io/ "ensime") file for your build.
+
+ Quickstart:
+ ```scala
+ import $ivy.`fun.valycorp::mill-ensime:0.0.1`
+ ```
+ ```sh
+ sh> mill fun.valycorp.mill.GenEnsime/ensimeConfig
+ ```
+
+- [dgraph](https://github.com/ajrnz/mill-dgraph "mill-dgraph")
+
+ Show transitive dependencies of your build in your browser.
+
+ Quickstart:
+ ```scala
+ import $ivy.`com.github.ajrnz::mill-dgraph:0.2.0`
+ ```
+ ```sh
+ sh> mill plugin.dgraph.browseDeps(proj)()
+ ```