Brigadier-ts

TypeScript port of Mojang/brigadier

Installation

npm install brigadier-ts

Usage

Example using a command source

import {
    CommandDispatcher,
    IntegerArgumentType,
    literal,
    argument
} from "brigadier-ts";

class CommandSource {
    private a: number;
    constructor(a: number) {
        this.a = a;
    }
    getA(): number {
        return this.a;
    }
}

const dispatcher = new CommandDispatcher<CommandSource>();
dispatcher.register(literal("random")
    .executes(c => 4)
);
dispatcher.register(literal("double")
    .then(argument("value", new IntegerArgumentType())
        .executes(c => 2 * c.get("value"))
    )
);
dispatcher.register(literal("add")
    .executes(c => 4 + c.getSource().getA())
);

console.log(dispatcher.execute("random", null)); // 4
console.log(dispatcher.execute("double 3", null)); // 6
console.log(dispatcher.execute("add", new CommandSource(3))); // 7

Example using redirection and forking

import {
    CommandDispatcher,
    IntegerArgumentType,
    literal,
    argument
} from "brigadier-ts";

const dispatcher = new CommandDispatcher<number>();
const execute = dispatcher.register(literal("execute"));

dispatcher.register(literal("execute")
    .then(literal("run")
        .redirect(dispatcher.getRoot())
    )
    .then(literal("enumerate")
        .then(argument("nums", new IntegerArgumentType())
            .fork(execute, c => {
                let list: number[] = [];
                for (let i = c.get("nums"); i > 0; i--) {
                    list.push(i);
                }
                return list;
            })
        )
    )
);

dispatcher.register(literal("say")
    .executes(c => {
        console.log(c.getSource());
    })
)

console.log(dispatcher.execute("execute enumerate 5 run say", 0));

Example using suggestions and errors

import {
    CommandDispatcher,
    IntegerArgumentType,
    literal,
    argument
} from "brigadier-ts";

const dispatcher = new CommandDispatcher<number>();
dispatcher.register(literal("double")
    .then(argument("value", new IntegerArgumentType())
        .executes(c => 2 * c.get("value"))
    )
);

const getFeedback = async (command: string): Promise<string> => {
    const parseResults = dispatcher.parse(command, null);
    if (parseResults.getErrors().size > 0) {
        return command + " >> " + parseResults.getErrors().values().next().value.message;
    }
    const suggestions = await dispatcher.getCompletionSuggestions(parseResults);
    if (suggestions.getList().length > 0) {
        const s = suggestions.getList()[0];
        return command + " >> S " + s.getText() + " (" + s.getRange().getStart() + ", " + s.getRange().getEnd() + ")";
    }
    const usage = dispatcher.getAllUsage(parseResults.getContext().getRootNode(), null, false);
    if (usage.length > 0) {
        return command + " >> U " + usage[0];
    }
    return command;
}

getFeedback("dou").then(f => console.log(f)); // dou >> S double
getFeedback("double").then(f => console.log(f)); // double >> U double <value>
getFeedback("double ").then(f => console.log(f)); // double  >> Expected integer at position 7: double <--[HERE]