Release picocli v1.0.0

remkop · Aug 26, 2017 · fd28383 · fd28383
1 parent d2101c1
commit fd28383
Show file tree

Hide file tree

Showing 49 changed files with 3,027 additions and 536 deletions.
diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
@@ -1,9 +1,12 @@
 # picocli Release Notes
 
-## 1.0.0 - Public release
+## 1.0.0 - Bugfix and enhancements release.
 
 ### Summary: command line autocompletion, `-Dkey=value`-like Map options, parser tracing, stricter parsing, bugfixes
 
+This is the tenth public release.
+Picocli follows [semantic versioning](http://semver.org/).
+
 * #121 New feature: command line autocompletion. Picocli can generate bash and zsh completion scripts that allow the shell to generate potential completion matches based on the `@Option` and `@Command` annotations in your application. After this script is installed, the shell will show the options and subcommands available in your java command line application, and in some cases show possible option values.
 * #67  New feature: Map options like `-Dkey1=val1 -Dkey2=val2`. Both key and value can be strongly typed (not just Strings).
 * #158 New feature: parser TRACING for easy troubleshooting. The trace level can be controlled with a system property.

diff --git a/build.gradle b/build.gradle
@@ -1,11 +1,11 @@
 group 'info.picocli'
-description 'Annotation-based Java command line parser. Usage help with ANSI styles and colors. Easily included as source to avoid adding a dependency.'
-version '1.0.0-SNAPSHOT'
+description 'Annotation-based Java command line parser. Usage help with ANSI styles and colors. Autocomplete. Nested subcommands. Easily included as source to avoid adding a dependency.'
+version '1.0.0'
 
 // for bumpVersion task
-def oldVersion = '0\\.9\\.8'
+def oldVersion = '1\\.0\\.0-SNAPSHOT'
 def oldRevdate = '2017\\-08\\-07'
-def revDate    = '2017-08-07'
+def revDate    = '2017-08-26'
 
 buildscript {
     repositories {
@@ -87,9 +87,13 @@ task bumpVersion {
             fileset(dir: 'src/main/java/picocli', includes: 'CommandLine.java')
             fileset(dir: 'src/test/java/picocli', includes: 'CommandLineTest.java')
         }
+        ant.replaceregexp(match: "version $oldVersion", replace: "version $version", flags: 'g', byline: true, encoding: 'UTF8') {
+            fileset(dir: 'src/test/java/picocli', includes: 'AutoCompleteTest.java')
+        }
         // Doc header
         ant.replaceregexp(match: ":revnumber: $oldVersion", replace: ":revnumber: $version", flags: 'g', byline: true, encoding: 'UTF8') {
             fileset(dir: 'docs', includes: 'index.adoc')
+            fileset(dir: 'docs', includes: 'autocomplete.adoc')
         }
         // Downloads section, Gradle
         ant.replaceregexp(match: ":picocli:$oldVersion", replace: ":picocli:$version", flags: 'g', byline: true, encoding: 'UTF8') {
@@ -109,11 +113,13 @@ task bumpVersion {
         }
         ant.replaceregexp(match: oldRevdate, replace: revDate, flags: 'g', byline: true, encoding: 'UTF8') {
             fileset(dir: 'docs', includes: 'index.adoc')
+            fileset(dir: 'docs', includes: 'autocomplete.adoc')
         }
     }
 }
 task copyDocs(type: Copy) {
     from 'build/docs/html5/index.html'
+    from 'build/docs/html5/autocomplete.html'
     from('build/docs/') { exclude 'html5'}
     into 'docs'
 }

diff --git a/docs/apidocs/allclasses-frame.html b/docs/apidocs/allclasses-frame.html
@@ -2,16 +2,17 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Mon Aug 07 01:36:02 JST 2017 -->
-<title>All Classes (picocli 0.9.8 API)</title>
-<meta name="date" content="2017-08-07">
+<!-- Generated by javadoc (1.8.0_131) on Sat Aug 26 23:55:00 JST 2017 -->
+<title>All Classes (picocli 1.0.0 API)</title>
+<meta name="date" content="2017-08-26">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
 <body>
 <h1 class="bar">All&nbsp;Classes</h1>
 <div class="indexContainer">
 <ul>
+<li><a href="picocli/AutoComplete.html" title="class in picocli" target="classFrame">AutoComplete</a></li>
 <li><a href="picocli/CommandLine.html" title="class in picocli" target="classFrame">CommandLine</a></li>
 <li><a href="picocli/CommandLine.Command.html" title="annotation in picocli" target="classFrame">CommandLine.Command</a></li>
 <li><a href="picocli/CommandLine.DuplicateOptionAnnotationsException.html" title="class in picocli" target="classFrame">CommandLine.DuplicateOptionAnnotationsException</a></li>
@@ -28,6 +29,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="picocli/CommandLine.Help.Layout.html" title="class in picocli" target="classFrame">CommandLine.Help.Layout</a></li>
 <li><a href="picocli/CommandLine.Help.TextTable.html" title="class in picocli" target="classFrame">CommandLine.Help.TextTable</a></li>
 <li><a href="picocli/CommandLine.ITypeConverter.html" title="interface in picocli" target="classFrame"><span class="interfaceName">CommandLine.ITypeConverter</span></a></li>
+<li><a href="picocli/CommandLine.MaxValuesforFieldExceededException.html" title="class in picocli" target="classFrame">CommandLine.MaxValuesforFieldExceededException</a></li>
 <li><a href="picocli/CommandLine.MissingParameterException.html" title="class in picocli" target="classFrame">CommandLine.MissingParameterException</a></li>
 <li><a href="picocli/CommandLine.MissingTypeConverterException.html" title="class in picocli" target="classFrame">CommandLine.MissingTypeConverterException</a></li>
 <li><a href="picocli/CommandLine.Option.html" title="annotation in picocli" target="classFrame">CommandLine.Option</a></li>

diff --git a/docs/apidocs/allclasses-noframe.html b/docs/apidocs/allclasses-noframe.html
@@ -2,16 +2,17 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Mon Aug 07 01:36:02 JST 2017 -->
-<title>All Classes (picocli 0.9.8 API)</title>
-<meta name="date" content="2017-08-07">
+<!-- Generated by javadoc (1.8.0_131) on Sat Aug 26 23:55:00 JST 2017 -->
+<title>All Classes (picocli 1.0.0 API)</title>
+<meta name="date" content="2017-08-26">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
 <body>
 <h1 class="bar">All&nbsp;Classes</h1>
 <div class="indexContainer">
 <ul>
+<li><a href="picocli/AutoComplete.html" title="class in picocli">AutoComplete</a></li>
 <li><a href="picocli/CommandLine.html" title="class in picocli">CommandLine</a></li>
 <li><a href="picocli/CommandLine.Command.html" title="annotation in picocli">CommandLine.Command</a></li>
 <li><a href="picocli/CommandLine.DuplicateOptionAnnotationsException.html" title="class in picocli">CommandLine.DuplicateOptionAnnotationsException</a></li>
@@ -28,6 +29,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="picocli/CommandLine.Help.Layout.html" title="class in picocli">CommandLine.Help.Layout</a></li>
 <li><a href="picocli/CommandLine.Help.TextTable.html" title="class in picocli">CommandLine.Help.TextTable</a></li>
 <li><a href="picocli/CommandLine.ITypeConverter.html" title="interface in picocli"><span class="interfaceName">CommandLine.ITypeConverter</span></a></li>
+<li><a href="picocli/CommandLine.MaxValuesforFieldExceededException.html" title="class in picocli">CommandLine.MaxValuesforFieldExceededException</a></li>
 <li><a href="picocli/CommandLine.MissingParameterException.html" title="class in picocli">CommandLine.MissingParameterException</a></li>
 <li><a href="picocli/CommandLine.MissingTypeConverterException.html" title="class in picocli">CommandLine.MissingTypeConverterException</a></li>
 <li><a href="picocli/CommandLine.Option.html" title="annotation in picocli">CommandLine.Option</a></li>

diff --git a/docs/apidocs/constant-values.html b/docs/apidocs/constant-values.html
@@ -2,17 +2,17 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Mon Aug 07 01:36:02 JST 2017 -->
-<title>Constant Field Values (picocli 0.9.8 API)</title>
-<meta name="date" content="2017-08-07">
+<!-- Generated by javadoc (1.8.0_131) on Sat Aug 26 23:55:00 JST 2017 -->
+<title>Constant Field Values (picocli 1.0.0 API)</title>
+<meta name="date" content="2017-08-26">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Constant Field Values (picocli 0.9.8 API)";
+            parent.document.title="Constant Field Values (picocli 1.0.0 API)";
         }
     }
     catch(err) {
@@ -93,7 +93,7 @@ <h2 title="picocli">picocli.*</h2>
 <!--   -->
 </a><code>public&nbsp;static&nbsp;final&nbsp;java.lang.String</code></td>
 <td><code><a href="picocli/CommandLine.html#VERSION">VERSION</a></code></td>
-<td class="colLast"><code>"0.9.8"</code></td>
+<td class="colLast"><code>"1.0.0"</code></td>
 </tr>
 </tbody>
 </table>

diff --git a/docs/apidocs/deprecated-list.html b/docs/apidocs/deprecated-list.html
@@ -2,17 +2,17 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Mon Aug 07 01:36:02 JST 2017 -->
-<title>Deprecated List (picocli 0.9.8 API)</title>
-<meta name="date" content="2017-08-07">
+<!-- Generated by javadoc (1.8.0_131) on Sat Aug 26 23:55:00 JST 2017 -->
+<title>Deprecated List (picocli 1.0.0 API)</title>
+<meta name="date" content="2017-08-26">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Deprecated List (picocli 0.9.8 API)";
+            parent.document.title="Deprecated List (picocli 1.0.0 API)";
         }
     }
     catch(err) {

diff --git a/docs/apidocs/help-doc.html b/docs/apidocs/help-doc.html
@@ -2,17 +2,17 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Mon Aug 07 01:36:02 JST 2017 -->
-<title>API Help (picocli 0.9.8 API)</title>
-<meta name="date" content="2017-08-07">
+<!-- Generated by javadoc (1.8.0_131) on Sat Aug 26 23:55:00 JST 2017 -->
+<title>API Help (picocli 1.0.0 API)</title>
+<meta name="date" content="2017-08-26">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="API Help (picocli 0.9.8 API)";
+            parent.document.title="API Help (picocli 1.0.0 API)";
         }
     }
     catch(err) {

diff --git a/docs/apidocs/index-all.html b/docs/apidocs/index-all.html
@@ -2,17 +2,17 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Mon Aug 07 01:36:02 JST 2017 -->
-<title>Index (picocli 0.9.8 API)</title>
-<meta name="date" content="2017-08-07">
+<!-- Generated by javadoc (1.8.0_131) on Sat Aug 26 23:55:00 JST 2017 -->
+<title>Index (picocli 1.0.0 API)</title>
+<meta name="date" content="2017-08-26">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="Index (picocli 0.9.8 API)";
+            parent.document.title="Index (picocli 1.0.0 API)";
         }
     }
     catch(err) {
@@ -149,12 +149,20 @@ <h2 class="title">A</h2>
 <dd>
 <div class="block">Replaces colors and styles in this scheme with ones specified in system properties, and returns this scheme.</div>
 </dd>
+<dt><a href="picocli/AutoComplete.html" title="class in picocli"><span class="typeNameLink">AutoComplete</span></a> - Class in <a href="picocli/package-summary.html">picocli</a></dt>
+<dd>
+<div class="block">Generates a bash auto-complete script.</div>
+</dd>
 </dl>
 <a name="I:B">
 <!--   -->
 </a>
 <h2 class="title">B</h2>
 <dl>
+<dt><span class="memberNameLink"><a href="picocli/AutoComplete.html#bash-java.lang.String-java.io.File-java.io.File-picocli.CommandLine-">bash(String, File, File, CommandLine)</a></span> - Static method in class picocli.<a href="picocli/AutoComplete.html" title="class in picocli">AutoComplete</a></dt>
+<dd>&nbsp;</dd>
+<dt><span class="memberNameLink"><a href="picocli/AutoComplete.html#bash-java.lang.String-picocli.CommandLine-">bash(String, CommandLine)</a></span> - Static method in class picocli.<a href="picocli/AutoComplete.html" title="class in picocli">AutoComplete</a></dt>
+<dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.Ansi.Style.html#bg-java.lang.String-">bg(String)</a></span> - Static method in enum picocli.<a href="picocli/CommandLine.Help.Ansi.Style.html" title="enum in picocli">CommandLine.Help.Ansi.Style</a></dt>
 <dd>
 <div class="block">Parses the specified style markup and returns the associated style.</div>
@@ -165,6 +173,14 @@ <h2 class="title">B</h2>
 </a>
 <h2 class="title">C</h2>
 <dl>
+<dt><span class="memberNameLink"><a href="picocli/CommandLine.html#call-C-java.io.PrintStream-java.lang.String...-">call(C, PrintStream, String...)</a></span> - Static method in class picocli.<a href="picocli/CommandLine.html" title="class in picocli">CommandLine</a></dt>
+<dd>
+<div class="block">Delegates to <a href="picocli/CommandLine.html#call-C-java.io.PrintStream-picocli.CommandLine.Help.Ansi-java.lang.String...-"><code>CommandLine.call(Callable, PrintStream, Help.Ansi, String...)</code></a> with <a href="picocli/CommandLine.Help.Ansi.html#AUTO"><code>CommandLine.Help.Ansi.AUTO</code></a>.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="picocli/CommandLine.html#call-C-java.io.PrintStream-picocli.CommandLine.Help.Ansi-java.lang.String...-">call(C, PrintStream, CommandLine.Help.Ansi, String...)</a></span> - Static method in class picocli.<a href="picocli/CommandLine.html" title="class in picocli">CommandLine</a></dt>
+<dd>
+<div class="block">Convenience method to allow command line application authors to avoid some boilerplate code in their application.</div>
+</dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.TextTable.html#cellAt-int-int-">cellAt(int, int)</a></span> - Method in class picocli.<a href="picocli/CommandLine.Help.TextTable.html" title="class in picocli">CommandLine.Help.TextTable</a></dt>
 <dd>
 <div class="block">Returns the <code>Text</code> slot at the specified row and column to write a text value into.</div>
@@ -281,6 +297,10 @@ <h2 class="title">C</h2>
  fields annotated with <a href="picocli/CommandLine.Option.html" title="annotation in picocli"><code>@Option</code></a> or <a href="picocli/CommandLine.Parameters.html" title="annotation in picocli"><code>@Parameters</code></a>,
  String values can be converted to any type for which a <code>ITypeConverter</code> is registered.</div>
 </dd>
+<dt><a href="picocli/CommandLine.MaxValuesforFieldExceededException.html" title="class in picocli"><span class="typeNameLink">CommandLine.MaxValuesforFieldExceededException</span></a> - Exception in <a href="picocli/package-summary.html">picocli</a></dt>
+<dd>
+<div class="block">Exception indicating that more values were specified for an option or parameter than its <a href="picocli/CommandLine.Option.html#arity--"><code>arity</code></a> allows.</div>
+</dd>
 <dt><a href="picocli/CommandLine.MissingParameterException.html" title="class in picocli"><span class="typeNameLink">CommandLine.MissingParameterException</span></a> - Exception in <a href="picocli/package-summary.html">picocli</a></dt>
 <dd>
 <div class="block">Exception indicating that a required parameter was not specified.</div>
@@ -645,6 +665,8 @@ <h2 class="title">L</h2>
 </a>
 <h2 class="title">M</h2>
 <dl>
+<dt><span class="memberNameLink"><a href="picocli/AutoComplete.html#main-java.lang.String...-">main(String...)</a></span> - Static method in class picocli.<a href="picocli/AutoComplete.html" title="class in picocli">AutoComplete</a></dt>
+<dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Range.html#max">max</a></span> - Variable in class picocli.<a href="picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a></dt>
 <dd>
 <div class="block">Maximum accepted number of parameters for an option or positional parameter.</div>
@@ -653,6 +675,8 @@ <h2 class="title">M</h2>
 <dd>
 <div class="block">Returns a new Range object with the <code>max</code> value replaced by the specified value.</div>
 </dd>
+<dt><span class="memberNameLink"><a href="picocli/CommandLine.MaxValuesforFieldExceededException.html#MaxValuesforFieldExceededException-java.lang.String-">MaxValuesforFieldExceededException(String)</a></span> - Constructor for exception picocli.<a href="picocli/CommandLine.MaxValuesforFieldExceededException.html" title="class in picocli">CommandLine.MaxValuesforFieldExceededException</a></dt>
+<dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Range.html#min">min</a></span> - Variable in class picocli.<a href="picocli/CommandLine.Range.html" title="class in picocli">CommandLine.Range</a></dt>
 <dd>
 <div class="block">Required number of parameters for an option or positional parameter.</div>
@@ -836,6 +860,10 @@ <h2 class="title">P</h2>
 <dd>
 <div class="block">Prints version information from the <a href="picocli/CommandLine.Command.html#version--"><code>CommandLine.Command.version()</code></a> annotation to the specified <code>PrintStream</code>.</div>
 </dd>
+<dt><span class="memberNameLink"><a href="picocli/CommandLine.html#printVersionHelp-java.io.PrintStream-picocli.CommandLine.Help.Ansi-java.lang.Object...-">printVersionHelp(PrintStream, CommandLine.Help.Ansi, Object...)</a></span> - Method in class picocli.<a href="picocli/CommandLine.html" title="class in picocli">CommandLine</a></dt>
+<dd>
+<div class="block">Prints version information from the <a href="picocli/CommandLine.Command.html#version--"><code>CommandLine.Command.version()</code></a> annotation to the specified <code>PrintStream</code>.</div>
+</dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.Help.TextTable.html#putValue-int-int-picocli.CommandLine.Help.Ansi.Text-">putValue(int, int, CommandLine.Help.Ansi.Text)</a></span> - Method in class picocli.<a href="picocli/CommandLine.Help.TextTable.html" title="class in picocli">CommandLine.Help.TextTable</a></dt>
 <dd>
 <div class="block">Writes the specified value into the cell at the specified row and column and returns the last row and
@@ -1079,7 +1107,7 @@ <h2 class="title">V</h2>
 </dd>
 <dt><span class="memberNameLink"><a href="picocli/CommandLine.html#VERSION">VERSION</a></span> - Static variable in class picocli.<a href="picocli/CommandLine.html" title="class in picocli">CommandLine</a></dt>
 <dd>
-<div class="block">This is picocli version "0.9.8".</div>
+<div class="block">This is picocli version "1.0.0".</div>
 </dd>
 </dl>
 <a name="I:W">

diff --git a/docs/apidocs/index.html b/docs/apidocs/index.html
@@ -2,8 +2,8 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_131) on Mon Aug 07 01:36:02 JST 2017 -->
-<title>picocli 0.9.8 API</title>
+<!-- Generated by javadoc (1.8.0_131) on Sat Aug 26 23:55:00 JST 2017 -->
+<title>picocli 1.0.0 API</title>
 <script type="text/javascript">
     tmpTargetPage = "" + window.location.search;
     if (tmpTargetPage != "" && tmpTargetPage != "undefined")