1
0
Fork 0
mirror of https://github.com/ethauvin/kobalt-doc.git synced 2025-04-25 03:57:11 -07:00

Update location of Build.kt.

This commit is contained in:
Cedric Beust 2015-12-12 21:25:34 -08:00
parent b4f35b8002
commit 67e633810e
5 changed files with 8 additions and 50 deletions

View file

@ -82,48 +82,6 @@
</ul> </ul>
</p> </p>
<h2 class="section" id="build-file">Auto complete in build files</h2>
<p>
It's useful to turn on auto completion for your <code>Build.kt</code> file if you are adding new
elements to the DSL. You can achieve this in two steps.
</p>
<h3 class="section" id="sync" indent="1">Sync your build file</h3>
<p>
This is achieved with the <code>Kobalt / Sync build file</code> menu item. On top of configuring your
IDEA project with the correct dependencies, this will also add the <code>kobalt.jar</code> file to your
classpath.
</p>
<p align="center" class="img-rounded">
<img width="50%" class="img-rounded" src="../pics/menu-sync.png"/>
</p>
<p align="center" class="img-rounded">
<img width="50%" class="img-rounded" src="../pics/kobalt-jar.png"/>
</p>
<h3 class="section" id="compile-build-file" indent="1">Compile your build file</h3>
<p>
Next, mark the directory that contains your build file as a "Source directory":
</p>
<p align="center" class="img-rounded">
<img width="50%" class="img-rounded" src="../pics/source-root.png"/>
</p>
<div class="bs-callout bs-callout-warning">
<h4>Alternate source directory for <code>Build.kt</code></h4>
The default location for <code>Build.kt</code> is in the root directory of your project but
you can also put it in <code>kobalt/src/Build.kt</code> and then mark that directory as
a source directory.
</div>
<p>
You can now use all the IDEA features on your build file:
</p>
<p align="center">
<img class="img-rounded" src="../pics/auto-complete.png"/>
</p>
</div> </div>
<!-- Table of contents --> <!-- Table of contents -->

View file

@ -96,7 +96,7 @@ This command will do two things:
</p> </p>
<ol> <ol>
<li>Create a default <code>Build.kt</code> file in your current directory based on what was found there. <li>Create a default <code>kobalt/src/Build.kt</code> file based on what was found there.
<li>Install the Kobalt Wrapper in your current directory (script `kobaltw`) and in the <code>kobalt/</code> directory. From now on, you can just use <code>./kobaltw</code> to build and you can ignore <code>$KOBALT_HOME</code>. <li>Install the Kobalt Wrapper in your current directory (script `kobaltw`) and in the <code>kobalt/</code> directory. From now on, you can just use <code>./kobaltw</code> to build and you can ignore <code>$KOBALT_HOME</code>.
</ol> </ol>
@ -404,9 +404,9 @@ Here are the options that you can pass to <code>./kobaltw</code>:
<tr> <tr>
<td><code>--buildFile</code></td> <td><code>--buildFile</code></td>
<td>File</td> <td>File</td>
<td>Build.kt</td> <td>kobalt/src/Build.kt</td>
<td>Specify a build file.</td> <td>Specify a build file.</td>
<td>Use this option if you are trying to build a project that's not in the current directory.</td> <td>Use this option if you are trying to build a project whose <code>Build.kt</code> is not in <code>kobalt/src</code>.</td>
</tr> </tr>
<tr> <tr>
<td><code>--checkVersions</code></td> <td><code>--checkVersions</code></td>

View file

@ -84,7 +84,7 @@ val jcommander = javaProject {
dependenciesTest { dependenciesTest {
compile("org.testng:testng:6.9.5") compile("org.testng:testng:6.9.5")
} }
f
assemble { assemble {
mavenJars { mavenJars {
} }

View file

@ -94,7 +94,7 @@
</p> </p>
<h3 class="section" indent="1" id="sync-build-file">Synchronization of build files</h3> <h3 class="section" indent="1" id="sync-build-file">Synchronization of build files</h3>
<p> <p>
The plug-in will find your `Build.kt` file and it will automatically update your project's libraries and The plug-in will locate your <code>kobalt/src/Build.kt</code> file and automatically update your project's libraries and
dependencies to reflect it. For example, suppose you have the following dependencies: dependencies to reflect it. For example, suppose you have the following dependencies:
</p> </p>
<pre class="brush:java"> <pre class="brush:java">
@ -148,8 +148,8 @@ dependencies {
<h3 class="section" indent="1" id="autocompletion">Auto completion of Build.kt</h3> <h3 class="section" indent="1" id="autocompletion">Auto completion of Build.kt</h3>
<p> <p>
The plug-in will automatically turn on auto-completion of your <code>Build.kt</code> The plug-in will automatically turn on auto-completion of your <code>kobalt/src/Build.kt</code>
file if it's located in the <code>kobalt/src</code> directory. Once this is file. Once this is
enabled, you can use everything you use on Kotlin files (auto completion, jump enabled, you can use everything you use on Kotlin files (auto completion, jump
to symbols, even refactorings). to symbols, even refactorings).
</p> </p>

View file

@ -354,7 +354,7 @@ public fun myConfig(init: Info.() -> Unit) = Info().apply { init() }</pre>
</p> </p>
<pre class="brush:java"> <pre class="brush:java">
// Build.kt // Build.kt
import.com.example.plugin.myConfig <imp></imp>ort.com.example.plugin.myConfig
myConfig { myConfig {
publish = true publish = true