diff --git a/documentation/index.html b/documentation/index.html index 6e44d76..ee19c5c 100644 --- a/documentation/index.html +++ b/documentation/index.html @@ -75,7 +75,7 @@
-

Downloading and installing Kobalt

+

Downloading and installing Kobalt

Download the zip file then unzip it in a location we'll call KOBALT_HOME: @@ -116,9 +116,9 @@ If your project follows a regular build structure (e.g. Maven's hierarchy), this As of this writing, Kobalt supports Java and Kotlin projects. -

Structure of a build file

+

Structure of a build file

-

General concepts

+

General concepts

The build file is typically called Built.kt and it is a valid Kotlin file. Typically, it contains imports, the declaration of one or more projects and the declaration of additional configurations (e.g. packaging, publishing, etc...). Since it's a Kotlin file, it can also contain any class or function you need: @@ -145,7 +145,7 @@ Here are a few noteworthy details about this small build file:

  • The functions kotlinProject and homeDir are supplied by Kobalt and are sometimes referred to as "directives" -

    Directives

    +

    Directives

    Now that we have declared a project, we can use it to configure additional steps of our build, such as the assembling it (creating jar and other files: @@ -192,7 +192,7 @@ Our jar file is now declared to be a "fat jar" (which means it will include all The zip directive follows a similar structure, although here we are specifying which file we want to include. For more details on the packaging plug-in, please see its documentation.

    -

    Dependencies

    +

    Dependencies

    You can declare compile and test dependencies as follows: @@ -209,7 +209,7 @@ dependenciesTest { } -

    Maven repos

    +

    Maven repos

    Kobalt already knows the location of the most popular Maven repos (Maven Central, JCenter, JBoss) but you can add repos with the repos() directive: @@ -219,7 +219,7 @@ Kobalt already knows the location of the most popular Maven repos (Maven Central val repos = repos("https://dl.bintray.com/cbeust/maven/") -

    Using plug-ins

    +

    Using plug-ins

    Kobalt comes with a few preconfigured plug-ins but you will want to include external ones as well, which can be downloaded either from a Maven repository (Sonatype, JCenter, ...) or from a local file. @@ -276,7 +276,7 @@ $ ./kobaltw --tasks Notice the new "coverage" task, provided by the plug-in kobalt-example-plugin that we just included. With the simple action of declaring the plug-in, it is now fully loaded and available right away. Of course, such plug-ins can allow or require additional configuration with their own directives. Please read the plug-in developer documentation for more details. -

    Multiple projects

    +

    Multiple projects

    You can specify more than one project in a build file, simply by declaring them: @@ -309,7 +309,7 @@ You can also run tasks for a specific project only as follows: This will run the assemble task only for the p2, instead of running it for all projects. -

    Command line

    +

    Command line

    Here are the options that you can pass to ./kobaltw: @@ -385,7 +385,7 @@ New versions found: -

    Publishing

    +

    Publishing

    Kobalt supports JCenter natively so you can upload your project and make it available on JCenter very easily. @@ -427,11 +427,11 @@ Now, all you need to do is to upload your package: ./kobaltw uploadJcenter -

    Writing a plug-in

    +

    Writing a plug-in

    A good starting point to write a plug-in is the kobalt-line-count project, which shows a minimalistic plug-in. -

    Building

    +

    Building

    You only need to do two things to build a Kobalt plug-in: @@ -455,7 +455,7 @@ val p = packaging(examplePlugin) { } -

    Implementing

    +

    Implementing

    A plug-in typically has three components: @@ -465,7 +465,7 @@ A plug-in typically has three components:
  • Specifying directives (functions that will be used from the build file). -

    BasePlugin

    +

    BasePlugin

    The main class of your plugin extends BasePlugin and implements its apply() method and name variable: @@ -481,7 +481,7 @@ public class ExamplePlugin : BasePlugin() { } -

    Plugin tasks

    +

    Plugin tasks

    Next, you can declare tasks with the @Task annotation: @@ -503,7 +503,7 @@ public fun coverage(project: Project): TaskResult {

  • runAfter and runBefore let you specify the dependencies of your task. In this example plug-in, we want to calculate the coverage of the project so it makes sense to run after the "compile" task. -

    Directives

    +

    Directives

    Finally, you need to define functions that can be used from the build file (directives). You are encouraged to use the Kotlin DSL approach to expose these functions so that the build file syntax can remain consistent. Typically, these functions will update data that your tasks can then use to do their job. @@ -557,7 +557,7 @@ val p = kotlinProject { } -

    Sources and license

    +

    Sources and license

    Kobalt is licensed under Apache 2.0 and is currently hosted on github. @@ -583,41 +583,19 @@ If you are interested in discussing Kobalt related topics with other fellow user

    • - -
    - -
    - - + +
    +
    + - + + + + diff --git a/home/index.html b/home/index.html index 27290a5..df81e6e 100644 --- a/home/index.html +++ b/home/index.html @@ -69,9 +69,7 @@
    -

    Overview

    - -

    +

    Overview

    Kobalt is a build system heavily inspired from Gradle and entirely written in Kotlin. It's focused on offering an intuitive DSL and plug-in architecture, fast builds and build file auto completion from your favorite IDE.

    @@ -106,7 +104,7 @@ val j = jcenter(jcommander) { } -

    Design goals

    +

    Design goals

    -

    Why Kobalt?

    +

    Why Kobalt?

    As of this writing (October 2015), Kobalt is in alpha and changing a lot so I am mostly interested in getting the attention of developers who are curious about: @@ -139,7 +137,7 @@ Kobalt is complete enough to build three of my personal projects (1. Scratching an itch

    I give a lot of credit to Gradle for having open a brand new avenue in build tools but despite all its power and flexibility and the fact that I've used Gradle for more than five years, I've never really felt comfortable or fluent with it. Even today, I regularly find myself spending a lot of time on StackOverflow whenever I need to do something a bit out of the ordinary with my Gradle builds. @@ -154,19 +152,19 @@ I suspect a part of it is due to Groovy which, even though it started gaining so

  • Building is slow and hard to diagnose because of Gradle's mixed Java/Groovy code base. -

    2. An experiment

    +

    2. An experiment

    I wanted to see for myself if my discomfort with Gradle was justified or if, by trying to write a build tool myself, I would end up with a very similar tool with similar strengths and weaknesses. I still haven't made up my mind about this but I will certainly by the time Kobalt reaches 1.0.

    -

    3. A proof of concept

    +

    3. A proof of concept

    I have been a fervent believer that there is nothing that dynamically typed languages can do today that statically typed languages can't. Groovy's meta model and features have enabled a lot of clever tricks (DSL and others) for Gradle builds and I was really curious if I could put money where my mouth is by creating a similar project with Kotlin. This experiment is still ongoing but by now, I'm pretty convinced that the answer is a resounding "yes".

    -

    4. An excuse to write Kotlin

    +

    4. An excuse to write Kotlin

    Just a personal thing. After toying with the language for almost four years now, I wanted to take my efforts to the next level and push the language to the limit. So far, the language has held all its promises and then some. @@ -202,24 +200,20 @@ Is your curiosity piqued? Are you interested in writing some cool Kotlin code an

    -
    • -
    - +
    - + + + + diff --git a/js/toc.js b/js/toc.js new file mode 100644 index 0000000..58fa09d --- /dev/null +++ b/js/toc.js @@ -0,0 +1,62 @@ +function countersToHeading(counters) { + var result = ""; + for (var i = 0; i < counters.length; i++) { + if (i > 0) result = result + "."; + result = result + counters[i]; + } + return result; +} + +function indentSection(count) { + var result = ""; + for (var i = 0; i < count; i++) { + result += "  "; + } + return result; +} + +function rewriteSection(section, counters) { + var result = ""; + result = result + countersToHeading(counters) + " - " + section.innerHTML; + return result; +} + +function generateToc() { + var sections = document.getElementsByClassName("section"); + + var toc = '';//