Fix panic when blame-palette is empty #1737

thorio · 2024-07-04T20:09:24Z

Currently, when blame-palette is set to an empty string, the application panics:

$ git blame ARCHITECTURE.md | delta --blame-palette ""
thread 'main' panicked at src/handlers/blame.rs:175:47:
attempt to calculate the remainder with a divisor of zero
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

This patch replaces this with a nicer error message:

$ git blame ARCHITECTURE.md | delta --blame-palette ""
Option 'blame-palette' must not be empty.

dandavison · 2024-07-07T16:29:20Z

src/handlers/blame.rs

+
+        if n_colors == 0 {
+            fatal("Option 'blame-palette' must not be empty.")
+        }


Thanks @thorio! I'm thinking that this should go earlier since it is essentially user input validation. Perhaps in src/config.rs where we first parse the argument. (Or maybe clap has a "value parsing" feature that we can use?)

I thought about that, but since the actual color is only parsed after this point, I just stuck the check here for simplicity.

Ideally clap would parse the color and palette, then store it in a struct or enum guaranteeing its validity, but that would be a larger change.

As for just moving it earlier in the execution, I think right after this line would be a good spot.

src/handlers/blame.rs

dandavison · 2024-07-08T07:43:10Z

Thanks!

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [dandavison/delta](https://github.com/dandavison/delta) | minor | `0.17.0` -> `0.18.0` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>dandavison/delta (dandavison/delta)</summary> ### [`v0.18.0`](https://github.com/dandavison/delta/releases/tag/0.18.0) [Compare Source](dandavison/delta@0.17.0...0.18.0) As usual, tons of excellent contributions, all but one not by me! [@th1000s](https://github.com/th1000s) has made a huge number of important and difficult improvements to delta and helped with many issues over the few years since the project started, and so I'm happy to say that he's co-maintaining the project with me nowadays. Thanks to all contributors for the improvements below! #### What's Changed - Link to Repository from Manual by [@bash](https://github.com/bash) in dandavison/delta#1657 - Stop highlighting unchanged whitespace by [@phillipwood](https://github.com/phillipwood) in dandavison/delta#1659 - Add .gitattributes rules for rust files by [@phillipwood](https://github.com/phillipwood) in dandavison/delta#1245 - Repair --default-language, and highlight using full filename by [@th1000s](https://github.com/th1000s) in dandavison/delta#1549 - tests: prevent parallel env var access by [@th1000s](https://github.com/th1000s) in dandavison/delta#1681 - CI: fix macOS build by [@th1000s](https://github.com/th1000s) in dandavison/delta#1696 - Only use `nosort` in bash <4.4 by [@martinml](https://github.com/martinml) in dandavison/delta#1683 - Don't read git files when --no-gitconfig is given + unused variables by [@th1000s](https://github.com/th1000s) in dandavison/delta#1728 - tests: add insta for snapshot testing by [@th1000s](https://github.com/th1000s) in dandavison/delta#1739 - tests: set terminal width to 43 by [@th1000s](https://github.com/th1000s) in dandavison/delta#1741 - Fix panic when blame-palette is empty by [@thorio](https://github.com/thorio) in dandavison/delta#1737 - Make relative-paths work with binary files by [@th1000s](https://github.com/th1000s) in dandavison/delta#1740 - Fix github links from master to main by [@madeddie](https://github.com/madeddie) in dandavison/delta#1709 - Update `terminal-colorsaurus` by [@bash](https://github.com/bash) in dandavison/delta#1699 - Make less version >= 633 behave like previous versions wrt. Nerd Fonts by [@th1000s](https://github.com/th1000s) in dandavison/delta#1762 - Update `catppuccin-latte` casing in `LIGHT_SYNTAX_THEMES` list by [@injust](https://github.com/injust) in dandavison/delta#1745 - deps: bump libc from 0.2.153 to 0.2.155 by [@wxpppp](https://github.com/wxpppp) in dandavison/delta#1715 - Add missing `--file-*-label` option to `--navigate` docs by [@injust](https://github.com/injust) in dandavison/delta#1744 - Fix copy-paste typo by [@injust](https://github.com/injust) in dandavison/delta#1767 - Update syntect to 5.2.0 by [@timhillgit](https://github.com/timhillgit) in dandavison/delta#1672 - Disable light mode detection in tests by [@bash](https://github.com/bash) in dandavison/delta#1765 - Add --max-syntax-highlighting-length, set to 400 by [@th1000s](https://github.com/th1000s) in dandavison/delta#1746 - chore: cleanup brew formula file in favor of core tap by [@chenrui333](https://github.com/chenrui333) in dandavison/delta#1773 - wrap --help output, fix rust 1.80 build by [@th1000s](https://github.com/th1000s) in dandavison/delta#1440 - Fix delta-toggle shell script by [@dandavison](https://github.com/dandavison) in dandavison/delta#1794 - Do not wrap short help (-h) output by [@th1000s](https://github.com/th1000s) in dandavison/delta#1800 - Implement --diff-args by [@dandavison](https://github.com/dandavison) in dandavison/delta#1697 - Handle ambiguous diff header, '--- ' can also be present in a minus hunk by [@th1000s](https://github.com/th1000s) in dandavison/delta#1787 - cd: build binaries targeting GNU libc on ubuntu-20.04, not latest by [@th1000s](https://github.com/th1000s) in dandavison/delta#1805 #### New Contributors - [@martinml](https://github.com/martinml) made their first contribution in dandavison/delta#1683 - [@thorio](https://github.com/thorio) made their first contribution in dandavison/delta#1737 - [@madeddie](https://github.com/madeddie) made their first contribution in dandavison/delta#1709 - [@injust](https://github.com/injust) made their first contribution in dandavison/delta#1745 - [@wxpppp](https://github.com/wxpppp) made their first contribution in dandavison/delta#1715 - [@timhillgit](https://github.com/timhillgit) made their first contribution in dandavison/delta#1672 - [@chenrui333](https://github.com/chenrui333) made their first contribution in dandavison/delta#1773 **Full Changelog**: dandavison/delta@0.17.0...0.18.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

Fix panic when blame-palette is empty

139a152

dandavison reviewed Jul 7, 2024

View reviewed changes

Move check to config.rs

38b765c

dandavison reviewed Jul 8, 2024

View reviewed changes

src/handlers/blame.rs Outdated Show resolved Hide resolved

Update src/handlers/blame.rs

e325a11

dandavison merged commit 716fa79 into dandavison:main Jul 8, 2024
13 checks passed

BrewTestBot mentioned this pull request Aug 16, 2024

git-delta 0.18.0 Homebrew/homebrew-core#181387

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix panic when blame-palette is empty #1737

Fix panic when blame-palette is empty #1737

thorio commented Jul 4, 2024

dandavison Jul 7, 2024

thorio Jul 7, 2024 •

edited

Loading

dandavison commented Jul 8, 2024

Fix panic when blame-palette is empty #1737

Fix panic when blame-palette is empty #1737

Conversation

thorio commented Jul 4, 2024

dandavison Jul 7, 2024

Choose a reason for hiding this comment

thorio Jul 7, 2024 • edited Loading

Choose a reason for hiding this comment

dandavison commented Jul 8, 2024

thorio Jul 7, 2024 •

edited

Loading