Skip to content

Commit

Permalink
Small followup for Picocli + Gradle improvement
Browse files Browse the repository at this point in the history 
Follow up on #43407
  • Loading branch information
@gsmet
gsmet committed Sep 24, 2024
1 parent ec83c29 commit 242bba8
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/src/main/asciidoc/picocli.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,9 @@ annotationProcessor 'info.picocli:picocli-codegen'

== Development Mode

In the development mode, i.e. when running `mvn quarkus:dev`, the application is executed and restarted every time the `Space bar` key is pressed. You can also pass arguments to your command line app via the `quarkus.args` system property, e.g. `mvn quarkus:dev -Dquarkus.args='--help'` and `mvn quarkus:dev -Dquarkus.args='-c -w --val 1'`. For gradle project arguments can be passed using `--quarkus-args`.
In the development mode, i.e. when running `mvn quarkus:dev`, the application is executed and restarted every time the `Space bar` key is pressed. You can also pass arguments to your command line app via the `quarkus.args` system property, e.g. `mvn quarkus:dev -Dquarkus.args='--help'` and `mvn quarkus:dev -Dquarkus.args='-c -w --val 1'`.

Check warning on line 300 in docs/src/main/asciidoc/picocli.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.SentenceLength] Try to keep sentences to an average of 32 words or fewer.

Raw Output:
{"message": "[Quarkus.SentenceLength] Try to keep sentences to an average of 32 words or fewer.", "location": {"path": "docs/src/main/asciidoc/picocli.adoc", "range": {"start": {"line": 300, "column": 1}}}, "severity": "INFO"}

Check failure on line 300 in docs/src/main/asciidoc/picocli.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsErrors] Use 'you' rather than 'i'.

Raw Output:
{"message": "[Quarkus.TermsErrors] Use 'you' rather than 'i'.", "location": {"path": "docs/src/main/asciidoc/picocli.adoc", "range": {"start": {"line": 300, "column": 8}}}, "severity": "ERROR"}

Check warning on line 300 in docs/src/main/asciidoc/picocli.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'that is' rather than 'i.e.' unless updating existing content that uses the term.

Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'that is' rather than 'i.e.' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/picocli.adoc", "range": {"start": {"line": 300, "column": 8}}}, "severity": "WARNING"}

Check warning on line 300 in docs/src/main/asciidoc/picocli.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'through', 'by', 'from', 'on', or 'by using' rather than 'via' unless updating existing content that uses the term.

Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'through', 'by', 'from', 'on', or 'by using' rather than 'via' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/picocli.adoc", "range": {"start": {"line": 300, "column": 183}}}, "severity": "WARNING"}
For Gradle projects, arguments can be passed using `--quarkus-args`.

[NOTE]
====
If you're creating a typical Quarkus application (e.g., HTTP-based services) that includes command-line functionality, you'll need to handle the application's lifecycle differently. In the `Runnable.run()` method of your command, make sure to use `Quarkus.waitForExit()` or `Quarkus.asyncExit()`. This will prevent the application from shutting down prematurely and ensure a proper shutdown process.

Check warning on line 305 in docs/src/main/asciidoc/picocli.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'.

Raw Output:
{"message": "[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'.", "location": {"path": "docs/src/main/asciidoc/picocli.adoc", "range": {"start": {"line": 305, "column": 127}}}, "severity": "INFO"}

Check warning on line 305 in docs/src/main/asciidoc/picocli.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'verify' rather than 'make sure' unless updating existing content that uses the term.

Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'verify' rather than 'make sure' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/picocli.adoc", "range": {"start": {"line": 305, "column": 213}}}, "severity": "WARNING"}
Expand Down

0 comments on commit 242bba8

Please sign in to comment.