Skip to content

Commit

Permalink
Simplify commands descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
charphi committed Aug 28, 2024
1 parent ae53fcc commit b00bda1
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 18 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ It requires a Java SE Runtime Environment (JRE) version 8 or later to run on suc

It provides the following commands:

| Name | Description |
|-----------|---------------------------------|
| `scan` | Summarize changelog content |
| `check` | Check changelog format |
| `extract` | Extract versions from changelog |
| `list` | List available resources |
| Name | Description |
|-----------|-------------------|
| `check` | Check format |
| `scan` | Summarize content |
| `extract` | Extract versions |
| `list` | List resources |

It follows the Unix philosophy of [“Do one thing and do it well“](https://en.wikipedia.org/wiki/Unix_philosophy#Do_One_Thing_and_Do_It_Well) by performing a single function and beeing composable.

Expand Down Expand Up @@ -141,12 +141,12 @@ To use the CLI without installing it:

It provides the following goals:

| Name | Description |
|-----------|---------------------------------|
| `scan` | Summarize changelog content |
| `check` | Check changelog format |
| `extract` | Extract versions from changelog |
| `list` | List available resources |
| Name | Description |
|-----------|-------------------|
| `check` | Check format |
| `scan` | Summarize content |
| `extract` | Extract versions |
| `list` | List resources |

### Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import static internal.heylogs.cli.MarkdownInputSupport.newMarkdownInputSupport;
import static nbbrd.console.picocli.text.TextOutputSupport.newTextOutputSupport;

@Command(name = "check", description = "Check changelog format.")
@Command(name = "check", description = "Check format.")
public final class CheckCommand implements Callable<Integer> {

@CommandLine.Mixin
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
import static internal.heylogs.cli.MarkdownInputSupport.newMarkdownInputSupport;
import static internal.heylogs.cli.MarkdownOutputSupport.newMarkdownOutputSupport;

@Command(name = "extract", description = "Extract versions from changelog.")
@Command(name = "extract", description = "Extract versions.")
public final class ExtractCommand implements Callable<Void> {

@CommandLine.Mixin
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

import static nbbrd.console.picocli.text.TextOutputSupport.newTextOutputSupport;

@Command(name = "list", description = "List available resources.")
@Command(name = "list", description = "List resources.")
public final class ListCommand implements Callable<Void> {

@CommandLine.Mixin
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
commandListHeading = "%nCommands:%n",
headerHeading = "%n",
subcommands = {
ScanCommand.class,
CheckCommand.class,
ScanCommand.class,
ExtractCommand.class,
ReleaseCommand.class,
ListCommand.class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import static internal.heylogs.cli.MarkdownInputSupport.newMarkdownInputSupport;
import static internal.heylogs.cli.MarkdownOutputSupport.newMarkdownOutputSupport;

@Command(name = "release", description = "Release unreleased changes in changelog.")
@Command(name = "release", description = "Release changes.")
public final class ReleaseCommand implements Callable<Void> {

@CommandLine.Mixin
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import static internal.heylogs.cli.MarkdownInputSupport.newMarkdownInputSupport;
import static nbbrd.console.picocli.text.TextOutputSupport.newTextOutputSupport;

@Command(name = "scan", description = "Summarize changelog content.")
@Command(name = "scan", description = "Summarize content.")
public final class ScanCommand implements Callable<Void> {

@CommandLine.Mixin
Expand Down

0 comments on commit b00bda1

Please sign in to comment.