wrap --help output, fix rust 1.80 build #1440

th1000s · 2023-06-05T21:19:19Z

Set clap option max_term_width, so the help output is by default as wide as the terminal or this max value. Then manually wrap the after_long_help() text (only on demand) to the same width using textwrap. Also use matching ansi codes in this section.

Another try to improve deltas --help output, and I finally can use textwrap! But now --version and --help is handled manually. Another possibility would be to manually construct the pieces of claps StyledStr (...which is returned from render_help() and according to dbg!() different from the simple String wrapper? render_help() = StyledStr { pieces: [ (None, "A viewer for git and diff output",), (..)] } ).

CC @tjquillan @nickelc @FGasper

dandavison · 2023-06-05T21:38:57Z

Thanks! I tried this out and it seems like a good improvement to me.

(Tangential: Ultimately I feel that the lengthy man-page style output should be sent into a pager.)

th1000s · 2023-06-05T21:50:17Z

Now that --help is handled manually, piping the output into less -R is easy. And clap doesn't seen to support a pager currently.

dandavison · 2023-06-05T22:00:24Z

(There's a formatter error here.)

th1000s · 2023-06-06T21:40:27Z

The fmt is fixed, but sending the output into a pager via OutputType::from_mode (now using a lighter PagerCfg) doesn't work, the default pager less just quits after the first page. PagingMode::Always doesn't help, and a default DeltaEnv::init() works fine for the normal delta. However DELTA_PAGER="cat" does display the entire output. strace shows less is started as "/usr/bin/less", ["less", "--RAW-CONTROL-CHARS"] as expected, what am I missing?

dandavison · 2023-06-06T22:01:31Z

Hm. Is it the LESS environment variable supplying additional arguments?

th1000s · 2023-06-07T21:49:58Z

src/cli.rs

+                {
+                    write!(&mut writer, "{}", help.ansi()).unwrap();
+                    // dtor?
+                }


It wasn't the writer drop impl/destructor but the one of output_type!

th1000s · 2023-06-07T22:04:35Z

Now with pager support, even listens to PAGER etc. env vars for configuration (but not --paging never).

The full---help-output.md markdown is a bit out of sync, but could be generated from then ansi --help output itself. However the one tool for that, term2md, currently removes leading whitespace.

Oh and I found --show-themes is/was already broken.

dandavison · 2024-07-17T09:40:43Z

This one has conflicts for us to resolve. Sorry for letting it drag on.

th1000s · 2024-07-22T22:09:59Z

The full help output has to be regenerated (some ansi2md util would help), and I have to check that the big moved textblock in cli.rs is still correct.

dandavison · 2024-07-22T23:54:17Z

src/cli.rs

+If something isn't working correctly, or you have a feature request, please open an issue at https://github.com/dandavison/delta/issues.
+
+For a short help summary, please use delta -h.
+"##


The result of all this looks really nice.

dandavison · 2024-07-22T23:59:08Z

src/utils/bat/output.rs

+#[derive(Debug, Default)]
+pub struct PagerCfg {
+    pub navigate: bool,
+    pub show_themes: bool,


I should have added a comment on this code...

if config.show_themes { p.arg("+n"); }

If you happen to know or discover what the logic is do feel free to add a comment!

+cmd, "specified cmd to be executed", so on start is it as if the user pressed 'n' to continue the search.

Right thanks, I'll add that as a comment.

dandavison · 2024-07-22T23:59:46Z

src/cli.rs

+            Version(ver) => Some(Version(ver)),
+        }
+    }
+}


This all looks like a nice new organization of the command processing.

dandavison

LGTM! This will be a big improvement. The paging and new styling of the lengthy sections are really nice.

The full help output has to be regenerated

Just redirecting --help into that file and fixing the enclosing backticks, right -- or is something more needed?

Use new, smaller PagerCfg instead of the full Config, as for pager output only 3 variables are relevant. oneshot_write() can be used to write paginated output, usually before exiting.

