Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Error Handling Library #269

Closed
XAMPPRocky opened this issue May 20, 2021 · 2 comments · Fixed by #304
Closed

Add Error Handling Library #269

XAMPPRocky opened this issue May 20, 2021 · 2 comments · Fixed by #304
Labels
area/user-experience Pertaining to developers trying to use Quilkin, e.g. cli interface, configuration, etc kind/design Proposal discussing new features / fixes and how they should be implemented

Comments

@XAMPPRocky
Copy link
Collaborator

Currently quilkin has multiple error types, and it is quite a bit of boilerplate to add all the trait implementations for each one. I think we should decide on an error handling library to use to reduce the boilerplate to errors.

Two leading error crates.

  • eyre – fork of anyhow, typically suited for binary applications, and reporting any errors to CLI.
  • snafu Strongly typed descendant from error-chain, better suited to libraries for returning structured data for errors.

Personally I would lean towards using snafu as we have a lot of library like components with distinct error types.
@XAMPPRocky XAMPPRocky added area/user-experience Pertaining to developers trying to use Quilkin, e.g. cli interface, configuration, etc kind/design Proposal discussing new features / fixes and how they should be implemented labels May 28, 2021
@iffyio
Copy link
Collaborator

iffyio commented May 28, 2021

I think this makes sense to revisit! snafu LGTM! if we decide to. @markmandel wdyt?

@markmandel
Copy link
Member

Yeah, snafu does look good! +1 from me too!

@XAMPPRocky XAMPPRocky mentioned this issue Jun 28, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/user-experience Pertaining to developers trying to use Quilkin, e.g. cli interface, configuration, etc kind/design Proposal discussing new features / fixes and how they should be implemented
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Use thiserror for Error definitions googleforgames/quilkin
3 participants
@markmandel @XAMPPRocky @iffyio