diff --git a/README.md b/README.md index 932b26e..99523fb 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 diff --git a/heylogs-cli/src/main/java/nbbrd/heylogs/cli/CheckCommand.java b/heylogs-cli/src/main/java/nbbrd/heylogs/cli/CheckCommand.java index a0146ce..918c0b4 100644 --- a/heylogs-cli/src/main/java/nbbrd/heylogs/cli/CheckCommand.java +++ b/heylogs-cli/src/main/java/nbbrd/heylogs/cli/CheckCommand.java @@ -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 { @CommandLine.Mixin diff --git a/heylogs-cli/src/main/java/nbbrd/heylogs/cli/ExtractCommand.java b/heylogs-cli/src/main/java/nbbrd/heylogs/cli/ExtractCommand.java index 37939ad..5fce4ac 100644 --- a/heylogs-cli/src/main/java/nbbrd/heylogs/cli/ExtractCommand.java +++ b/heylogs-cli/src/main/java/nbbrd/heylogs/cli/ExtractCommand.java @@ -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 { @CommandLine.Mixin diff --git a/heylogs-cli/src/main/java/nbbrd/heylogs/cli/ListCommand.java b/heylogs-cli/src/main/java/nbbrd/heylogs/cli/ListCommand.java index efa94c8..2729762 100644 --- a/heylogs-cli/src/main/java/nbbrd/heylogs/cli/ListCommand.java +++ b/heylogs-cli/src/main/java/nbbrd/heylogs/cli/ListCommand.java @@ -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 { @CommandLine.Mixin diff --git a/heylogs-cli/src/main/java/nbbrd/heylogs/cli/MainCommand.java b/heylogs-cli/src/main/java/nbbrd/heylogs/cli/MainCommand.java index ad299f7..69aaa3f 100644 --- a/heylogs-cli/src/main/java/nbbrd/heylogs/cli/MainCommand.java +++ b/heylogs-cli/src/main/java/nbbrd/heylogs/cli/MainCommand.java @@ -24,8 +24,8 @@ commandListHeading = "%nCommands:%n", headerHeading = "%n", subcommands = { - ScanCommand.class, CheckCommand.class, + ScanCommand.class, ExtractCommand.class, ReleaseCommand.class, ListCommand.class diff --git a/heylogs-cli/src/main/java/nbbrd/heylogs/cli/ReleaseCommand.java b/heylogs-cli/src/main/java/nbbrd/heylogs/cli/ReleaseCommand.java index 04823e3..f0f591d 100644 --- a/heylogs-cli/src/main/java/nbbrd/heylogs/cli/ReleaseCommand.java +++ b/heylogs-cli/src/main/java/nbbrd/heylogs/cli/ReleaseCommand.java @@ -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 { @CommandLine.Mixin diff --git a/heylogs-cli/src/main/java/nbbrd/heylogs/cli/ScanCommand.java b/heylogs-cli/src/main/java/nbbrd/heylogs/cli/ScanCommand.java index 453e2d2..45cf47b 100644 --- a/heylogs-cli/src/main/java/nbbrd/heylogs/cli/ScanCommand.java +++ b/heylogs-cli/src/main/java/nbbrd/heylogs/cli/ScanCommand.java @@ -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 { @CommandLine.Mixin