Mojang/brigadier
Brigadier
Brigadier is a command-line parser and dispatcher that maps text-based inputs to executable functions using a hierarchical tree of arguments. It provides a system for defining nested command structures and typed arguments to route user input to specific handlers.
The library includes a command syntax generator that automatically produces human-readable usage strings and documentation based on defined command nodes. It transforms raw strings into structured data to identify valid command sequences and pinpoint syntax errors.
The framework covers command tree routing, input syntax validation, and dynamic dispatching using context objects to execute actions based on the user's state.
Features
- Command Tree Definitions - A system for building hierarchical structures of strings and arguments to map user input to specific executable functions.
- Command Line Parsers - Provides a mechanism to transform raw text inputs into structured command sequences and executable function calls.
- Hierarchical Command Dispatch - Provides a library for mapping text-based command inputs to executable functions using a hierarchical tree of arguments.
- Command Line Parsing - Converts raw text input into structured data based on predefined rules to determine the appropriate action.
- CLI Command Dispatchers - Provides a mechanism for routing parsed command inputs to corresponding handler functions for execution.
- Argument Parsing - Provides logic for processing and validating command-line arguments and flags to configure tool behavior.
- Nested Command Structures - Maps hierarchical command structures to executable functions to handle complex nested subcommands and arguments.
- Command Line Argument Parsing - Transforms raw text into structured results by matching input against a command tree and extracting typed arguments.
- Command Grammar Traversers - Walks through nested command children to determine if an input string matches the defined command grammar.
- Command Routing Architectures - Implements a routing architecture that maps raw input strings against a hierarchical node structure to find terminal handlers.
- Command Line Documentation - Automatically generates human-readable syntax guides and usage strings from a structured command tree.
- Contextual Execution State - Implements a system to pass source objects through the execution chain to provide handlers with environmental state.
- Documentation Generators - Automatically generates human-readable strings describing valid syntax and available subcommands for specific nodes.
- Keyword-Based Command Dispatchers - Routes parsed input to logic handlers using context objects to execute actions based on the user's state.
- Parse Result Objects - Stores the outcome of parse operations in objects that track matched nodes and pinpoint syntax errors.
- Usage Documentation Generators - Automatically produces human-readable usage strings and documentation based on defined command nodes.
- Usage String Generators - Automatically constructs human-readable syntax strings and documentation based on the defined command node hierarchy.
- CLI Syntax Consistency Validation - Checks user input against a command schema to identify structural inconsistencies and provide usage hints.
