golem15/summercms
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(19.8): close the duplicate command names todo

Browse Source
This commit is contained in:
Jakub Zych
2026-10-21 12:13:29 +02:00
parent 8d4d7ce7a7
commit 80fae5c279
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.planning/todos/pending/bonfire-duplicate-command-names.md → .planning/todos/done/bonfire-duplicate-command-names.md
View File

@@ -11,3 +11,5 @@ g15office: u4rtpcl1
Found while writing `docs/console/writing-commands.md` (Phase 11.1 plan 03). The page describes the current behaviour: names are not checked for duplicates, so keep commands in the plugin's own namespace.
Suggested fix: make `bonfire.NewRoot` fail with an error naming the duplicated command when two commands share a name. `bonfire.NewCatalog`, which the scheduler calls through, has no error return, but the generated `main` calls `bonfire.NewRoot` before it runs any command, so that check stops the binary before a duplicate can run. Update the bonfire README and the docs page in the same change (the D-13 docs rule). The API change is outside the docs phase boundary, so it is not made in Phase 11.1.
Done in Phase 19.8 plan 02, commit 8d4d7ce: `bonfire.NewRoot` fails with `bonfire.ErrDuplicateCommand` naming the command (also for commands named `list` or `help`), and with `bonfire.ErrReservedFlag` for flags that reuse a global option; the bonfire README and `docs/console/writing-commands.md` describe it.