adamtomi / grapefruit

:orange: Grapefruit is an annotation based command framework written in Java.

Welcome to Grapefuit town!

Hey! 👋

To find out more about Grapefruit, please check out the wiki!

⚙️Requirements

• Java 16 or higher

Thanks to @DaniFoldi for the awesome logo!

Contribution guide

Use commit names with the following prefixes to indicate their purpose

Emoji	Prefix	Description
⚡ ⚡	:zap: :zap:	for implementing breaking functionality (semver major)
⚡	:zap:	for implementing non-breaking functionality (semver minor)
🔨	:hammer:	for bug fixes and non-breaking improvements (semver patch)
🔧	:wrench:	for configurations
🚦	:vertical_traffic_light:	for tests
📝	:memo:	for documentations
🔍	:mag:	for lint fixes
♻️	:recycle:	for non-breaking refactoring
📎	:paperclip:	for dependencies
	:octocat:	for workflows
🚧	:construction:	for experimental or temporary changes

grapefruit's Issues

Number suggestions should take Range annotation into account

Enhance CommandContext & ParsedCommandArgument

Cleanup CommandDispatcherImpl

Remove optional arguments

Since grapefruit has flags, there is no need to have optional arguments as well

Add proper condition failure handling

Flag shorthand support

The flag --flag value --other could be written as -f value -o or -fo value, where values are consumed in the order the flags appear (if needed).

Cleanup redirect system

@OptParam could accept a default value

Something like: @OptParam(def = "some_default_value"), and by default def would be an empty string.

Add unit tests

Command (and parameter) description system

Add unregisterCommands(container)

Cleanup SuggestionHelper

Add character mapper

Maybe rework MethodParameterParser & rules?

Suggestions are garbage

CommandDisptacherBuilder logger uses invalid formatting

[TODO] Remove parameter indexes

Resolve codefactor issue

Multi flag support

Something like command --flag first --flag second --flag third would be parsed into a list or something. Would be neat.

Value flags with no value throw exceptions

Add customizable --help / -h / -? flags

It would retrieve information on the command (maybe load it from an external file) and would display it to the user. Could be helpful.

Right now there's no reason to use TypeToken-s. This needs to be changed.

Properly handle blank strings

Add default handlers

Add @Suggestions to provide custom suggestions for parameter

There could be multiple ways of using this annotation:

void run(@Suggestions(computed = {"a", "b", "c"} String myString))

^^^ To provide a computed list of options, or:

void run(@Suggestions(provider = MyProvider.class) String myString)

^^^ To set a provider for that particular parameter. In the latter case both the provider class or a constant ID could work.

don't accept non flag input for flag parameters

Merge CommandParameter and ParameterNode into one class

Also would be nice to add a couple of handy methods

Refactor @Regex

It could have a flags field, which could by used to pass pattern flags like this:

@Regex(value = "[0-9a-zA-Z]", flags = Pattern.UNICODE_CASE | Pattern.CASE_INSENSITIVE) String value

This would make the modifier much more flexible.