jpdsousa / extendedcli Goto Github PK

Description 🔍

ExtendedCLI uses CLIBuilder to register commands, making the ExtendedCLI object immutable when it comes to adding new commands. By creating a new CommandProvider object, users will be allowed to register such providers, which may have options to add commands even after building the ExtendedCLI object.

Hacktoberfester?

Hey Hacktoberfester, if you came across this issue and you would like to contribute to a new project, this might just be the project for you!

If you're not so much into CLIs and/or might want to contribute to other more complex projects, check out other projects of mine: search my other Hacktoberfest issues

Description 🔍

Test coverage is really useful in any kind of software project. ExtendedCLI greatly appreciates test coverage contributions.

How to? 😧

⚠️ Do not panic! Test coverage is not rocket science! ⚠️
ExtendedCLI uses Maven to run tests. So, in order to run existing tests and create your own:

• Clone the repository;
• Be sure to have maven installed in your machine (check the Maven homepage on how to download and install maven);
• hit mvn clean verify in the projects root folder (i.e. ExtendedCLI) by default, and wait for the green text stating that everything went fine;
• Now you're good to go. Add tests to the test source folder src/test/java and increase the test coverage!
  • Remember to create test classes that end with Test, such as ExampleTest.java, as Maven Surefire plugin will only run classes with that pattern;
  • Focus on code that is not tested yet. You can resort to the codecov reports, or even to the reports generated by Maven Jacoco Plugin, stored in {project.root}/target/site/jacoco (open the index.html for a sort-of-pretty report).

Questions?

ExtendedCLI is in active development, and has not been properly tested, which may lead to some occasional bugs or questions. Feel free to create an issue if you stumble upon any bug or comment bellow if you have any douts.

Provide an option to customize the matching of values with case sensitivity/insensitivety.