Unicode and somewhat ANSI aware, can add indentation (skippable) and can also skip wrapping lines by using configurable magic prefixes.

th1000s · 2024-07-29T22:38:06Z

manual/src/full---help-output.md


-          `delta file_1 file_2` is equivalent to `diff -u file_1 file_2 | delta`.
+          `delta file_1 file_2` is equivalent to `diff -u file_1 file_2 |
+          delta`.



Now that is annoying, doesn't fit in 80 lines!

I'd be happy to lose the underscores; I think I'd debated them once or twice with myself.

Nice, now it fits!

th1000s

Okay, am redirecting --help into the markdown.

Also, I wrote... another wrap function 🙂. This time for the help output because I needed variable indentation.

th1000s · 2024-07-29T22:45:34Z

manual/src/full---help-output.md

+Git config
+
+  By default, delta takes settings from a section named "delta" in git config


This mentions the git config, but should also mention how to set pager = delta. This way --help is a stand-alone manual, at least for the basics.

And this quick start section should be right after Arguments:, but that will require some more --help surgery.

This mentions the git config, but should also mention how to set pager = delta. This way --help is a stand-alone manual, at least for the basics.

Agreed. Very happy for you to add this but let me know if you want me to do anything.

This PR is long enough, lets improve the help content in a different PR :)

Tell clap to not wrap output, append `after_long_help()` (with matching ansi codes in this section), then manually wrap the result. The help output is now paginated if writing to a terminal. All code paths flow back to main(), so an invoked pager is properly waited for (by the OutputType drop impl).

Upgrade "time" (and its dependency chain rooted at "plist"), the previous version did not build with 1.80. Tell the new 'unexpected_cfgs' lint that 'tarpaulin_include' is okay Mark one clippy lint as a false positive

th1000s · 2024-07-30T22:22:02Z

Also fixed the rust 1.80 build, note the Cargo.* changes. FTR, the build for the time crate was:

  --> /Users/runner/.cargo/registry/src/index.crates.io-6f17d22bba15001f/time-0.3.31/src/format_description/parse/mod.rs:83:9
   |
83 |     let items = format_items
   |         ^^^^^
...
86 |     Ok(items.into())
   |              ---- type must be known at this point
   |
help: consider giving `items` an explicit type, where the placeholders `_` are specified
   |
83 |     let items: Box<_> = format_items
   |              ++++++++

(Currently, v0.17.0, cargo install delta still works with 1.80, only --locked fails.)

dandavison · 2024-08-01T00:48:34Z

I've approved this one already; please merge at will!

dandavison · 2024-08-09T18:07:43Z

I think this PR accidentally caused delta -h lines to be wrapped; I've opened #1795.

ofalvai · 2024-08-13T12:56:24Z

@dandavison would it be possible to cut a new release with this Rust 1.80 fix? It would make it possible to upgrade delta in nixpkgs (NixOS/nixpkgs#332957)

dandavison · 2024-08-14T03:34:05Z

@ofalvai will do! I'll ping here when it's done.

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).

th1000s force-pushed the help_width branch from 4ef2558 to d88471b Compare June 6, 2023 21:35

th1000s commented Jun 7, 2023

View reviewed changes

th1000s force-pushed the help_width branch from d88471b to 92452b0 Compare June 7, 2023 21:50

th1000s force-pushed the help_width branch from 92452b0 to 6208283 Compare July 22, 2024 22:05

dandavison reviewed Jul 22, 2024

View reviewed changes

src/cli.rs

Version(ver) => Some(Version(ver)),

}

}

}

Copy link

Owner

dandavison Jul 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This all looks like a nice new organization of the command processing.

dandavison approved these changes Jul 23, 2024

View reviewed changes

th1000s added 3 commits July 29, 2024 23:25

OutputType: PagerCfg and oneshot_write

2cd87a5

