Skip to content

Commit 51f6c7a

Browse files
ajaltajalt
committed
Release version 1.1.0
* Add `List<String>` overloads to `CliktCommand.parse` and `main` * Add `err` parameter to `TermUi.echo` * Add `error` property to `Abort`
1 parent 6960fe9 commit 51f6c7a

File tree

12 files changed

+73
-29
lines changed

12 files changed

+73
-29
lines changed

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ list, then you can add Clikt to your project:
8585

8686
```groovy
8787
dependencies {
88-
compile 'com.github.ajalt:clikt:1.0.0'
88+
compile 'com.github.ajalt:clikt:1.1.0'
8989
}
9090
```
9191

‎docs/api/clikt/com.github.ajalt.clikt.core/-abort/-init-.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
<a href="../../index.html">clikt</a>&nbsp;/&nbsp;<a href="../index.html">com.github.ajalt.clikt.core</a>&nbsp;/&nbsp;<a href="index.html">Abort</a>&nbsp;/&nbsp;<a href="./-init-.html">&lt;init&gt;</a><br/>
99
<br/>
1010
<h1>&lt;init&gt;</h1>
11-
<a name="com.github.ajalt.clikt.core.Abort$&lt;init&gt;()"></a>
12-
<code><span class="identifier">Abort</span><span class="symbol">(</span><span class="symbol">)</span></code>
11+
<a name="com.github.ajalt.clikt.core.Abort$&lt;init&gt;(kotlin.Boolean)"></a>
12+
<code><span class="identifier">Abort</span><span class="symbol">(</span><span class="identifier" id="com.github.ajalt.clikt.core.Abort$<init>(kotlin.Boolean)/error">error</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a>&nbsp;<span class="symbol">=</span>&nbsp;true<span class="symbol">)</span></code>
1313
<p>An internal error that signals Clikt to abort.</p>
1414
</BODY>
1515
</HTML>

‎docs/api/clikt/com.github.ajalt.clikt.core/-abort/error.html

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<HTML>
2+
<HEAD>
3+
<meta charset="UTF-8">
4+
<title>Abort.error - clikt</title>
5+
<link rel="stylesheet" href="..\..\..\style.css">
6+
</HEAD>
7+
<BODY>
8+
<a href="../../index.html">clikt</a>&nbsp;/&nbsp;<a href="../index.html">com.github.ajalt.clikt.core</a>&nbsp;/&nbsp;<a href="index.html">Abort</a>&nbsp;/&nbsp;<a href="./error.html">error</a><br/>
9+
<br/>
10+
<h1>error</h1>
11+
<a name="com.github.ajalt.clikt.core.Abort$error"></a>
12+
<code><span class="keyword">val </span><span class="identifier">error</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code>
13+
<p>If true, print "Aborted" and exit with an error code. Otherwise, exit with no error code.</p>
14+
<h3>Property</h3>
15+
<p><a name="error"></a>
16+
<code>error</code> - If true, print "Aborted" and exit with an error code. Otherwise, exit with no error code.</p>
17+
</BODY>
18+
</HTML>

‎docs/api/clikt/com.github.ajalt.clikt.core/-abort/index.html

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,25 @@ <h3>Constructors</h3>
1818
<p><a href="-init-.html">&lt;init&gt;</a></p>
1919
</td>
2020
<td>
21-
<code><span class="identifier">Abort</span><span class="symbol">(</span><span class="symbol">)</span></code>
21+
<code><span class="identifier">Abort</span><span class="symbol">(</span><span class="identifier" id="com.github.ajalt.clikt.core.Abort$<init>(kotlin.Boolean)/error">error</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a>&nbsp;<span class="symbol">=</span>&nbsp;true<span class="symbol">)</span></code>
2222
<p>An internal error that signals Clikt to abort.</p>
2323
</td>
2424
</tr>
2525
</tbody>
2626
</table>
27+
<h3>Properties</h3>
28+
<table>
29+
<tbody>
30+
<tr>
31+
<td>
32+
<p><a href="error.html">error</a></p>
33+
</td>
34+
<td>
35+
<code><span class="keyword">val </span><span class="identifier">error</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code>
36+
<p>If true, print "Aborted" and exit with an error code. Otherwise, exit with no error code.</p>
37+
</td>
38+
</tr>
39+
</tbody>
40+
</table>
2741
</BODY>
2842
</HTML>

