mirror of
https://github.com/ethauvin/kobalt-doc.git
synced 2025-04-24 19:47:11 -07:00
try to make site more intuitive
This commit is contained in:
Juan Liska
parent
de753349e3
commit
6112dda189
5 changed files with 614 additions and 558 deletions
|
|
@ -57,9 +57,7 @@
|
|||
|
||||
<!-- Main component for a primary marketing message or call to action -->
|
||||
<div class="jumbotron">
|
||||
<h1>Kobalt</h1>
|
||||
<p>A universal build system for the exigent developer.</p>
|
||||
<img src="../pics/auto-completion.png" class="img-rounded"/>
|
||||
<h1>Documentation</h1>
|
||||
|
||||
<!--
|
||||
<p>
|
||||
|
|
@ -71,47 +69,6 @@
|
|||
|
||||
<div class="col-md-9">
|
||||
|
||||
<h2 class="section" id="downloading">Downloading and installing Kobalt</h2>
|
||||
|
||||
<p>
|
||||
<a href="https://github.com/cbeust/kobalt/releases/latest">Download the zip file</a> then unzip it in a location we'll call <code>KOBALT_HOME</code>:
|
||||
</p>
|
||||
|
||||
<pre class="brush:plain">
|
||||
cd $KOBALT_HOME
|
||||
unzip kobalt-xxx.zip
|
||||
</pre>
|
||||
|
||||
<p>
|
||||
Change to your project directory and call the <code>kobaltw</code> command with <code>--init</code>:
|
||||
</p>
|
||||
|
||||
<pre class="brush:plain">
|
||||
cd ~/java/project
|
||||
$KOBALT_HOME/kobaltw --init
|
||||
</pre>
|
||||
|
||||
<p>
|
||||
This command will do two things:
|
||||
</p>
|
||||
|
||||
<ol>
|
||||
<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>.
|
||||
</ol>
|
||||
|
||||
<p>
|
||||
You can now attempt to build your project with Kobalt:
|
||||
</p>
|
||||
|
||||
<pre class="brush:plain">
|
||||
./kobaltw assemble
|
||||
</pre>
|
||||
|
||||
If your project follows a regular build structure (e.g. <a href="https://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html">Maven's hierarchy</a>), this should compile your file and create a .jar file. If not, you will have to make a few edits to your <code>Build.kt</code>.
|
||||
|
||||
As of this writing, Kobalt supports Java and Kotlin projects.
|
||||
|
||||
<h2 class="section" id="structure">Structure of a build file</h2>
|
||||
|
||||
<h3 class="section" indent="1" id="general-concepts">General concepts</h3>
|
||||
|
|
@ -628,7 +585,7 @@ If you are interested in discussing Kobalt related topics with other fellow user
|
|||
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
|
||||
<script src="../bootstrap/dist/js/bootstrap.min.js"></script>
|
||||
<script src="../js/kobalt.js"></script>
|
||||
<script>generateKobalt(1);</script>
|
||||
<script>generateKobalt();</script>
|
||||
|
||||
<!--
|
||||
<script src="../bootstrap/dist/js/docs.min.js"></script>
|
||||
|
|
|
|||
156
getting-started/index.html
Normal file
156
getting-started/index.html
Normal file
|
|
@ -0,0 +1,156 @@
|
|||
<html>
|
||||
<head>
|
||||
<title>
|
||||
|
||||
Kobalt, by Cedric Beust
|
||||
|
||||
</title>
|
||||
|
||||
<script type="text/javascript" src="../sh/scripts/shCore.js"></script>
|
||||
<script type="text/javascript" src="../sh/scripts/shBrushJScript.js"></script>
|
||||
<script type="text/javascript" src="../sh/scripts/shBrushJava.js"></script>
|
||||
<script type="text/javascript" src="../sh/scripts/shBrushPlain.js"></script>
|
||||
|
||||
<script>
|
||||
SyntaxHighlighter.defaults['gutter'] = false;
|
||||
SyntaxHighlighter.defaults['toolbar'] = false;
|
||||
SyntaxHighlighter.all();
|
||||
</script>
|
||||
|
||||
|
||||
<!--[if lt IE 9]><script src="../assets/js/ie8-responsive-file-warning.js"></script><![endif]-->
|
||||
<!--
|
||||
<script src="../bootstrap/assets/js/ie-emulation-modes-warning.js"></script>
|
||||
-->
|
||||
|
||||
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
|
||||
<!--[if lt IE 9]>
|
||||
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
|
||||
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<!-- Favicons -->
|
||||
<!--
|
||||
<link rel="icon" href="/favicon.ico">
|
||||
-->
|
||||
|
||||
<script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-238215-6', 'auto');
|
||||
ga('send', 'pageview');
|
||||
|
||||
</script>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
|
||||
<div class="container">
|
||||
|
||||
<!-- Static navbar -->
|
||||
<nav id="kobalt-navbar" class="navbar navbar-default">
|
||||
</nav>
|
||||
|
||||
<!-- Main component for a primary marketing message or call to action -->
|
||||
<div class="jumbotron">
|
||||
<h1>Kobalt</h1>
|
||||
<p>A universal build system for the exigent developer.</p>
|
||||
<img src="../pics/auto-completion.png" class="img-rounded"/>
|
||||
|
||||
<!--
|
||||
<p>
|
||||
<a class="btn btn-lg btn-primary" href="../../components/#navbar" role="button">Download »</a>
|
||||
</p>
|
||||
-->
|
||||
</div>
|
||||
|
||||
|
||||
<div class="col-md-9">
|
||||
|
||||
<h2 class="section" id="downloading">1. Download Kobalt</h2>
|
||||
|
||||
<p>
|
||||
<a href="https://github.com/cbeust/kobalt/releases/latest">Download the zip file</a> then unzip it in a location we'll call <code>KOBALT_HOME</code>:
|
||||
</p>
|
||||
|
||||
<pre class="brush:plain">
|
||||
cd $KOBALT_HOME
|
||||
unzip kobalt-xxx.zip
|
||||
</pre>
|
||||
|
||||
<h2 class="section" id="downloading">2. Initialize your project for Kobalt</h2>
|
||||
|
||||
<p>
|
||||
Change to your project directory and call the <code>kobaltw</code> command with <code>--init</code>:
|
||||
</p>
|
||||
|
||||
<pre class="brush:plain">
|
||||
cd ~/java/project
|
||||
$KOBALT_HOME/kobaltw --init
|
||||
</pre>
|
||||
|
||||
<p>
|
||||
This command will do two things:
|
||||
</p>
|
||||
|
||||
<ol>
|
||||
<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>.
|
||||
</ol>
|
||||
|
||||
<p>
|
||||
You can now attempt to build your project with Kobalt:
|
||||
</p>
|
||||
|
||||
<pre class="brush:plain">
|
||||
./kobaltw assemble
|
||||
</pre>
|
||||
|
||||
If your project follows a regular build structure (e.g. <a href="https://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html">Maven's hierarchy</a>), this should compile your file and create a .jar file. If not, you will have to make a few edits to your <code>Build.kt</code>.
|
||||
|
||||
As of this writing, Kobalt supports Java and Kotlin projects.
|
||||
|
||||
<h2 class="section" id="structure">3. Edit Build.kt</h2>
|
||||
|
||||
<pre class="brush:java">
|
||||
import com.beust.kobalt.*
|
||||
import com.beust.kobalt.plugin.kotlin.kotlinProject
|
||||
|
||||
val kobalt = kotlinProject {
|
||||
name = "kobalt"
|
||||
group = "com.beust"
|
||||
artifactId = name
|
||||
version = "0.62"
|
||||
directory = homeDir("kotlin/kobalt")
|
||||
}
|
||||
</pre>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<!-- Table of contents -->
|
||||
<div class="col-md-3" id="table-of-contents">
|
||||
</div>
|
||||
</div> <!-- /container -->
|
||||
|
||||
<!-- Bootstrap core JavaScript
|
||||
================================================== -->
|
||||
<!-- Placed at the end of the document so the pages load faster -->
|
||||
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
|
||||
<script src="../bootstrap/dist/js/bootstrap.min.js"></script>
|
||||
<script src="../js/kobalt.js"></script>
|
||||
<script>generateKobalt(1);</script>
|
||||
|
||||
<!--
|
||||
<script src="../bootstrap/dist/js/docs.min.js"></script>
|
||||
-->
|
||||
<!-- IE10 viewport hack for Surface/desktop Windows 8 bug -->
|
||||
<!--
|
||||
<script src="../../assets/js/ie10-viewport-bug-workaround.js"></script>
|
||||
-->
|
||||
|
||||
</body>
|
||||
|
|
@ -55,14 +55,20 @@
|
|||
|
||||
<!-- Main component for a primary marketing message or call to action -->
|
||||
<div class="jumbotron">
|
||||
<h1>What is Kobalt?</h1>
|
||||
<h1>Kobalt: friendly, fast build system</h1>
|
||||
<img src="../pics/auto-completion.png" class="img-rounded"/>
|
||||
</div>
|
||||
|
||||
<!-- Main content -->
|
||||
<div class="col-md-9">
|
||||
|
||||
<h2 class="section" id="overview">Overview</h2>
|
||||
Kobalt is a build system system featuring build files 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.
|
||||
<h2 class="section" id="overview">Features</h2>
|
||||
<ul>
|
||||
<li><h4>Intuitive DSL and plug-in architecture</h4></li>
|
||||
<li><h4>Fast builds</h4></li>
|
||||
<li><h4>Build file auto-completion from your favorite IDE</h4></li>
|
||||
<li><h4>A cleaner syntax than Ant, Maven, Gradle, or SBT</h4></li>
|
||||
</ul>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
|
|
@ -123,10 +129,6 @@ Kobalt is currently in Beta but I'm already using it to build most of my project
|
|||
<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>
|
||||
|
||||
<p>
|
||||
Where to next? Are you interested in writing some cool Kotlin code and contribute to Kobalt? Or maybe just download and run Kobalt on your own projects just to get a feel for it? Then proceed to <a href="../documentation/index.html">Kobalt's main documentation!</a>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
</p>
|
||||
|
||||
|
|
@ -142,7 +144,7 @@ Kobalt is currently in Beta but I'm already using it to build most of my project
|
|||
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
|
||||
<script src="../bootstrap/dist/js/bootstrap.min.js"></script>
|
||||
<script src="../js/kobalt.js"></script>
|
||||
<script>generateKobalt(0);</script>
|
||||
<script>generateKobalt();</script>
|
||||
|
||||
<!--
|
||||
<script src="../../assets/js/docs.min.js"></script>
|
||||
|
|
|
|||
25
js/kobalt.js
25
js/kobalt.js
|
|
@ -9,6 +9,14 @@ var content = [
|
|||
url: "../home/index.html",
|
||||
title: "Home"
|
||||
},
|
||||
{
|
||||
url: "../getting-started/index.html",
|
||||
title: "Getting Started"
|
||||
},
|
||||
{
|
||||
url: "../idea-plug-in/index.html",
|
||||
title: "IDEA plug-in"
|
||||
},
|
||||
{
|
||||
url: "../documentation/index.html",
|
||||
title: "Documentation"
|
||||
|
|
@ -21,17 +29,9 @@ var content = [
|
|||
url: "../plug-in-development/index.html",
|
||||
title: "Writing a Kobalt plug-in"
|
||||
},
|
||||
{
|
||||
url: "../idea-plug-in/index.html",
|
||||
title: "IDEA plug-in"
|
||||
},
|
||||
{
|
||||
url: "../ten-minutes/index.html",
|
||||
title: "Ten minutes"
|
||||
},
|
||||
{
|
||||
url: "../contributing/index.html",
|
||||
title: "Contributing"
|
||||
title: "Contribute"
|
||||
}
|
||||
|
||||
];
|
||||
|
|
@ -50,14 +50,15 @@ var after = '</ul>'
|
|||
+ '</nav>'
|
||||
;
|
||||
|
||||
function generateNavBar(index) {
|
||||
function generateNavBar() {
|
||||
var result = before;
|
||||
for (var i = 0; i < content.length; i++) {
|
||||
var cls = "";
|
||||
if (index == i) {
|
||||
var c = content[i];
|
||||
var cleanUrl = c.url.replace("../", "")
|
||||
if (window.location.href.indexOf(cleanUrl) > -1) {
|
||||
cls = 'class="active"';
|
||||
}
|
||||
var c = content[i];
|
||||
result += '<li ' + cls + '><a href="' + c.url + '">' + c.title + '</a></li>';
|
||||
}
|
||||
result += after;
|
||||
|
|
|
|||
|
|
@ -1,9 +1,7 @@
|
|||
<html>
|
||||
<head>
|
||||
<title>
|
||||
|
||||
Kobalt, by Cedric Beust
|
||||
|
||||
</title>
|
||||
|
||||
<script type="text/javascript" src="../sh/scripts/shCore.js"></script>
|
||||
|
|
@ -11,103 +9,47 @@
|
|||
<script type="text/javascript" src="../sh/scripts/shBrushJava.js"></script>
|
||||
<script type="text/javascript" src="../sh/scripts/shBrushPlain.js"></script>
|
||||
<script type="text/javascript" src="../sh/scripts/shBrushXml.js"></script>
|
||||
|
||||
<script>
|
||||
SyntaxHighlighter.defaults['gutter'] = false;
|
||||
SyntaxHighlighter.defaults['toolbar'] = false;
|
||||
SyntaxHighlighter.all();
|
||||
</script>
|
||||
|
||||
<!-- Optional Bootstrap Theme -->
|
||||
|
||||
<link href="data:text/css;charset=utf-8," data-href="../bootstrap/dist/css/bootstrap-theme.min.css" rel="stylesheet" id="bs-theme-stylesheet">
|
||||
|
||||
|
||||
<!--[if lt IE 9]><script src="../assets/js/ie8-responsive-file-warning.js"></script><![endif]-->
|
||||
<!--
|
||||
<script src="../bootstrap/assets/js/ie-emulation-modes-warning.js"></script>
|
||||
-->
|
||||
|
||||
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
|
||||
<!--[if lt IE 9]>
|
||||
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
|
||||
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<!-- Favicons -->
|
||||
<!--
|
||||
<link rel="icon" href="/favicon.ico">
|
||||
-->
|
||||
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
|
||||
<div class="container">
|
||||
|
||||
<!-- Static navbar -->
|
||||
<nav id="kobalt-navbar" class="navbar navbar-default">
|
||||
</nav>
|
||||
|
||||
<!-- Main component for a primary marketing message or call to action -->
|
||||
<div class="jumbotron">
|
||||
<h1>Plug-in development</h1>
|
||||
<p>How to write a Kobalt plug-in.</p>
|
||||
</div>
|
||||
|
||||
<!-- Main content -->
|
||||
<div class="col-md-9">
|
||||
|
||||
<h2 class="section" id="introduction">Introduction</h2>
|
||||
|
||||
<p>
|
||||
Kobalt plug-ins are usually made of several parts:
|
||||
|
||||
<ul>
|
||||
<li><a href="#plugin-xml"><b>kobalt-plugin.xml</b></a>. A file that describes all the components (called "plug-in actors") of your plug-in, such as contributors.</li>
|
||||
<li><a href="#directives"><b>Directives</b></a>. Kotlin functions that users of your plug-in can invoke in their build file, such as <code>kotlinProject</code> or <code>dependencies</code>. These functions typically configure some data that your plug-in will later use to perform its functions.</li>
|
||||
<li><a href="#tasks"><b>Tasks</b></a>. These tasks are invoked from the command line and ask your plug-ins to perform certain actions.</li>
|
||||
<li><a href="#properties"><b>Properties</b></a>. Plug-ins can export properties and read properties from other plug-ins.</li>
|
||||
</ul>
|
||||
</p>
|
||||
<h2 class="section" id="tutorial">Tutorial</h2>
|
||||
<p>
|
||||
If you are curious to get a quick feel for what a Kobalt plug-in looks like, I suggest you go read how to
|
||||
<a href="../ten-minutes/index.html">write and publish a plug-in in ten minutes</a> and then you can come back here
|
||||
and keep reading.
|
||||
</p>
|
||||
|
||||
<h2 class="section" id="kobalt-plugin-xml">kobalt-plugin.xml</h2>
|
||||
<p>
|
||||
The <code>kobalt-plugin.xml</code> file (stored in <code>META-INF</code> in the jar file of your plug-in) is mandatory and describes all the actors of your plug-in. This file contains a list of class names, each of which is expected to implement at least one of <code>IPluginActor</code>'s interfaces:
|
||||
</p>
|
||||
<pre class="brush:xml">
|
||||
<kobalt-plugin>
|
||||
<name>kobalt</name>
|
||||
<plugin-actors>
|
||||
<class-name>com.beust.kobalt.plugin.android.AndroidPlugin</class-name>
|
||||
<class-name>com.beust.kobalt.plugin.java.JavaBuildGenerator</class-name>
|
||||
</plugin-actors>
|
||||
</kobalt-plugin>
|
||||
</pre>
|
||||
|
||||
<p>
|
||||
<code>IPluginActors</code> can be split in several categories:
|
||||
</p>
|
||||
<ul>
|
||||
<li><strong>Plugins</strong>, which contain <code>@Task</code> annotations.</li>
|
||||
<li><strong>Interceptors</strong>, which transform data that Kobalt gives them.</li>
|
||||
<li><strong>Contributors</strong>, which produce additional data.</li>
|
||||
</ul>
|
||||
<p>
|
||||
All plug-in actors are interfaces that extend <code>IPluginActor</code>. Plug-ins extend <code>IPlugin</code>,
|
||||
interceptors extend <code>IInterceptor</code> and contributors extend <code>IContributor</code>. When Kobalt parses your
|
||||
<code>kobalt-plugin.xml</code>, it instantiates all the classes found in the <code><plugin-actors></code> tag
|
||||
and then introspects them to find out which <code>IPluginActor</code> interfaces that class implements.
|
||||
|
||||
</p>
|
||||
|
||||
<h3 class="section" id="philosophy">Plug-in architecture philosophy</h3>
|
||||
<h2 class="section" id="philosophy">Plug-in architecture</h3>
|
||||
<p>
|
||||
<p>
|
||||
Plug-ins often produce files and data that other plug-ins need to use in order for a build to succeed. For example,
|
||||
|
|
@ -122,10 +64,58 @@
|
|||
These "actors" are exactly what the <code>kobalt-plugin.xml</code> file describes. This file informs Kobalt about
|
||||
the various ways in which your plug-in participates in the build system by specifying 1) plug-ins, 2) contributors
|
||||
or 3) interceptors.
|
||||
|
||||
</p>
|
||||
</p>
|
||||
|
||||
<h3 class="section" id="introduction" indent="1">Parts</h2>
|
||||
<p>
|
||||
<ul>
|
||||
<li><a href="#plugin-xml"><b>kobalt-plugin.xml</b></a>. A file that describes all the components (called "plug-in actors") of your plug-in, such as contributors.</li>
|
||||
<li><a href="#directives"><b>Directives</b></a>. Kotlin functions that users of your plug-in can invoke in their build file, such as <code>kotlinProject</code> or <code>dependencies</code>. These functions typically configure some data that your plug-in will later use to perform its functions.</li>
|
||||
<li><a href="#tasks"><b>Tasks</b></a>. These tasks are invoked from the command line and ask your plug-ins to perform certain actions.</li>
|
||||
<li><a href="#properties"><b>Properties</b></a>. Plug-ins can export properties and read properties from other plug-ins.</li>
|
||||
</ul>
|
||||
</p>
|
||||
|
||||
<h3 class="section" id="kobalt-plugin-xml" indent="1">kobalt-plugin.xml</h2>
|
||||
<p>
|
||||
The <code>kobalt-plugin.xml</code> file (stored in <code>META-INF</code> in the jar file of your plug-in) is mandatory and describes all the actors of your plug-in. This file contains a list of class names, each of which is expected to implement at least one of <code>IPluginActor</code>'s interfaces:
|
||||
</p>
|
||||
<pre class="brush:xml">
|
||||
<plugin-actors>
|
||||
<class-name>com.beust.kobalt.plugin.java.JavaPlugin</class-name>
|
||||
<class-name>com.beust.kobalt.plugin.android.AndroidPlugin</class-name>
|
||||
<class-name>com.beust.kobalt.plugin.java.JavaBuildGenerator</class-name>
|
||||
<class-name>com.beust.kobalt.plugin.kotlin.KotlinBuildGenerator</class-name>
|
||||
</plugin-actors>
|
||||
</pre>
|
||||
<p>
|
||||
<code>IPluginActors</code> can be split in several categories:
|
||||
</p>
|
||||
<ul>
|
||||
<li><strong>Plugins</strong>, which contain <code>@Task</code> annotations.</li>
|
||||
<li><strong>Interceptors</strong>, which transform data that Kobalt gives them.</li>
|
||||
<li><strong>Contributors</strong>, which produce additional data.</li>
|
||||
</ul>
|
||||
<p>
|
||||
All plug-in actors are interfaces that extend <code>IPluginActor</code>. Plug-ins extend <code>IPlugin</code>,
|
||||
interceptors extend <code>IInterceptor</code> and contributors extend <code>IContributor</code>. When Kobalt parses your
|
||||
<code>kobalt-plugin.xml</code>, it instantiates all the classes found in the <code><plugin-actors></code> tag
|
||||
and then introspects them to find out which <code>IPluginActor</code> interfaces that class implements.
|
||||
</p>
|
||||
<p>
|
||||
If we look a the declarations of these classes, we can get an idea what they do
|
||||
</p>
|
||||
<pre class="brush:java">
|
||||
class JavaPlugin : ICompilerContributor, IDocContributor {</pre>
|
||||
<p>
|
||||
With this declaration, we know that the <code>JavaPlugin</code> contributes a compiler and a doc generator.
|
||||
</p>
|
||||
<pre class="brush:java">
|
||||
class JavaBuildGenerator: IInitContributor {</pre>
|
||||
<p>
|
||||
This class is declaring that it wants to take part in the <code>--init</code> selection process, discussed below.
|
||||
</p>
|
||||
<h2 class="section" id="actor-list">List of plug-in actors</h2>
|
||||
<p>
|
||||
Here is a list of actors (contributors and interceptors) that you can define in your plug-in.
|
||||
|
|
@ -159,7 +149,6 @@
|
|||
<td> Classpath contributors let you specify additional jar files or directories that will be used by
|
||||
the <code>"compile"</code> task.
|
||||
</td>
|
||||
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code><a href="https://github.com/cbeust/kobalt/blob/master/src/main/kotlin/com/beust/kobalt/api/IClasspathInterceptor.kt">IClasspathInterceptor
|
||||
|
|
@ -267,37 +256,6 @@
|
|||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h2 class="section" id="example">Example</h2>
|
||||
<p>
|
||||
Kobalt itself uses a <code>kobalt-plugin.xml</code> to define contributors and interceptors, here is
|
||||
an excerpt of it:
|
||||
</p>
|
||||
<pre class="brush:xml">
|
||||
<plugin-actors>
|
||||
<class-name>com.beust.kobalt.plugin.java.JavaPlugin</class-name>
|
||||
<class-name>com.beust.kobalt.plugin.android.AndroidPlugin</class-name>
|
||||
|
||||
<class-name>com.beust.kobalt.plugin.java.JavaBuildGenerator</class-name>
|
||||
<class-name>com.beust.kobalt.plugin.kotlin.KotlinBuildGenerator</class-name>
|
||||
</plugin-actors>
|
||||
</pre>
|
||||
<p>
|
||||
In order to find out what these actually do, we just need to take a look at their definition and
|
||||
see which interfaces they implement. For example:
|
||||
</p>
|
||||
<pre class="brush:java">
|
||||
class JavaPlugin : ICompilerContributor, IDocContributor {</pre>
|
||||
|
||||
<p>
|
||||
With this declaration, we know that the <code>JavaPlugin</code> contributes a compiler and a doc generator.
|
||||
</p>
|
||||
<pre class="brush:java">
|
||||
class JavaBuildGenerator: IInitContributor {</pre>
|
||||
<p>
|
||||
This class is declaring that it wants to take part in the <code>--init</code> selection process, which is
|
||||
discussed in the next section.
|
||||
</p>
|
||||
<h2 class="section" id="selection-process">Selection process</h2>
|
||||
<p>
|
||||
Several plug-ins might want to contribute to a specific task where only one participant should be allowed,
|
||||
|
|
@ -323,12 +281,9 @@ interface IProjectAffinity {
|
|||
For example, the JavaPlugin implements the <code><a href="https://github.com/cbeust/kobalt/blob/master/src/main/kotlin/com/beust/kobalt/api/ICompilerContributor.kt">ICompilerContributor</a></code> interface and then overrides
|
||||
the <code>affinity()</code> method to make sure it gets run for Java projects but ignored for others:
|
||||
</p>
|
||||
|
||||
<pre class="brush:java">
|
||||
override fun affinity(project: Project, context: KobaltContext) =
|
||||
if (project.sourceSuffix == ".java") 1 else 0</pre>
|
||||
|
||||
|
||||
<h2 class="section" id="directives">Directives</h2>
|
||||
<p>
|
||||
Directives are functions that users of your plug-in can use in their build file in order to configure your plug-in. These can be any kind of Kotlin function but in the interest of preserving a clean syntax in the build file, it's recommended to use the type safe builder pattern, <a href="https://kotlinlang.org/docs/reference/type-safe-builders.html">as described here</a>.
|
||||
|
|
@ -355,7 +310,6 @@ public fun myConfig(init: Info.() -> Unit) = Info().apply { init() }</pre>
|
|||
<pre class="brush:java">
|
||||
// Build.kt
|
||||
<imp></imp>ort.com.example.plugin.myConfig
|
||||
|
||||
myConfig {
|
||||
publish = true
|
||||
}</pre>
|
||||
|
|
@ -375,7 +329,6 @@ myConfig(project) {
|
|||
<p>
|
||||
The last piece of this puzzle is how you give this data back to your plug-in so it can act on it. In order to do this, you simply look up the name of your plug-in in the <code>Plugins</code> registry and invoke whatever function you need to run:
|
||||
</p>
|
||||
|
||||
<pre class="brush:java">
|
||||
@Directive
|
||||
public fun myConfig(init: Info.() -> Unit) = Info().apply {
|
||||
|
|
@ -406,7 +359,6 @@ fun lineCount(project: Project): TaskResult {
|
|||
<p>
|
||||
A Kobalt task needs to accept a <code>Project</code> in parameter and return a <code>TaskResult</code>, which indicates whether this task completed successfully.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
The <code>@Task</code> annotation accepts the following attributes:
|
||||
<dl class="dl-horizontal">
|
||||
|
|
@ -456,7 +408,6 @@ fun lineCount(project: Project): TaskResult {
|
|||
<td align="center">Configuration for <code>exampleTask</code></td>
|
||||
<td align="center">Result</td>
|
||||
</thead>
|
||||
|
||||
<tr>
|
||||
<td align="center">runBefore = "compile"</td>
|
||||
<td>
|
||||
|
|
@ -481,9 +432,7 @@ kobalt-line-count:exampleTask</pre>
|
|||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h3 class="section" indent="1">Dynamic tasks</h3>
|
||||
|
||||
<p>
|
||||
Dynamic tasks are useful when you want your plug-in to generate one or several tasks that depend on
|
||||
some other runtime information (therefore, you can't declare a method and put a <code>@Task</code>
|
||||
|
|
@ -524,7 +473,6 @@ $ ./kobaltw --tasks
|
|||
$ ./kobaltw dynamicTask
|
||||
Running dynamictask
|
||||
</pre>
|
||||
|
||||
<h2 class="section" id="properties">Properties</h2>
|
||||
<p>
|
||||
Properties are the mechanism that plug-ins can use to export values and also read values that other
|
||||
|
|
@ -536,7 +484,6 @@ Running dynamictask
|
|||
in particular.</li>
|
||||
</ul>
|
||||
<h3 class="section" indent="1" id="project-properties">Project properties</h3>
|
||||
|
||||
<p>
|
||||
<code>Project</code> instances have a property called <code>projectProperties</code> that is an
|
||||
instance of the <code>ProjectProperties</code> class. Plugins can put and get values on this
|
||||
|
|
@ -556,14 +503,11 @@ fun taskAssemble(project: Project) : TaskResult {
|
|||
override fun apply(project: Project, context: KobaltContext) {
|
||||
// Export a property for other plug-ins to use
|
||||
context.pluginProperties.put(PLUGIN_NAME, "somePluginProperty", "someValue")
|
||||
|
||||
// Read a property from another plug-in
|
||||
val sourceDir = context.pluginProperties.get("pluginName", "somePluginProperty")
|
||||
}
|
||||
</pre>
|
||||
|
||||
<h3 class="section" indent="1" id="documenting-properties">Documenting properties</h3>
|
||||
|
||||
<p>
|
||||
Plug-ins that define properties should annotate them with the <code>@ExportedPluginProperty</code> or
|
||||
<code>@ExportedProjectProperty</code>annotation:
|
||||
|
|
@ -573,20 +517,17 @@ override fun apply(project: Project, context: KobaltContext) {
|
|||
@ExportedProjectProperty
|
||||
const val BUILD_DIR = "buildDir"
|
||||
</pre>
|
||||
|
||||
</div>
|
||||
<!-- Table of contents -->
|
||||
<div class="col-md-3" id="table-of-contents">
|
||||
</div>
|
||||
|
||||
<!-- Bootstrap core JavaScript
|
||||
================================================== -->
|
||||
<!-- Placed at the end of the document so the pages load faster -->
|
||||
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
|
||||
<script src="../bootstrap/dist/js/bootstrap.min.js"></script>
|
||||
<script src="../js/kobalt.js"></script>
|
||||
<script>generateKobalt(3);</script>
|
||||
|
||||
<script>generateKobalt();</script>
|
||||
<!--
|
||||
<script src="../bootstrap/dist/js/docs.min.js"></script>
|
||||
-->
|
||||
|
|
@ -594,6 +535,5 @@ override fun apply(project: Project, context: KobaltContext) {
|
|||
<!--
|
||||
<script src="../../assets/js/ie10-viewport-bug-workaround.js"></script>
|
||||
-->
|
||||
|
||||
</div>
|
||||
</body>
|
||||
Loading…
Add table
Add a link
Reference in a new issue