Use new, smaller PagerCfg instead of the full Config, as for pager output only 3 variables are relevant. oneshot_write() can be used to write paginated output, usually before exiting.

Make drop impl of OutputType more prominent

19872ff

Add wrap function for --help output

1284a76

Unicode and somewhat ANSI aware, can add indentation (skippable) and can also skip wrapping lines by using configurable magic prefixes.

th1000s force-pushed the help_width branch from 6208283 to 45e9b00 Compare July 29, 2024 22:36

th1000s commented Jul 29, 2024

View reviewed changes

th1000s added 4 commits July 30, 2024 23:59

Use angle bracket around <urls>, regenerate help output markdown

1a275fd

Fix build for rust 1.80

9fc2f00

Upgrade "time" (and its dependency chain rooted at "plist"), the previous version did not build with 1.80. Tell the new 'unexpected_cfgs' lint that 'tarpaulin_include' is okay Mark one clippy lint as a false positive

Cargo toml dependencies all in one block, sorted

0edb394

th1000s force-pushed the help_width branch from 45e9b00 to 0edb394 Compare July 30, 2024 22:14

th1000s changed the title ~~wrap --help output~~ wrap --help output, fix rust 1.80 build Jul 30, 2024

dandavison merged commit 0712274 into dandavison:main Aug 2, 2024
13 checks passed

dandavison mentioned this pull request Aug 9, 2024

🐛 delta -h lines are wrapped #1795

Closed

alyssais mentioned this pull request Aug 13, 2024

Rust 1.80.0 breaks some packages NixOS/nixpkgs#332957

Open

BrewTestBot mentioned this pull request Aug 16, 2024

git-delta 0.18.0 Homebrew/homebrew-core#181387

Merged

sedlund mentioned this pull request Aug 22, 2024

batdiff test failed with delta 0.18.0 eth-p/bat-extras#126

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

wrap --help output, fix rust 1.80 build #1440

wrap --help output, fix rust 1.80 build #1440

th1000s commented Jun 5, 2023

dandavison commented Jun 5, 2023

th1000s commented Jun 5, 2023

dandavison commented Jun 5, 2023

th1000s commented Jun 6, 2023

dandavison commented Jun 6, 2023

th1000s Jun 7, 2023

th1000s commented Jun 7, 2023

dandavison commented Jul 17, 2024

th1000s commented Jul 22, 2024

dandavison Jul 22, 2024

dandavison Jul 22, 2024

th1000s Jul 30, 2024

dandavison Aug 1, 2024

dandavison Jul 22, 2024

dandavison left a comment

th1000s Jul 29, 2024

dandavison Jul 29, 2024

th1000s Jul 30, 2024

th1000s left a comment

th1000s Jul 29, 2024

dandavison Jul 31, 2024

th1000s Jul 31, 2024

th1000s commented Jul 30, 2024 •

edited

Loading

dandavison commented Aug 1, 2024

dandavison commented Aug 9, 2024

ofalvai commented Aug 13, 2024

dandavison commented Aug 14, 2024

		Git config

		By default, delta takes settings from a section named "delta" in git config

wrap --help output, fix rust 1.80 build #1440

wrap --help output, fix rust 1.80 build #1440

Conversation

th1000s commented Jun 5, 2023

dandavison commented Jun 5, 2023

th1000s commented Jun 5, 2023

dandavison commented Jun 5, 2023

th1000s commented Jun 6, 2023

dandavison commented Jun 6, 2023

Choose a reason for hiding this comment

th1000s commented Jun 7, 2023

dandavison commented Jul 17, 2024

th1000s commented Jul 22, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dandavison left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

th1000s left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

th1000s commented Jul 30, 2024 • edited Loading

dandavison commented Aug 1, 2024

dandavison commented Aug 9, 2024

ofalvai commented Aug 13, 2024

dandavison commented Aug 14, 2024

th1000s commented Jul 30, 2024 •

edited

Loading