From 2ccad83244b2630ba4183d926a91d8b3f92b9a31 Mon Sep 17 00:00:00 2001 From: Tobias Roeser Date: Sun, 21 Oct 2018 14:05:50 +0200 Subject: Re-organized thirdparty plugin section Each plugin is a level-3 section, that appears also in TOC. Plugins are in alphabetical order. --- docs/pages/9 - Contrib Modules.md | 168 +++++++++++++++++++++----------------- 1 file changed, 91 insertions(+), 77 deletions(-) (limited to 'docs/pages/9 - Contrib Modules.md') diff --git a/docs/pages/9 - Contrib Modules.md b/docs/pages/9 - Contrib Modules.md index f9270e38..aa7b21a7 100644 --- a/docs/pages/9 - Contrib Modules.md +++ b/docs/pages/9 - Contrib Modules.md @@ -82,87 +82,101 @@ Quickstart: The package name of the object. -### Other Mill Plugins +## Thirdparty 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 -- [dgraph](https://github.com/ajrnz/mill-dgraph "mill-dgraph") +Show transitive dependencies of your build in your browser. - 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)() - ``` +Project home: https://github.com/ajrnz/mill-dgraph -- [publishM2](https://github.com/lefou/mill-publishM2 "mill-publishM2") - - Mill plugin to publish artifacts into a local Maven repository. - - Quickstart: - - Just mix-in the `PublishM2Module` into your project. - `PublishM2Module` already extends mill's built-in `PublishModule`. - - File: `build.sc` - ```scala - import mill._, scalalib._, publish._ - - import $ivy.`de.tototec::de.tobiasroeser.mill.publishM2:0.0.1` - import de.tobiasroeser.mill.publishM2._ - - object project extends PublishModule with PublishM2Module { - // ... - } - ``` - - Publishing to default local Maven repository - - ```bash - > mill project.publishM2Local - [40/40] project.publishM2Local - Publishing to /home/user/.m2/repository - ``` - - Publishing to custom local Maven repository - - ```bash - > mill project.publishM2Local /tmp/m2repo - [40/40] project.publishM2Local - Publishing to /tmp/m2repo - ``` +#### Quickstart -- [osgi](https://github.com/lefou/mill-osgi "GitHub-Project lefou/mill-osgi") - - Produce OSGi Bundles with mill. - - Quickstart: - ```scala - import $ivy.`de.tototec::de.tobiasroeser.mill.osgi:0.0.2` - import de.tobiasroeser.mill.osgi._ - - object project extends ScalaModule with OsgiBundleModule { - - def bundleSymbolicName = "com.example.project" - - def osgiHeaders = T{ osgiHeaders().copy( - `Export-Package` = Seq("com.example.api"), - `Bundle-Activator` = Some("com.example.internal.Activator") - )} +```scala +import $ivy.`com.github.ajrnz::mill-dgraph:0.2.0` +``` + +```sh +sh> mill plugin.dgraph.browseDeps(proj)() +``` + +### Ensime + +Create an [.ensime](http://ensime.github.io/ "ensime") file for your build. + +Project home: https://github.com/yyadavalli/mill-ensime - } - ``` +#### Quickstart + +```scala +import $ivy.`fun.valycorp::mill-ensime:0.0.1` +``` + +```sh +sh> mill fun.valycorp.mill.GenEnsime/ensimeConfig +``` + +### OSGi + +Produce OSGi Bundles with mill. + +Project home: https://github.com/lefou/mill-osgi + +#### Quickstart + +```scala +import $ivy.`de.tototec::de.tobiasroeser.mill.osgi:0.0.2` +import de.tobiasroeser.mill.osgi._ + +object project extends ScalaModule with OsgiBundleModule { + + def bundleSymbolicName = "com.example.project" + + def osgiHeaders = T{ osgiHeaders().copy( + `Export-Package` = Seq("com.example.api"), + `Bundle-Activator` = Some("com.example.internal.Activator") + )} + +} +``` + + +### PublishM2 + +Mill plugin to publish artifacts into a local Maven repository. + +Project home: https://github.com/lefou/mill-publishM2 + +#### Quickstart + +Just mix-in the `PublishM2Module` into your project. +`PublishM2Module` already extends mill's built-in `PublishModule`. + +File: `build.sc` +```scala +import mill._, scalalib._, publish._ + +import $ivy.`de.tototec::de.tobiasroeser.mill.publishM2:0.0.1` +import de.tobiasroeser.mill.publishM2._ + +object project extends PublishModule with PublishM2Module { + // ... +} +``` + +Publishing to default local Maven repository + +```bash +> mill project.publishM2Local +[40/40] project.publishM2Local +Publishing to /home/user/.m2/repository +``` + +Publishing to custom local Maven repository + +```bash +> mill project.publishM2Local /tmp/m2repo +[40/40] project.publishM2Local +Publishing to /tmp/m2repo +``` -- cgit v1.2.3