2783 setting terminal title #2807

Oliver-Looney · 2023-12-18T17:36:38Z

This PR is to resolve issue #2783

This change sets the terminal title to the input file names when the pager is being used & --set-terminal-title flag is used, to make this feature opt in

Screen.Recording.2024-01-27.at.14.34.07.mov

…of IO circle detected error

Oliver-Looney · 2023-12-24T13:59:06Z

I am not sure how to fix this failing action CICD / arm-unknown-linux-gnueabihf (ubuntu-20.04) (pull_request)  

Error:

With the provided path, there will be 1 file uploaded
Artifact name is valid!
Root directory input is valid!
Error: Failed to CreateArtifact: Received non-retryable error: Failed request: (409) Conflict: an artifact with this name already exists on the workflow run

How to fix this?

Enselic · 2023-12-25T15:34:02Z

I think the CI failure will be fixed by #2811.

Enselic

Thank you for taking the time to create a PR. I skimmed it over and have one initial question.

Enselic · 2023-12-28T22:36:13Z

src/bin/bat/main.rs

+            input_names += ", ";
+        }
+    }
+    print!("\x1b]2;{}\x07", input_names);


Will this behave well in all major terminal emulators on all major OSes?

I believe ANSI escape characters are standard across terminal emulators on different OSes, https://en.wikipedia.org/wiki/ANSI_escape_code#OSC_(Operating_System_Command)_sequences

I have updated the 2 in this line to 0 to match those docs

…e into multiple variables

Oliver-Looney · 2023-12-31T22:54:12Z

Thanks for the review!

sharkdp · 2024-01-17T20:58:30Z

Thank you for your contribution. I would also be worried about portability of this specific ANSI escape code. If we can not test this across a wide range of terminal emulators at the moment, let's maybe make this opt-in at first?

Oliver-Looney · 2024-01-21T21:51:42Z

Yes, that makes sense. I'll update this pr to make this opt-in

…flag

…rgs aren't in clap_app.rs

eth-p

Thanks for adding this! There are a couple of tiny changes that I would like you to make, but this looks great otherwise!

src/bin/bat/app.rs

src/input.rs

eth-p · 2024-02-08T03:55:16Z

Thank you for your contribution. [...] let's maybe make this opt-in at first?

I'm not sure if it would be a good idea to transition this to becoming opt-out in the future without more feedback from users. I don't believe it's common for terminal programs other than the shell to set the title by default; vim requires you to give permission by adding set title to its config to enable it, for instance.

There's also the chance that setting the terminal title using a fixed pattern could break someone's workflow. For example, I have tmux configured to have different key bindings depending on the foreground application, which is determined by the pane's title. It would be an easy fix for me since I'm aware of the change, but it might be frustrating to others who aren't aware of the change.

But then again, it would likely be a small minority that has that issue. At some point, improving the UX for the many outweighs breaking the obscure workflows of the few.

I would also be worried about portability of this specific ANSI escape code. If we can not test this across a wide range of terminal emulators at the moment.

It should be safe. OSC sequences follows the form of INTRODUCER ID ; CONTENT TERMINATOR, with the introducer being ESC ] and terminator being either BEL or ESC \. This allows the terminal emulator to know where the sequence starts and ends, which means it can ignore any commands that it doesn't recognize. A good example of this would be hyperlinks, which are implemented using an OSC sequence:

VS Code (on the left) supports and recognizes hyperlinks, while Terminal.app (on the right) does not. This also applies to any random command that doesn't exist:

sharkdp · 2024-02-08T07:48:16Z

Thank you for your contribution. [...] let's maybe make this opt-in at first?

I'm not sure if it would be a good idea to transition this to becoming opt-out in the future without more feedback from users. I don't believe it's common for terminal programs other than the shell to set the title by default; vim requires you to give permission by adding set title to its config to enable it, for instance.

There's also the chance that setting the terminal title using a fixed pattern could break someone's workflow. For example, I have tmux configured to have different key bindings depending on the foreground application, which is determined by the pane's title. It would be an easy fix for me since I'm aware of the change, but it might be frustrating to others who aren't aware of the change.

Good points. Let's design it as an opt-in feature.

Oliver-Looney · 2024-02-08T21:48:46Z

Thanks for adding this! There are a couple of tiny changes that I would like you to make, but this looks great otherwise!

Thanks for the review! I think I have implemented the changes. I'll get the tests fixed in the next day or two

