diff options
author | Tobias Roeser <le.petit.fou@web.de> | 2019-04-25 14:14:17 +0200 |
---|---|---|
committer | Tobias Roeser <le.petit.fou@web.de> | 2019-04-25 14:14:17 +0200 |
commit | 547b29f3d0a5a2a8e3f997551272f17797cbe44d (patch) | |
tree | 73f5ee321003c6e2f287b2c53c8263020f8e0cf9 /docs/pages | |
parent | b2d480b2b9de6091a8e7c135dac5dd2c0f653c6b (diff) | |
download | mill-547b29f3d0a5a2a8e3f997551272f17797cbe44d.tar.gz mill-547b29f3d0a5a2a8e3f997551272f17797cbe44d.tar.bz2 mill-547b29f3d0a5a2a8e3f997551272f17797cbe44d.zip |
Fixed plugin order in docs
Diffstat (limited to 'docs/pages')
-rw-r--r-- | docs/pages/9 - Contrib Modules.md | 121 |
1 files changed, 63 insertions, 58 deletions
diff --git a/docs/pages/9 - Contrib Modules.md b/docs/pages/9 - Contrib Modules.md index 0d65512b..be14103e 100644 --- a/docs/pages/9 - Contrib Modules.md +++ b/docs/pages/9 - Contrib Modules.md @@ -2,6 +2,8 @@ The plugins in this section are developed/maintained in the mill git tree. +[comment]: # (Please keep list of plugins in alphabetical order) + ### BuildInfo Generate scala code from your buildfile. @@ -673,6 +675,67 @@ The usage examples given here are most probably outdated and incomplete. If you develop or maintain a mill plugin, please create a [pull request](https://github.com/lihaoyi/mill/pulls) to get your plugin listed here. +[comment]: # (Please keep list of plugins in alphabetical order) + +### Bloop + +This plugin generates [bloop](https://scalacenter.github.io/bloop/) configuration +from your build file, which lets you use the bloop CLI for compiling, and makes +your scala code editable in [Metals](https://scalameta.org/metals/) + + +#### Quickstart: +```scala +// build.sc (or any other .sc file it depends on, including predef) +// Don't forget to replace VERSION +import $ivy.`com.lihaoyi::mill-contrib-bloop:VERSION` +``` + +Then in your terminal : + +``` +> mill mill.contrib.Bloop/install +``` + +#### Mix-in + +You can mix-in the `Bloop.Module` trait with any JavaModule to quickly access +the deserialised configuration for that particular module: + +```scala +// build.sc +import mill._ +import mill.scalalib._ +import mill.contrib.Bloop + +object MyModule extends ScalaModule with Bloop.Module { + def myTask = T { bloop.config() } +} +``` + +#### Note regarding metals: + +Generating the bloop config should be enough for metals to pick it up and for +features to start working in vscode (or the bunch of other editors metals supports). +However, note that this applies only to your project sources. Your mill/ammonite related +`.sc` files are not yet supported by metals. + +The generated bloop config references the semanticDB compiler plugin required by +metals to function. If need be, the version of semanticDB can be overriden by +extending `mill.contrib.bloop.BloopImpl` in your own space. + +#### Note regarding current mill support in bloop + +The mill-bloop integration currently present in the [bloop codebase](https://github.com/scalacenter/bloop/blob/master/integrations/mill-bloop/src/main/scala/bloop/integrations/mill/MillBloop.scala#L10) +will be deprecated in favour of this implementation. + +#### Caveats: + +At this time, only Java/ScalaModule are processed correctly. ScalaJS/ScalaNative integration will +be added in a near future. + + + ### DGraph Show transitive dependencies of your build in your browser. @@ -913,61 +976,3 @@ Publishing to custom local Maven repository Publishing to /tmp/m2repo ``` -### Bloop - -This plugin generates [bloop](https://scalacenter.github.io/bloop/) configuration -from your build file, which lets you use the bloop CLI for compiling, and makes -your scala code editable in [Metals](https://scalameta.org/metals/) - - -#### Quickstart: -```scala -// build.sc (or any other .sc file it depends on, including predef) -// Don't forget to replace VERSION -import $ivy.`com.lihaoyi::mill-contrib-bloop:VERSION` -``` - -Then in your terminal : - -``` -> mill mill.contrib.Bloop/install -``` - -#### Mix-in - -You can mix-in the `Bloop.Module` trait with any JavaModule to quickly access -the deserialised configuration for that particular module: - -```scala -// build.sc -import mill._ -import mill.scalalib._ -import mill.contrib.Bloop - -object MyModule extends ScalaModule with Bloop.Module { - def myTask = T { bloop.config() } -} -``` - -#### Note regarding metals: - -Generating the bloop config should be enough for metals to pick it up and for -features to start working in vscode (or the bunch of other editors metals supports). -However, note that this applies only to your project sources. Your mill/ammonite related -`.sc` files are not yet supported by metals. - -The generated bloop config references the semanticDB compiler plugin required by -metals to function. If need be, the version of semanticDB can be overriden by -extending `mill.contrib.bloop.BloopImpl` in your own space. - -#### Note regarding current mill support in bloop - -The mill-bloop integration currently present in the [bloop codebase](https://github.com/scalacenter/bloop/blob/master/integrations/mill-bloop/src/main/scala/bloop/integrations/mill/MillBloop.scala#L10) -will be deprecated in favour of this implementation. - -#### Caveats: - -At this time, only Java/ScalaModule are processed correctly. ScalaJS/ScalaNative integration will -be added in a near future. - - |