Merge branch 'master' into master

remkop · Aug 18, 2018 · 00ca338 · 00ca338
2 parents 6d05821 + 19a3524
commit 00ca338
Show file tree

Hide file tree

Showing 123 changed files with 19,558 additions and 14,339 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,36 @@
+# Handle line endings automatically for files detected as text
+# and leave all files detected as binary untouched.
+* text=auto
+
+#
+# The above will handle all files NOT found below
+#
+# These files are text and should be normalized (Convert crlf => lf)
+*.adoc          text
+*.css           text
+*.gradle        text
+*.groovy        text
+*.html          text
+*.java          text
+*.js            text
+*.md            text
+*.properties    text
+*.txt           text
+*.yml           text
+
+# These files are text and must be normalized to lf
+gradlew         text eol=lf
+*.sh            text eol=lf
+*.bash          text eol=lf
+
+# These files are text and must be normalized to crlf
+*.bat           text eol=crlf
+
+# These files are binary and should be left untouched
+# (binary is a macro for -text -diff)
+*.gif           binary
+*.ico           binary
+*.jar           binary
+*.jpg           binary
+*.jpeg          binary
+*.png           binary
diff --git a/.travis.yml b/.travis.yml
@@ -1,5 +1,8 @@
+env:
+  global:
+  # for CodeClimate
+    - CC_TEST_REPORTER_ID=83a2e05f875e3a67f60a1969f20a558a3de03a7592052c8bf52807d0e317f01a
 language: java
-
 jdk:
   - oraclejdk8
 #  - openjdk7 # Disabled to avoid error java.security.NoSuchProviderException: no such provider: SunEC...
@@ -14,8 +17,13 @@ jdk:
 
 before_script:
   - chmod +x gradlew
