erik/kobalt-doc
erik/kobalt-doc
1
0
Fork 0
mirror of https://github.com/ethauvin/kobalt-doc.git synced 2025-04-25 20:07:11 -07:00
Code Releases Activity

Merge from upstream.

Browse source
This commit is contained in:
Erik C. Thauvin 2016-07-09 10:41:10 -07:00
commit b4cf88c58d
11 changed files with 950 additions and 498 deletions
Download patch file Download diff file Expand all files Collapse all files

54
home/index.html
View file

@ -62,7 +62,7 @@
<div class="col-md-9">
<p>
<em style="font-size: 1.5em">
<em style="font-size: 1em">
Kobalt is a build system inspired by Gradle and Maven. It reuses the best concepts from these two
successful and popular build systems while adding a few modern features of its own. Kobalt is written
entirely in Kotlin and its build files are valid Kotlin files as well. Thanks to IDEA's top notch
@ -71,33 +71,12 @@
</em>
</p>
<p>
<em style="font-size: 1.5em">
<em style="font-size: 1em">
Here are some of Kobalt's most prominent features.
</em>
</p>
<h2 class="section" id="features">Features</h2>
<h2 class="section" id="buildFile" indent="1">Build file auto-completion in your IDE</h2>
<p>
Since Kobalt's build files are actual Kotlin files, not only can you leverage auto-completion
to write your build files but the full power of your IDEA is at your fingertips to write
these files in any way you see fit: using expressions, conditionals, classes, extension functions,
constants... The sky is the limit!
</p>
<p>
Kobalt uses Kotlin's type safe builder pattern to offer a DSL that's extremely similar to Gradle
and minimalistic while allowing you to switch to full Kotlin code whenever necessary.
</p>
<p>
Here is an example of the auto-completion dialog:
</p>
<p align="center">
<img src="../pics/auto-completion.png" class="img-rounded"/>
</p>
<p>
And see the following section to get a feel for Kobalt's build file syntax.
</p>
<h2 class="section" id="syntax" indent="1">Clean, minimal syntax for build files</h2>
<p>
For example, here is <a href="http://jcommander.org">JCommander's</a> entire build file:
@ -109,7 +88,7 @@ import com.beust.kobalt.plugin.java.*
import com.beust.kobalt.plugin.packaging.*
import com.beust.kobalt.plugin.publish.*
val jcommander = javaProject {
val jcommander = project {
name = "jcommander"
group = "com.beust"
artifactId = name
@ -133,7 +112,31 @@ val jcommander = javaProject {
<p>
This build file also includes a directive to upload your artifacts to Bintray automatically.
</p>
<h2 class="section" id="incremental" indent="1">Incremental tasks</h2>
<h2 class="section" id="buildFile" indent="1">Build file auto-completion in your IDE</h2>
<p>
Since Kobalt's build files are actual Kotlin files, not only can you leverage auto-completion
to write your build files but the full power of your IDEA is at your fingertips to write
these files in any way you see fit: using expressions, conditionals, classes, extension functions,
constants... The sky is the limit!
</p>
<p>
Kobalt uses Kotlin's type safe builder pattern to offer a DSL that's extremely similar to Gradle
and minimalistic while allowing you to switch to full Kotlin code whenever necessary.
</p>
<p>
Here is an example of the auto-completion dialog:
</p>
<p align="center">
<img src="../pics/auto-completion.png" class="img-rounded"/>
</p>
<p>
And see the following section to get a feel for Kobalt's build file syntax.
</p>
<h2 class="section" id="incremental" indent="1">Incremental tasks</h2>
<p>
Most of Kobalt's core tasks are incremental, which means that if you run them without having changed anything, they will be skipped. The support for incremental tasks is also trivial to add for plug-in developers, which guarantees that your builds with Kobalt will always be as fast as they can be.
</p>
@ -172,6 +175,7 @@ Kobalt is currently in Beta but already used in several projects. Here are links
<li><a href="https://github.com/cbeust/jcommander/blob/master/kobalt/src/Build.kt">JCommander</a>.</li>
<li><a href="https://github.com/cbeust/testng/blob/master/kobalt/src/Build.kt">TestNG</a> (this build file shows an example of adding a custom task in the build itself).</li>
<li><a href="https://github.com/cbeust/klaxon/blob/master/kobalt/src/Build.kt">Klaxon</a></li>
<li><a href="https://github.com/cbeust/kobalt-android">u2020 (Android show case application)</a></li>
<li>... and of course, <a href="https://github.com/cbeust/kobalt/blob/master/kobalt/src/Build.kt">Kobalt itself</a> (this build file demonstrates multi projects and project dependencies).</li>
</ul>