Skip to content

Commit 06248c9

Browse files
wheslleyrimarMatheusKSantiagofelipemelozxBrijeshthummar02lleamancio
authored
Develop to Main (BuildCLI#151)
* fixes check updates * Add descriptions for 'project', 'init', 'update', 'build', 'run', 'test', 'set', 'remove', 'cleanup', and 'document-code' commands * feat(project-init): Add description for init command in CLI help * feat(docs): Add description for document-code command * feat: adding description to add command * feat: adjust code style * Add aliase for descriptions for 'project', 'init', 'update', 'build', 'test', 'remove', 'cleanup', and 'document-code' commands * Add aliase for descriptions for 'build' command * feat: adding description to subcommands --------- Co-authored-by: Matheus Kennedy <[email protected]> Co-authored-by: Felipe Melo <[email protected]> Co-authored-by: Brijeshthummar02 <[email protected]> Co-authored-by: lleamancio <[email protected]> Co-authored-by: Matheus Oliveira da Silva <[email protected]> Co-authored-by: Felipe Melo <[email protected]>
1 parent 8f45ed3 commit 06248c9

15 files changed

+23
-14
lines changed

src/main/java/org/buildcli/commands/ProjectCommand.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import org.buildcli.commands.project.*;
44
import picocli.CommandLine.Command;
55

6-
@Command(name = "project", aliases = {"p"}, description = "",
6+
@Command(name = "project", aliases = {"p"}, description = "Manage and create Java projects, alias: 'p'.",
77
subcommands = {
88
AddCommand.class, RmCommand.class, BuildCommand.class, SetCommand.class,
99
TestCommand.class, RunCommand.class, InitCommand.class, CleanupCommand.class,

src/main/java/org/buildcli/commands/project/BuildCommand.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
import java.util.logging.Logger;
99

10-
@Command(name = "build", aliases = {"b"}, description = "", mixinStandardHelpOptions = true)
10+
@Command(name = "build", aliases = {"b"}, description = "Builds the project, either compiling or packaging, and logs the result, alias: 'b'.", mixinStandardHelpOptions = true)
1111
public class BuildCommand implements BuildCLICommand {
1212
private final Logger logger = Logger.getLogger(BuildCommand.class.getName());
1313

src/main/java/org/buildcli/commands/project/CleanupCommand.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
import org.buildcli.utils.DirectoryCleanup;
66
import picocli.CommandLine.Command;
77

8-
@Command(name = "cleanup", aliases = {"clean"}, description = "", mixinStandardHelpOptions = true)
8+
@Command(name = "cleanup", aliases = {"clean"}, description = "Removes generated files by cleaning the project's target directory, alias: 'clean'.", mixinStandardHelpOptions = true)
99
public class CleanupCommand implements BuildCLICommand {
1010
@Override
1111
public void run() {

src/main/java/org/buildcli/commands/project/InitCommand.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
import picocli.CommandLine.Command;
1212
import picocli.CommandLine.Option;
1313

14+
1415
@Command(
1516
name = "init",
1617
aliases = {"i"},

src/main/java/org/buildcli/commands/project/RmCommand.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import org.buildcli.commands.project.rm.ProfileCommand;
55
import picocli.CommandLine.Command;
66

7-
@Command(name = "remove", aliases = {"rm"}, description = "",
7+
@Command(name = "remove", aliases = {"rm"}, description = "Removes dependencies and profiles from the project, alias: 'rm'.",
88
subcommands = {DependencyCommand.class, ProfileCommand.class},
99
mixinStandardHelpOptions = true
1010
)

src/main/java/org/buildcli/commands/project/RunCommand.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
import java.util.logging.Level;
1717
import java.util.logging.Logger;
1818

19-
@Command(name = "run", description = "", subcommands = {DockerfileCommand.class}, mixinStandardHelpOptions = true)
19+
@Command(name = "run", description = "Executes the project with the active properties file.", subcommands = {DockerfileCommand.class}, mixinStandardHelpOptions = true)
2020
public class RunCommand implements BuildCLICommand {
2121
private final Logger logger = Logger.getLogger(RunCommand.class.getName());
2222
private final ProfileManager profileManager = new ProfileManager();

src/main/java/org/buildcli/commands/project/SetCommand.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import org.buildcli.commands.project.set.EnvironmentCommand;
44
import picocli.CommandLine.Command;
55

6-
@Command(name = "set", description = "",
6+
@Command(name = "set", description = "Sets the active environment profile.",
77
subcommands = {EnvironmentCommand.class},
88
mixinStandardHelpOptions = true
99
)

src/main/java/org/buildcli/commands/project/TestCommand.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import org.buildcli.domain.BuildCLICommand;
55
import picocli.CommandLine.Command;
66

7-
@Command(name = "test", aliases = {"t"}, description = "", mixinStandardHelpOptions = true)
7+
@Command(name = "test", aliases = {"t"}, description = "Executes the project tests, alias: 't'.", mixinStandardHelpOptions = true)
88
public class TestCommand implements BuildCLICommand {
99
@Override
1010
public void run() {

src/main/java/org/buildcli/commands/project/UpdateCommand.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import org.buildcli.commands.project.update.VersionCommand;
55
import picocli.CommandLine.Command;
66

7-
@Command(name = "update", aliases = {"up"}, description = "", mixinStandardHelpOptions = true,
7+
@Command(name = "update", aliases = {"up"}, description = "Updates project versions and dependencies, alias: 'up'.", mixinStandardHelpOptions = true,
88
subcommands = {VersionCommand.class, DependencyCommand.class}
99
)
1010
public class UpdateCommand {

src/main/java/org/buildcli/commands/project/add/DependencyCommand.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414
import java.util.logging.Logger;
1515
import java.util.stream.Stream;
1616

17-
@Command(name = "dependency", aliases = {"d"}, description = "", mixinStandardHelpOptions = true)
17+
@Command(name = "dependency", aliases = {"d"}, description = "Adds a new dependency to the project. Alias: 'd'. "
18+
+ "This command allows adding dependencies.", mixinStandardHelpOptions = true)
1819
public class DependencyCommand implements BuildCLICommand {
1920
private static final Logger logger = Logger.getLogger(DependencyCommand.class.getName());
2021
@Parameters

0 commit comments

Comments
 (0)