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.

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

Consider using enhanced TOML error messages #594

Open
2 tasks
pivotaljohn opened this issue Jan 21, 2022 · 0 comments
Open
2 tasks

Consider using enhanced TOML error messages #594

pivotaljohn opened this issue Jan 21, 2022 · 0 comments
Labels
enhancement This issue is a feature request

Comments

@pivotaljohn
Copy link
Contributor

Describe the problem/challenge you have
ytt's TOML library now includes a feature to provide more verbose error messages. Let's consider taking advantage of that.

From the v1.0.0 release notes:

Decode always return a toml.ParseError, which has three methods:

  • Error() behaves as before and shows a single concise line with the error.
  • ErrorWithPosition() shows the same error, but also shows the line the error occurred at, similar to e.g. clang or the Rust compiler.
  • ErrorWithUsage() is the same as ErrorWithPosition(), but may also show a longer usage guidance message. This isn't always present (in which case it behaves identical to ErrorWithPosition()), but it should be present for most common mistakes and sources of confusion.

Describe the solution you'd like

  • Explore whether we should just adopt the more verbose error handling: how would doing so affect the formatting of our error messages?
  • If that's an improvement, consider whether we should always provide that error handling, or plumb through an (optional) keyword argument to enable that verbosity.

Anything else you would like to add:
The upgrade came about through:


Vote on this request

This is an invitation to the community to vote on issues, to help us prioritize our backlog. Use the "smiley face" up to the right of this comment to vote.

👍 "I would like to see this addressed as soon as possible"
👎 "There are other more important things to focus on right now"

We are also happy to receive and review Pull Requests if you want to help working on this issue.

@pivotaljohn pivotaljohn added enhancement This issue is a feature request carvel triage This issue has not yet been triaged for relevance and removed carvel triage This issue has not yet been triaged for relevance labels Jan 21, 2022
@aaronshurley aaronshurley moved this to To Triage in Carvel Aug 18, 2022
@github-project-automation github-project-automation bot moved this to To Triage in Carvel Feb 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This issue is a feature request
Projects
Status: To Triage
Development

No branches or pull requests

1 participant