‎docs/api/clikt/com.github.ajalt.clikt.core/-clikt-command/index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -121,18 +121,18 @@ <h3>Functions</h3>
121121
<p><a href="main.html">main</a></p>
122122
</td>
123123
<td>
124-
<code><span class="keyword">fun </span><span class="identifier">main</span><span class="symbol">(</span><span class="identifier" id="com.github.ajalt.clikt.core.CliktCommand$main(kotlin.Array((kotlin.String)))/argv">argv</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html"><span class="identifier">Array</span></a><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
124+
<code><span class="keyword">fun </span><span class="identifier">main</span><span class="symbol">(</span><span class="identifier" id="com.github.ajalt.clikt.core.CliktCommand$main(kotlin.collections.List((kotlin.String)))/argv">argv</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
125125
<p>Parse the command line and print helpful output if any errors occur.</p>
126-
</td>
126+
<code><span class="keyword">fun </span><span class="identifier">main</span><span class="symbol">(</span><span class="identifier" id="com.github.ajalt.clikt.core.CliktCommand$main(kotlin.Array((kotlin.String)))/argv">argv</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html"><span class="identifier">Array</span></a><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code></td>
127127
</tr>
128128
<tr>
129129
<td>
130130
<p><a href="parse.html">parse</a></p>
131131
</td>
132132
<td>
133-
<code><span class="keyword">fun </span><span class="identifier">parse</span><span class="symbol">(</span><span class="identifier" id="com.github.ajalt.clikt.core.CliktCommand$parse(kotlin.Array((kotlin.String)), com.github.ajalt.clikt.core.Context)/argv">argv</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html"><span class="identifier">Array</span></a><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">&gt;</span><span class="symbol">, </span><span class="identifier" id="com.github.ajalt.clikt.core.CliktCommand$parse(kotlin.Array((kotlin.String)), com.github.ajalt.clikt.core.Context)/context">context</span><span class="symbol">:</span>&nbsp;<a href="../-context/index.html"><span class="identifier">Context</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
133+
<code><span class="keyword">fun </span><span class="identifier">parse</span><span class="symbol">(</span><span class="identifier" id="com.github.ajalt.clikt.core.CliktCommand$parse(kotlin.collections.List((kotlin.String)), com.github.ajalt.clikt.core.Context)/argv">argv</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">&gt;</span><span class="symbol">, </span><span class="identifier" id="com.github.ajalt.clikt.core.CliktCommand$parse(kotlin.collections.List((kotlin.String)), com.github.ajalt.clikt.core.Context)/parentContext">parentContext</span><span class="symbol">:</span>&nbsp;<a href="../-context/index.html"><span class="identifier">Context</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
134134
<p>Parse the command line and throw an exception if parsing fails.</p>
135-
</td>
135+
<code><span class="keyword">fun </span><span class="identifier">parse</span><span class="symbol">(</span><span class="identifier" id="com.github.ajalt.clikt.core.CliktCommand$parse(kotlin.Array((kotlin.String)), com.github.ajalt.clikt.core.Context)/argv">argv</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html"><span class="identifier">Array</span></a><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">&gt;</span><span class="symbol">, </span><span class="identifier" id="com.github.ajalt.clikt.core.CliktCommand$parse(kotlin.Array((kotlin.String)), com.github.ajalt.clikt.core.Context)/parentContext">parentContext</span><span class="symbol">:</span>&nbsp;<a href="../-context/index.html"><span class="identifier">Context</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code></td>
136136
</tr>
137137
<tr>
138138
<td>

‎docs/api/clikt/com.github.ajalt.clikt.core/-clikt-command/main.html

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,12 @@
88
<a href="../../index.html">clikt</a>&nbsp;/&nbsp;<a href="../index.html">com.github.ajalt.clikt.core</a>&nbsp;/&nbsp;<a href="index.html">CliktCommand</a>&nbsp;/&nbsp;<a href="./main.html">main</a><br/>
99
<br/>
1010
<h1>main</h1>
11-
<a name="com.github.ajalt.clikt.core.CliktCommand$main(kotlin.Array((kotlin.String)))"></a>
12-
<code><span class="keyword">fun </span><span class="identifier">main</span><span class="symbol">(</span><span class="identifier" id="com.github.ajalt.clikt.core.CliktCommand$main(kotlin.Array((kotlin.String)))/argv">argv</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html"><span class="identifier">Array</span></a><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
11+
<a name="com.github.ajalt.clikt.core.CliktCommand$main(kotlin.collections.List((kotlin.String)))"></a>
12+
<code><span class="keyword">fun </span><span class="identifier">main</span><span class="symbol">(</span><span class="identifier" id="com.github.ajalt.clikt.core.CliktCommand$main(kotlin.collections.List((kotlin.String)))/argv">argv</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
1313
<p>Parse the command line and print helpful output if any errors occur.</p>
1414
<p>This function calls <a href="parse.html">parse</a> and catches and <a href="../-clikt-error/index.html">CliktError</a>s that are thrown. Other error are allowed to
1515
pass through.</p>
16+
<a name="com.github.ajalt.clikt.core.CliktCommand$main(kotlin.Array((kotlin.String)))"></a>
17+
<code><span class="keyword">fun </span><span class="identifier">main</span><span class="symbol">(</span><span class="identifier" id="com.github.ajalt.clikt.core.CliktCommand$main(kotlin.Array((kotlin.String)))/argv">argv</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html"><span class="identifier">Array</span></a><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
1618
</BODY>
1719
</HTML>

‎docs/api/clikt/com.github.ajalt.clikt.core/-clikt-command/parse.html

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,11 @@
88
<a href="../../index.html">clikt</a>&nbsp;/&nbsp;<a href="../index.html">com.github.ajalt.clikt.core</a>&nbsp;/&nbsp;<a href="index.html">CliktCommand</a>&nbsp;/&nbsp;<a href="./parse.html">parse</a><br/>
99
<br/>
1010
<h1>parse</h1>
11-
<a name="com.github.ajalt.clikt.core.CliktCommand$parse(kotlin.Array((kotlin.String)), com.github.ajalt.clikt.core.Context)"></a>
12-
<code><span class="keyword">fun </span><span class="identifier">parse</span><span class="symbol">(</span><span class="identifier" id="com.github.ajalt.clikt.core.CliktCommand$parse(kotlin.Array((kotlin.String)), com.github.ajalt.clikt.core.Context)/argv">argv</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html"><span class="identifier">Array</span></a><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">&gt;</span><span class="symbol">, </span><span class="identifier" id="com.github.ajalt.clikt.core.CliktCommand$parse(kotlin.Array((kotlin.String)), com.github.ajalt.clikt.core.Context)/context">context</span><span class="symbol">:</span>&nbsp;<a href="../-context/index.html"><span class="identifier">Context</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
11+
<a name="com.github.ajalt.clikt.core.CliktCommand$parse(kotlin.collections.List((kotlin.String)), com.github.ajalt.clikt.core.Context)"></a>
12+
<code><span class="keyword">fun </span><span class="identifier">parse</span><span class="symbol">(</span><span class="identifier" id="com.github.ajalt.clikt.core.CliktCommand$parse(kotlin.collections.List((kotlin.String)), com.github.ajalt.clikt.core.Context)/argv">argv</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html"><span class="identifier">List</span></a><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">&gt;</span><span class="symbol">, </span><span class="identifier" id="com.github.ajalt.clikt.core.CliktCommand$parse(kotlin.collections.List((kotlin.String)), com.github.ajalt.clikt.core.Context)/parentContext">parentContext</span><span class="symbol">:</span>&nbsp;<a href="../-context/index.html"><span class="identifier">Context</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
1313
<p>Parse the command line and throw an exception if parsing fails.</p>
1414
<p>You should use <a href="main.html">main</a> instead unless you want to handle output yourself.</p>
15+
<a name="com.github.ajalt.clikt.core.CliktCommand$parse(kotlin.Array((kotlin.String)), com.github.ajalt.clikt.core.Context)"></a>
16+
<code><span class="keyword">fun </span><span class="identifier">parse</span><span class="symbol">(</span><span class="identifier" id="com.github.ajalt.clikt.core.CliktCommand$parse(kotlin.Array((kotlin.String)), com.github.ajalt.clikt.core.Context)/argv">argv</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html"><span class="identifier">Array</span></a><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">&gt;</span><span class="symbol">, </span><span class="identifier" id="com.github.ajalt.clikt.core.CliktCommand$parse(kotlin.Array((kotlin.String)), com.github.ajalt.clikt.core.Context)/parentContext">parentContext</span><span class="symbol">:</span>&nbsp;<a href="../-context/index.html"><span class="identifier">Context</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
1517
</BODY>
1618
</HTML>

0 commit comments

Comments
 (0)