Archives/bonzai
2
0
Fork 0
mirror of https://github.com/rwxrob/bonzai synced 2024-11-12 07:10:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add breaking change error design description

Browse Source
This commit is contained in:
rwxrob 2022-04-14 08:06:48 -04:00
parent 1abb85778c
commit 6c6bb2d6e3
No known key found for this signature in database
GPG Key ID: 2B9111F33082AE77
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -423,6 +423,25 @@ want the specific reasons.
BonzaiShell to Bonzai Cmd code generator with very little effort at
that point.
* **Custom errors as package globals**
When it became clear that there are a number of canned error
conditions that we want to allow Cmd developers to use quickly and
easily, and that not all of them directly relate to a particular Cmd
(`x`) is was decided to move all errors into a central `errors.go`
file as package global custom error structures that implement `error`
interface (`Error() string`) and have concrete, public fields so that
composition notation can be used (instead of forcing an unnecessary
function call). The benefits of custom errors that can be interrogated
with the `errors` functions are obvious and this also consolidates
most English language usage for later when we add full
language-by-locale support.
Note that this was a breaking change (added in `v0.10.0`) with
high-impact because so many have hard-coded `x.UsageError` (which is
why the full `v1.0` is not expected until December 25th 2022, some
months after things should feel settled and finished).
## Style Guidelines
* Use "deciduous tree" emoji 🌳 to mark Bonzai stuff