+# for CodeClimate
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
 script:
   - ./gradlew check --info
   - ./gradlew jacocoTestReport
 after_success:
   - bash <(curl -s https://codecov.io/bash)
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
diff --git a/README.md b/README.md
@@ -14,63 +14,78 @@ In a single file, so you can include it _in source form_.
 This lets users run picocli-based applications without requiring picocli as an external dependency.
 
 How it works: annotate your class and picocli initializes it from the command line arguments,
-converting the input to strongly typed data. Supports git-like [subcommands](http://picocli.info/#_subcommands)
-(and nested [sub-subcommands](http://picocli.info/#_nested_sub_subcommands)),
-any option prefix style, POSIX-style [grouped short options](http://picocli.info/#_short_options),
-custom [type converters](http://picocli.info/#_custom_type_converters) and more.
-Parser [tracing](http://picocli.info/#_tracing) facilitates troubleshooting.
-
-Distinguishes between [named options](http://picocli.info/#_options) and
-[positional parameters](http://picocli.info/#_positional_parameters) and allows _both_ to be 
-[strongly typed](http://picocli.info/#_strongly_typed_everything).
-[Multi-valued fields](http://picocli.info/#_multiple_values) can specify 
-an exact number of parameters or a [range](http://picocli.info/#_arity) (e.g., `0..*`, `1..2`).
-Supports [Map options](http://picocli.info/#_maps) like `-Dkey1=val1 -Dkey2=val2`, where both key and value can be strongly typed.
-
-Generates polished and easily tailored [usage help](http://picocli.info/#_usage_help)
-and  [version help](http://picocli.info/#_version_help),
-using [ANSI colors](http://picocli.info/#_ansi_colors_and_styles) where possible.
+converting the input to strongly typed data. Supports git-like [subcommands](https://picocli.info/#_subcommands)
+(and nested [sub-subcommands](https://picocli.info/#_nested_sub_subcommands)),
+any option prefix style, POSIX-style [grouped short options](https://picocli.info/#_short_options),
+custom [type converters](https://picocli.info/#_custom_type_converters),
+[password options](http://picocli.info/#_interactive_password_options) and more.
+Parser [tracing](https://picocli.info/#_tracing) facilitates troubleshooting.
+
+Distinguishes between [named options](https://picocli.info/#_options) and
+[positional parameters](https://picocli.info/#_positional_parameters) and allows _both_ to be 
+[strongly typed](https://picocli.info/#_strongly_typed_everything).
+[Multi-valued fields](https://picocli.info/#_multiple_values) can specify 
+an exact number of parameters or a [range](https://picocli.info/#_arity) (e.g., `0..*`, `1..2`).
+Supports [Map options](https://picocli.info/#_maps) like `-Dkey1=val1 -Dkey2=val2`, where both key and value can be strongly typed.
+
+Generates polished and easily tailored [usage help](https://picocli.info/#_usage_help)
+and  [version help](https://picocli.info/#_version_help),
+using [ANSI colors](https://picocli.info/#_ansi_colors_and_styles) where possible.
 Works with Java 5 or higher (but is designed to facilitate the use of Java 8 lambdas).
 
-Picocli-based command line applications can have [TAB autocompletion](http://picocli.info/autocomplete.html),
+Picocli-based command line applications can have [TAB autocompletion](https://picocli.info/autocomplete.html),
 interactively showing users what options and subcommands are available.
-When an option has [`completionCandidates`](http://picocli.info/#__code_completion_candidates_code_variable) or has an `enum` type, autocompletion can also suggest option values.
+When an option has [`completionCandidates`](https://picocli.info/#__code_completion_candidates_code_variable) or has an `enum` type, autocompletion can also suggest option values.
 Picocli can generate completion scripts for bash and zsh, and offers an API to easily create a [JLine](https://github.com/jline/jline2) `Completer` for your application.
 
-Picocli-based applications can easily [integrate](http://picocli.info/#_dependency_injection) with Dependency Injection containers.
+Picocli-based applications can easily [integrate](https://picocli.info/#_dependency_injection) with Dependency Injection containers.
 
 <a id="picocli_demo"></a>
 ![Picocli Demo help message with ANSI colors](docs/images/picocli.Demo.png?raw=true)
 
-#### Releases
-* [Releases](https://github.com/remkop/picocli/releases) - latest: 3.3.0
+### Releases
+* [Releases](https://github.com/remkop/picocli/releases) - latest: 3.5.2
 * [Picocli 3.0.0 Release Notes](https://github.com/remkop/picocli/releases/tag/v3.0.0) - note there are some [potential breaking changes](https://github.com/remkop/picocli/releases/tag/v3.0.0#3.0.0-breaking-changes) from prior versions
 * [Picocli 2.0 Release Notes](https://github.com/remkop/picocli/releases/tag/v2.0.0) - note there are some [potential breaking changes](https://github.com/remkop/picocli/releases/tag/v2.0.0#2.0-breaking-changes) from prior versions
 
-#### Documentation
-* [3.x User manual: http://picocli.info](http://picocli.info)
-* [2.x User manual](http://picocli.info/man/2.x)
-* [Command line autocompletion](http://picocli.info/autocomplete.html)
-* [API Javadoc](http://picocli.info/apidocs/)
-* [3.0 Programmatic API](http://picocli.info/picocli-3.0-programmatic-api.html)
+### Documentation
+* [3.x User manual: https://picocli.info](https://picocli.info)
+* [3.x Quick Guide](https://picocli.info/quick-guide.html)
+* [2.x User manual](https://picocli.info/man/2.x)
+* [Command line autocompletion](https://picocli.info/autocomplete.html)
+* [API Javadoc](https://picocli.info/apidocs/)
+* [3.0 Programmatic API](https://picocli.info/picocli-3.0-programmatic-api.html)
 * [FAQ](https://github.com/remkop/picocli/wiki/FAQ)
 
-#### Articles
-* Picocli is now part of Groovy. <img src="http://picocli.info/images/groovy-logo.png" height="50"> From Groovy 2.5, picocli is the underlying parser for Groovy's [CliBuilder DSL](http://groovy-lang.org/dsls.html#_clibuilder). Details: [Part 1](http://picocli.info/groovy-2.5-clibuilder-renewal-part1.html) (also on: [DZone](https://dzone.com/articles/groovy-25-clibuilder-renewal), [Java Code Geeks](https://www.javacodegeeks.com/2018/06/groovy-clibuilder-renewal-part-1.html)), [Part 2](http://picocli.info/groovy-2.5-clibuilder-renewal-part2.html) (also on: [DZone](https://dzone.com/articles/groovy-25-clibuilder-renewal-part-2), [Java Code Geeks](https://www.javacodegeeks.com/2018/06/groovy-clibuilder-renewal-part-2.html)), [all in one](http://picocli.info/groovy-2.5-clibuilder-renewal.html) (also on [blogs.apache.org](https://blogs.apache.org/logging/entry/groovy-2-5-clibuilder-renewal)). 
+### Articles
+* [Groovy 2.5 CliBuilder Renewal](https://picocli.info/groovy-2.5-clibuilder-renewal.html) (also on [blogs.apache.org](https://blogs.apache.org/logging/entry/groovy-2-5-clibuilder-renewal)). In two parts: [Part 1](https://picocli.info/groovy-2.5-clibuilder-renewal-part1.html) (also on: [DZone](https://dzone.com/articles/groovy-25-clibuilder-renewal), [Java Code Geeks](https://www.javacodegeeks.com/2018/06/groovy-clibuilder-renewal-part-1.html)), [Part 2](https://picocli.info/groovy-2.5-clibuilder-renewal-part2.html) (also on: [DZone](https://dzone.com/articles/groovy-25-clibuilder-renewal-part-2), [Java Code Geeks](https://www.javacodegeeks.com/2018/06/groovy-clibuilder-renewal-part-2.html)). 
+* Micronaut user manual for running microservices [standalone with picocli](https://docs.micronaut.io/snapshot/guide/index.html#commandLineApps).
 * [Java Command-Line Interfaces (Part 30): Observations](http://marxsoftware.blogspot.jp/2017/11/java-cmd-line-observations.html) by Dustin Marx about picocli 2.0.1 (also on: [DZone](https://dzone.com/articles/java-command-line-interfaces-part-30-finale-observations), [Java Code Geeks](https://www.javacodegeeks.com/2017/11/java-command-line-interfaces-part-30-observations.html))
 * [Java Command-Line Interfaces (Part 10): Picocli](http://marxsoftware.blogspot.jp/2017/08/picocli.html) by Dustin Marx about picocli 0.9.7 (also on: [DZone](https://dzone.com/articles/java-command-line-interfaces-part-10-picocli), [Java Code Geeks](https://www.javacodegeeks.com/2017/08/java-command-line-interfaces-part-10-picocli.html)) 
-* [Picocli 2.0: Groovy Scripts on Steroids](http://picocli.info/picocli-2.0-groovy-scripts-on-steroids.html) (also on: [DZone](https://dzone.com/articles/picocli-v2-groovy-scripts-on-steroids), [Java Code Geeks](https://www.javacodegeeks.com/2018/01/picocli-2-0-groovy-scripts-steroids.html))
-* [Picocli 2.0: Do More With Less](http://picocli.info/picocli-2.0-do-more-with-less.html) (also on: [DZone](https://dzone.com/articles/whats-new-in-picocli-20), [Java Code Geeks](https://www.javacodegeeks.com/2018/01/picocli-2-0-less.html))
-* [Announcing picocli 1.0](http://picocli.info/announcing-picocli-1.0.html) (also on: [DZone](https://dzone.com/articles/announcing-picocli-10))
+* [Picocli 2.0: Groovy Scripts on Steroids](https://picocli.info/picocli-2.0-groovy-scripts-on-steroids.html) (also on: [DZone](https://dzone.com/articles/picocli-v2-groovy-scripts-on-steroids), [Java Code Geeks](https://www.javacodegeeks.com/2018/01/picocli-2-0-groovy-scripts-steroids.html))
+* [Picocli 2.0: Do More With Less](https://picocli.info/picocli-2.0-do-more-with-less.html) (also on: [DZone](https://dzone.com/articles/whats-new-in-picocli-20), [Java Code Geeks](https://www.javacodegeeks.com/2018/01/picocli-2-0-less.html))
+* [Announcing picocli 1.0](https://picocli.info/announcing-picocli-1.0.html) (also on: [DZone](https://dzone.com/articles/announcing-picocli-10))
 
-#### Related
+### Related
 * Check out Thibaud Lepretre's [picocli Spring boot starter](https://github.com/kakawait/picocli-spring-boot-starter)!
 
-#### Credit
-<img src="http://picocli.info/images/logo/icon.png" height="50"> 
+### Credit
+<img src="https://picocli.info/images/logo/horizontal-400x150.png" height="100"> 
 
 [Reallinfo](https://github.com/reallinfo) designed the new picocli logo! Many thanks! 
 
+## Adoption
+
+<img src="https://picocli.info/images/groovy-logo.png" height="50">  <img src="http://micronaut.io/images/micronaut_mini_copy_tm.svg" height="50">  <img src="http://picocli.info/images/junit5logo-172x50.png" height="50">
+
+* Picocli is now part of Groovy. From Groovy 2.5, all Groovy command line tools are picocli-based, and picocli is the underlying parser for Groovy's [CliBuilder DSL](http://groovy-lang.org/dsls.html#_clibuilder). 
+*  Picocli is now part of Micronaut. The Micronaut CLI has been rewritten with picocli, and Micronaut has dedicated support for running microservices [standalone with picocli](https://docs.micronaut.io/snapshot/guide/index.html#commandLineApps).
+*  Picocli is now part of JUnit 5. JUnit 5.3 migrated its `ConsoleLauncher` from jopt-simple to picocli to support @-files (argument files); this helps users who need to specify many tests on the command line and run into system limitations.
+
+<img src="https://picocli.info/images/downloads-201807.png">
+
+Glad to see more people are using picocli. We must be doing something right. :-) 
+
 
 ## Example
 
@@ -138,7 +153,7 @@ See the [source code](https://github.com/remkop/picocli/blob/v0.9.4/src/test/jav
 
 Picocli annotations offer many ways to customize the usage help message.
 
-If annotations are not sufficient, you can use picocli's [Help API](http://picocli.info/#_usage_help_api) to customize even further.
+If annotations are not sufficient, you can use picocli's [Help API](https://picocli.info/#_usage_help_api) to customize even further.
 For example, your application can generate help like this with a custom layout:
 
 ![Usage help message with two options per row](docs/images/UsageHelpWithCustomLayout.png?raw=true)
@@ -151,35 +166,35 @@ See the [source code](https://github.com/remkop/picocli/blob/master/src/main/jav
 
 ### Gradle
 ```
-compile 'info.picocli:picocli:3.3.0'
+compile 'info.picocli:picocli:3.5.2'
 ```
 ### Maven
 ```
 <dependency>
   <groupId>info.picocli</groupId>
   <artifactId>picocli</artifactId>
-  <version>3.3.0</version>
+  <version>3.5.2</version>
 </dependency>
 ```
 ### Scala SBT
 ```
-libraryDependencies += "info.picocli" % "picocli" % "3.3.0"
+libraryDependencies += "info.picocli" % "picocli" % "3.5.2"
 ```
 ### Ivy
 ```
-<dependency org="info.picocli" name="picocli" rev="3.3.0" />
+<dependency org="info.picocli" name="picocli" rev="3.5.2" />
 ```
 ### Grape
 ```groovy
 @Grapes(
-    @Grab(group='info.picocli', module='picocli', version='3.3.0')
+    @Grab(group='info.picocli', module='picocli', version='3.5.2')
 )
 ```
 ### Leiningen
 ```
-[info.picocli/picocli "3.3.0"]
+[info.picocli/picocli "3.5.2"]
 ```
 ### Buildr
 ```
-'info.picocli:picocli:jar:3.3.0'
+'info.picocli:picocli:jar:3.5.2'
 ```