{"id":16157107,"url":"https://github.com/misode/brigadier-ts","last_synced_at":"2026-03-08T17:34:35.121Z","repository":{"id":41858312,"uuid":"234454631","full_name":"misode/brigadier-ts","owner":"misode","description":"TypeScript port of Mojang/brigadier","archived":false,"fork":false,"pushed_at":"2023-10-08T16:51:30.000Z","size":286,"stargazers_count":19,"open_issues_count":7,"forks_count":5,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-16T23:41:59.862Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/misode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-17T02:32:34.000Z","updated_at":"2025-03-16T07:12:27.000Z","dependencies_parsed_at":"2024-10-27T19:12:07.196Z","dependency_job_id":null,"html_url":"https://github.com/misode/brigadier-ts","commit_stats":{"total_commits":39,"total_committers":5,"mean_commits":7.8,"dds":0.4358974358974359,"last_synced_commit":"d13bf26b1b00c84d0912c36046cafe9324dfd014"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/misode%2Fbrigadier-ts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/misode%2Fbrigadier-ts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/misode%2Fbrigadier-ts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/misode%2Fbrigadier-ts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/misode","download_url":"https://codeload.github.com/misode/brigadier-ts/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243950798,"owners_count":20373664,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-10T01:48:17.966Z","updated_at":"2026-03-08T17:34:35.078Z","avatar_url":"https://github.com/misode.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Brigadier-ts\nTypeScript port of [Mojang/brigadier](https://github.com/Mojang/brigadier)\n\n## Installation\n```\nnpm install brigadier-ts\n```\n\n## Usage\n\n#### Example using a command source\n```js\nimport {\n    CommandDispatcher,\n    IntegerArgumentType,\n    literal,\n    argument\n} from \"brigadier-ts\";\n\nclass CommandSource {\n    private a: number;\n    constructor(a: number) {\n        this.a = a;\n    }\n    getA(): number {\n        return this.a;\n    }\n}\n\nconst dispatcher = new CommandDispatcher\u003cCommandSource\u003e();\ndispatcher.register(literal(\"random\")\n    .executes(c =\u003e 4)\n);\ndispatcher.register(literal(\"double\")\n    .then(argument(\"value\", new IntegerArgumentType())\n        .executes(c =\u003e 2 * c.get(\"value\"))\n    )\n);\ndispatcher.register(literal(\"add\")\n    .executes(c =\u003e 4 + c.getSource().getA())\n);\n\nconsole.log(dispatcher.execute(\"random\", null)); // 4\nconsole.log(dispatcher.execute(\"double 3\", null)); // 6\nconsole.log(dispatcher.execute(\"add\", new CommandSource(3))); // 7\n```\n\n#### Example using redirection and forking\n```ts\nimport {\n    CommandDispatcher,\n    IntegerArgumentType,\n    literal,\n    argument\n} from \"brigadier-ts\";\n\nconst dispatcher = new CommandDispatcher\u003cnumber\u003e();\nconst execute = dispatcher.register(literal(\"execute\"));\n\ndispatcher.register(literal(\"execute\")\n    .then(literal(\"run\")\n        .redirect(dispatcher.getRoot())\n    )\n    .then(literal(\"enumerate\")\n        .then(argument(\"nums\", new IntegerArgumentType())\n            .fork(execute, c =\u003e {\n                let list: number[] = [];\n                for (let i = c.get(\"nums\"); i \u003e 0; i--) {\n                    list.push(i);\n                }\n                return list;\n            })\n        )\n    )\n);\n\ndispatcher.register(literal(\"say\")\n    .executes(c =\u003e {\n        console.log(c.getSource());\n    })\n)\n\nconsole.log(dispatcher.execute(\"execute enumerate 5 run say\", 0));\n```\n\n#### Example using suggestions and errors\n```ts\nimport {\n    CommandDispatcher,\n    IntegerArgumentType,\n    literal,\n    argument\n} from \"brigadier-ts\";\n\nconst dispatcher = new CommandDispatcher\u003cnumber\u003e();\ndispatcher.register(literal(\"double\")\n    .then(argument(\"value\", new IntegerArgumentType())\n        .executes(c =\u003e 2 * c.get(\"value\"))\n    )\n);\n\nconst getFeedback = async (command: string): Promise\u003cstring\u003e =\u003e {\n    const parseResults = dispatcher.parse(command, null);\n    if (parseResults.getErrors().size \u003e 0) {\n        return command + \" \u003e\u003e \" + parseResults.getErrors().values().next().value.message;\n    }\n    const suggestions = await dispatcher.getCompletionSuggestions(parseResults);\n    if (suggestions.getList().length \u003e 0) {\n        const s = suggestions.getList()[0];\n        return command + \" \u003e\u003e S \" + s.getText() + \" (\" + s.getRange().getStart() + \", \" + s.getRange().getEnd() + \")\";\n    }\n    const usage = dispatcher.getAllUsage(parseResults.getContext().getRootNode(), null, false);\n    if (usage.length \u003e 0) {\n        return command + \" \u003e\u003e U \" + usage[0];\n    }\n    return command;\n}\n\ngetFeedback(\"dou\").then(f =\u003e console.log(f)); // dou \u003e\u003e S double\ngetFeedback(\"double\").then(f =\u003e console.log(f)); // double \u003e\u003e U double \u003cvalue\u003e\ngetFeedback(\"double \").then(f =\u003e console.log(f)); // double  \u003e\u003e Expected integer at position 7: double \u003c--[HERE]\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmisode%2Fbrigadier-ts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmisode%2Fbrigadier-ts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmisode%2Fbrigadier-ts/lists"}