eth-p

Looks good to me! Thanks for making the changes :)

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [sharkdp/bat](https://github.com/sharkdp/bat) | minor | `v0.24.0` -> `v0.25.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>sharkdp/bat (sharkdp/bat)</summary> ### [`v0.25.0`](https://github.com/sharkdp/bat/blob/HEAD/CHANGELOG.md#v0250) [Compare Source](sharkdp/bat@v0.24.0...v0.25.0) #### Features - Set terminal title to file names when Paging is not Paging::Never [#2807](sharkdp/bat#2807) ([@Oliver-Looney](https://github.com/Oliver-Looney)) - `bat --squeeze-blank`/`bat -s` will now squeeze consecutive empty lines, see [#1441](sharkdp/bat#1441) ([@eth-p](https://github.com/eth-p)) and [#2665](sharkdp/bat#2665) ([@einfachIrgendwer0815](https://github.com/einfachIrgendwer0815)) - `bat --squeeze-limit` to set the maximum number of empty consecutive when using `--squeeze-blank`, see [#1441](sharkdp/bat#1441) ([@eth-p](https://github.com/eth-p)) and [#2665](sharkdp/bat#2665) ([@einfachIrgendwer0815](https://github.com/einfachIrgendwer0815)) - `PrettyPrinter::squeeze_empty_lines` to support line squeezing for bat as a library, see [#1441](sharkdp/bat#1441) ([@eth-p](https://github.com/eth-p)) and [#2665](sharkdp/bat#2665) ([@einfachIrgendwer0815](https://github.com/einfachIrgendwer0815)) - Syntax highlighting for JavaScript files that start with `#!/usr/bin/env bun` [#2913](sharkdp/bat#2913) ([@sharunkumar](https://github.com/sharunkumar)) - `bat --strip-ansi={never,always,auto}` to remove ANSI escape sequences from bat's input, see [#2999](sharkdp/bat#2999) ([@eth-p](https://github.com/eth-p)) - Add or remove individual style components without replacing all styles [#2929](sharkdp/bat#2929) ([@eth-p](https://github.com/eth-p)) - Automatically choose theme based on the terminal's color scheme, see [#2896](sharkdp/bat#2896) ([@bash](https://github.com/bash)) - Add option `--binary=as-text` for printing binary content, see issue [#2974](sharkdp/bat#2974) and MR [#2976](sharkdp/bat#2976) ([@einfachIrgendwer0815](https://github.com/einfachIrgendwer0815)) - Make shell completions available via `--completion <shell>`, see issue [#2057](sharkdp/bat#2057) and MR [#3126](sharkdp/bat#3126) ([@einfachIrgendwer0815](https://github.com/einfachIrgendwer0815)) - Syntax highlighting for puppet code blocks within Markdown files, see [#3152](sharkdp/bat#3152) ([@liliwilson](https://github.com/liliwilson)) #### Bugfixes - Fix long file name wrapping in header, see [#2835](sharkdp/bat#2835) ([@FilipRazek](https://github.com/FilipRazek)) - Fix `NO_COLOR` support, see [#2767](sharkdp/bat#2767) ([@acuteenvy](https://github.com/acuteenvy)) - Fix handling of inputs with OSC ANSI escape sequences, see [#2541](sharkdp/bat#2541) and [#2544](sharkdp/bat#2544) ([@eth-p](https://github.com/eth-p)) - Fix handling of inputs with combined ANSI color and attribute sequences, see [#2185](sharkdp/bat#2185) and [#2856](sharkdp/bat#2856) ([@eth-p](https://github.com/eth-p)) - Fix panel width when line 10000 wraps, see [#2854](sharkdp/bat#2854) ([@eth-p](https://github.com/eth-p)) - Fix compile issue of `time` dependency caused by standard library regression [#3045](sharkdp/bat#3045) ([@cyqsimon](https://github.com/cyqsimon)) - Fix override behavior of --plain and --paging, see issue [#2731](sharkdp/bat#2731) and MR [#3108](sharkdp/bat#3108) ([@einfachIrgendwer0815](https://github.com/einfachIrgendwer0815)) - Fix bugs in `$LESSOPEN` support, see [#2805](sharkdp/bat#2805) ([@Anomalocaridid](https://github.com/Anomalocaridid)) #### Other - Upgrade to Rust 2021 edition [#2748](sharkdp/bat#2748) ([@cyqsimon](https://github.com/cyqsimon)) - Refactor and cleanup build script [#2756](sharkdp/bat#2756) ([@cyqsimon](https://github.com/cyqsimon)) - Checks changelog has been written to for MRs in CI [#2766](sharkdp/bat#2766) ([@cyqsimon](https://github.com/cyqsimon)) - Use GitHub API to get correct MR submitter [#2791](sharkdp/bat#2791) ([@cyqsimon](https://github.com/cyqsimon)) - Minor benchmark script improvements [#2768](sharkdp/bat#2768) ([@cyqsimon](https://github.com/cyqsimon)) - Update Arch Linux package URL in README files [#2779](sharkdp/bat#2779) ([@brunobell](https://github.com/brunobell)) - Update and improve `zsh` completion, see [#2772](sharkdp/bat#2772) ([@okapia](https://github.com/okapia)) - More extensible syntax mapping mechanism [#2755](sharkdp/bat#2755) ([@cyqsimon](https://github.com/cyqsimon)) - Use proper Architecture for Debian packages built for musl, see [#2811](sharkdp/bat#2811) ([@Enselic](https://github.com/Enselic)) - Pull in fix for unsafe-libyaml security advisory, see [#2812](sharkdp/bat#2812) ([@dtolnay](https://github.com/dtolnay)) - Update git-version dependency to use Syn v2, see [#2816](sharkdp/bat#2816) ([@dtolnay](https://github.com/dtolnay)) - Update git2 dependency to v0.18.2, see [#2852](sharkdp/bat#2852) ([@eth-p](https://github.com/eth-p)) - Improve performance when color output disabled, see [#2397](sharkdp/bat#2397) and [#2857](sharkdp/bat#2857) ([@eth-p](https://github.com/eth-p)) - Relax syntax mapping rule restrictions to allow brace expansion [#2865](sharkdp/bat#2865) ([@cyqsimon](https://github.com/cyqsimon)) - Apply clippy fixes [#2864](sharkdp/bat#2864) ([@cyqsimon](https://github.com/cyqsimon)) - Faster startup by offloading glob matcher building to a worker thread [#2868](sharkdp/bat#2868) ([@cyqsimon](https://github.com/cyqsimon)) - Display which theme is the default one in basic output (no colors), see [#2937](sharkdp/bat#2937) ([@sblondon](https://github.com/sblondon)) - Display which theme is the default one in colored output, see [#2838](sharkdp/bat#2838) ([@sblondon](https://github.com/sblondon)) - Add aarch64-apple-darwin ("Apple Silicon") binary tarballs to releases, see [#2967](sharkdp/bat#2967) ([@someposer](https://github.com/someposer)) - Update the Lisp syntax, see [#2970](sharkdp/bat#2970) ([@ccqpein](https://github.com/ccqpein)) - Use bat's ANSI iterator during tab expansion, see [#2998](sharkdp/bat#2998) ([@eth-p](https://github.com/eth-p)) - Support 'statically linked binary' for aarch64 in 'Release' page, see [#2992](sharkdp/bat#2992) ([@tzq0301](https://github.com/tzq0301)) - Update options in shell completions and the man page of `bat`, see [#2995](sharkdp/bat#2995) ([@akinomyoga](https://github.com/akinomyoga)) - Update nix dev-dependency to v0.29.0, see [#3112](sharkdp/bat#3112) ([@decathorpe](https://github.com/decathorpe)) - Bump MSRV to [1.74](https://blog.rust-lang.org/2023/11/16/Rust-1.74.0.html), see [#3154](sharkdp/bat#3154) ([@keith-hall](https://github.com/keith-hall)) - Update clircle dependency to remove winapi transitive dependency, see [#3113](sharkdp/bat#3113) ([@niklasmohrin](https://github.com/niklasmohrin)) #### Syntaxes - `cmd-help`: scope subcommands followed by other terms, and other misc improvements, see [#2819](sharkdp/bat#2819) ([@victor-gp](https://github.com/victor-gp)) - Upgrade JQ syntax, see [#2820](sharkdp/bat#2820) ([@dependabot](https://github.com/dependabot)\[bot]) - Add syntax mapping for quadman quadlets [#2866](sharkdp/bat#2866) ([@cyqsimon](https://github.com/cyqsimon)) - Map containers .conf files to TOML syntax [#2867](sharkdp/bat#2867) ([@cyqsimon](https://github.com/cyqsimon)) - Associate `.xsh` files with `xonsh` syntax that is Python, see [#2840](sharkdp/bat#2840) ([@anki-code](https://github.com/anki-code)) - Associate JSON with Comments `.jsonc` with `json` syntax, see [#2795](sharkdp/bat#2795) ([@mxaddict](https://github.com/mxaddict)) - Associate JSON-LD `.jsonld` files with `json` syntax, see [#3037](sharkdp/bat#3037) ([@vorburger](https://github.com/vorburger)) - Associate `.textproto` files with `ProtoBuf` syntax, see [#3038](sharkdp/bat#3038) ([@vorburger](https://github.com/vorburger)) - Associate GeoJSON `.geojson` files with `json` syntax, see [#3084](sharkdp/bat#3084) ([@mvaaltola](https://github.com/mvaaltola)) - Associate `.aws/{config,credentials}`, see [#2795](sharkdp/bat#2795) ([@mxaddict](https://github.com/mxaddict)) - Associate Wireguard config `/etc/wireguard/*.conf`, see [#2874](sharkdp/bat#2874) ([@cyqsimon](https://github.com/cyqsimon)) - Add support for [CFML](https://www.adobe.com/products/coldfusion-family.html), see [#3031](sharkdp/bat#3031) ([@brenton-at-pieces](https://github.com/brenton-at-pieces)) - Map `*.mkd` files to `Markdown` syntax, see issue [#3060](sharkdp/bat#3060) and MR [#3061](sharkdp/bat#3061) ([@einfachIrgendwer0815](https://github.com/einfachIrgendwer0815)) - Add syntax mapping for CITATION.cff, see [#3103](sharkdp/bat#3103) ([@Ugzuzg](https://github.com/Ugzuzg)) - Add syntax mapping for kubernetes config files [#3049](sharkdp/bat#3049) ([@cyqsimon](https://github.com/cyqsimon)) - Adds support for pipe delimiter for CSV [#3115](sharkdp/bat#3115) ([@pratik-m](https://github.com/pratik-m)) - Add syntax mapping for `/etc/pacman.conf` [#2961](sharkdp/bat#2961) ([@cyqsimon](https://github.com/cyqsimon)) - Associate `uv.lock` with `TOML` syntax, see [#3132](sharkdp/bat#3132) ([@fepegar](https://github.com/fepegar)) #### Themes - Patched/improved themes for better Manpage syntax highlighting support, see [#2994](sharkdp/bat#2994) ([@keith-hall](https://github.com/keith-hall)). #### `bat` as a library - Changes to `syntax_mapping::SyntaxMapping` [#2755](sharkdp/bat#2755) ([@cyqsimon](https://github.com/cyqsimon)) - `SyntaxMapping::get_syntax_for` is now correctly public - \[BREAKING] `SyntaxMapping::{empty,builtin}` are removed; use `SyntaxMapping::new` instead - \[BREAKING] `SyntaxMapping::mappings` is replaced by `SyntaxMapping::{builtin,custom,all}_mappings` - Make `Controller::run_with_error_handler`'s error handler `FnMut`, see [#2831](sharkdp/bat#2831) ([@rhysd](https://github.com/rhysd)) - Improve compile time by 20%, see [#2815](sharkdp/bat#2815) ([@dtolnay](https://github.com/dtolnay)) - Add `theme::theme` for choosing an appropriate theme based on the terminal's color scheme, see [#2896](sharkdp/bat#2896) ([@bash](https://github.com/bash)) - \[BREAKING] Remove `HighlightingAssets::default_theme`. Use `theme::default_theme` instead. - Add `PrettyPrinter::print_with_writer` for custom output destinations, see [#3070](sharkdp/bat#3070) ([@kojix2](https://github.com/kojix2)) </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).

Oliver-Looney added 12 commits December 10, 2023 16:39

able to set terminal title to hardcoded value

2e103ee

title is being reset on quit, so no need to restore terminal title

4863d42

successfully setting the terminal title to bat's input's names

b9b5542

fixed formatting of terminal title

069318b

tidied commits

6ad800e

fixed all but two failing tests. Last two tests are erroring because …

fd84e4f

…of IO circle detected error

terminal title is only set when pager is being used

12b74df

updated tests since terminal title is set conditionally

907af9e

updated CHANGELOG.md

1679460

updated CHANGELOG.md

321b3ec

fixed system_wide_config.rs tests

0027055

ran cargo fmt

5b4ce68

Oliver-Looney closed this Dec 19, 2023

Oliver-Looney reopened this Dec 19, 2023

Merge branch 'master' into 2783-setting-terminal-title

d7503bf

Enselic reviewed Dec 28, 2023

View reviewed changes

Oliver-Looney and others added 4 commits December 31, 2023 22:15

small refactoring of set terminal title function

57016f4

slightly changed set terminal command to match docs & broke print lin…

3b0ade9

…e into multiple variables

Merge branch 'master' into 2783-setting-terminal-title

6f1cc80

trying to fix failing system_wide_config.rs tests

c261b41

Merge branch 'master' into 2783-setting-terminal-title

b4fdb5d

einfachIrgendwer0815 mentioned this pull request Jan 27, 2024

Change CONTRIBUTING.md according to new changelog requirements #2839

Merged

Oliver-Looney added 3 commits January 27, 2024 14:14

added a flag to config for setting terminal title

9239b12

terminal title is only set if user opts in with --set_terminal_title …

b33e33f

…flag

fixed failing tests

c911829

Oliver-Looney added 7 commits January 27, 2024 14:31

added integration test for setting terminal title

f6d76e0

ran cargo fmt

2225493

fixed system wide config tests failing

9be2a36

cargo fmt

e9a6aaa

removed set_terminal_title arg from clap_app.rs since other boolean a…

60e32cf

…rgs aren't in clap_app.rs

added set_terminal_title arg to clap_app.rs to fix ci errors

7f12989

updated integration_tests.rs

a8d0733

eth-p requested changes Feb 8, 2024

View reviewed changes

src/bin/bat/app.rs Outdated Show resolved Hide resolved

src/input.rs Outdated Show resolved Hide resolved

src/input.rs Outdated Show resolved Hide resolved

Oliver-Looney added 2 commits February 8, 2024 21:33

Using hypens instead of underscores for set-terminal-title command

7ce010d

undid unnecessary api visibility changes

02077db

eth-p approved these changes Feb 10, 2024

View reviewed changes

Oliver-Looney force-pushed the 2783-setting-terminal-title branch 3 times, most recently from 2798de4 to 02077db Compare February 11, 2024 22:38

Oliver-Looney and others added 3 commits February 11, 2024 22:43

simplified basic_set_terminal_title

8a51172

Merge branch 'master' into 2783-setting-terminal-title

c3f2ddf

Merge branch 'master' into 2783-setting-terminal-title

1f62820

sharkdp merged commit 7604fe5 into sharkdp:master Feb 23, 2024
22 checks passed

Oliver-Looney deleted the 2783-setting-terminal-title branch May 5, 2024 12:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

2783 setting terminal title #2807

2783 setting terminal title #2807

Oliver-Looney commented Dec 18, 2023 •

edited

Loading

Oliver-Looney commented Dec 24, 2023

Enselic commented Dec 25, 2023

Enselic left a comment

Enselic Dec 28, 2023

Oliver-Looney Dec 31, 2023

Oliver-Looney commented Dec 31, 2023

sharkdp commented Jan 17, 2024

Oliver-Looney commented Jan 21, 2024

eth-p left a comment

eth-p commented Feb 8, 2024

sharkdp commented Feb 8, 2024 •

edited

Loading

Oliver-Looney commented Feb 8, 2024

eth-p left a comment •

edited

Loading

2783 setting terminal title #2807

2783 setting terminal title #2807

Conversation

Oliver-Looney commented Dec 18, 2023 • edited Loading

Oliver-Looney commented Dec 24, 2023

Enselic commented Dec 25, 2023

Enselic left a comment

Choose a reason for hiding this comment

Enselic Dec 28, 2023

Choose a reason for hiding this comment

Oliver-Looney Dec 31, 2023

Choose a reason for hiding this comment

Oliver-Looney commented Dec 31, 2023

sharkdp commented Jan 17, 2024

Oliver-Looney commented Jan 21, 2024

eth-p left a comment

Choose a reason for hiding this comment

eth-p commented Feb 8, 2024

sharkdp commented Feb 8, 2024 • edited Loading

Oliver-Looney commented Feb 8, 2024

eth-p left a comment • edited Loading

Choose a reason for hiding this comment

Oliver-Looney commented Dec 18, 2023 •

edited

Loading

sharkdp commented Feb 8, 2024 •

edited

Loading

eth-p left a comment •

edited

Loading