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

docs: Adding error property to theme example; #469

Merged
merged 1 commit into from
Oct 30, 2024

Conversation

rogeruiz
Copy link
Contributor

Summary

With the additional property of error added to theme color in the
#458, the configuration of themes break if this property is
missing. This patch then adds it to the example to help users understand what's
required for theming gh-dash.

How did you test this change?

If the ~/.config/gh-dash/config.yml contains a reference to a theme:colors
stanza but the text stanza doesn't contain an error property, you will see
the following error.

2024-10-30T12:24:29-05:00 FATA <ui/ui.go:107> Reading config file: failed parsing config file location="" err="failed parsing config.yml: Key: 'Config.theme.colors.Inline.text.error' Error:Field validation for 'error' failed on the 'hexcolor' tag"

And it breaks the rest of your shell session as well. It's probably a good idea
to fix that error with some defaults. But for now, I think we can avoid the
issue by updating the documentation.

Images/Videos

n/a

With the additional property of `error` added to theme color in the
dlvhdr#458, the configuration of themes break if this property is
missing. This patch then adds it to the example to help users understand what's
required for theming `gh-dash`.
rogeruiz added a commit to rogeruiz/catppuccin-gh-dash that referenced this pull request Oct 30, 2024
See more info at dlvhdr/gh-dash#469. This patch adds the error property and sets
it to red with the warning property now being set to yellow.
@dlvhdr dlvhdr merged commit a1c0588 into dlvhdr:main Oct 30, 2024
@rogeruiz rogeruiz deleted the rogeruiz/fix-theming-example branch October 30, 2024 21:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants