Merge pull request #2807 from Oliver-Looney/2783-setting-terminal-title

2783 setting terminal title
This commit is contained in:
David Peter 2024-02-23 21:37:28 +01:00 committed by GitHub
commit 7604fe5567
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 52 additions and 0 deletions

View File

@ -2,6 +2,8 @@
## Features ## Features
- Set terminal title to file names when Paging is not Paging::Never #2807 (@Oliver-Looney)
## Bugfixes ## Bugfixes
- Fix long file name wrapping in header, see #2835 (@FilipRazek) - Fix long file name wrapping in header, see #2835 (@FilipRazek)

View File

@ -160,6 +160,9 @@ Options:
--acknowledgements --acknowledgements
Show acknowledgements. Show acknowledgements.
--set-terminal-title
Sets terminal title to filenames when using a pager.
-h, --help -h, --help
Print help (see a summary with '-h') Print help (see a summary with '-h')

View File

@ -289,6 +289,7 @@ impl App {
use_custom_assets: !self.matches.get_flag("no-custom-assets"), use_custom_assets: !self.matches.get_flag("no-custom-assets"),
#[cfg(feature = "lessopen")] #[cfg(feature = "lessopen")]
use_lessopen: self.matches.get_flag("lessopen"), use_lessopen: self.matches.get_flag("lessopen"),
set_terminal_title: self.matches.get_flag("set-terminal-title"),
}) })
} }

View File

@ -567,6 +567,13 @@ pub fn build_app(interactive_output: bool) -> Command {
.action(ArgAction::SetTrue) .action(ArgAction::SetTrue)
.hide_short_help(true) .hide_short_help(true)
.help("Show acknowledgements."), .help("Show acknowledgements."),
)
.arg(
Arg::new("set-terminal-title")
.long("set-terminal-title")
.action(ArgAction::SetTrue)
.hide_short_help(true)
.help("Sets terminal title to filenames when using a pager."),
); );
// Check if the current directory contains a file name cache. Otherwise, // Check if the current directory contains a file name cache. Otherwise,

View File

@ -229,9 +229,33 @@ pub fn list_themes(cfg: &Config, config_dir: &Path, cache_dir: &Path) -> Result<
Ok(()) Ok(())
} }
fn set_terminal_title_to(new_terminal_title: String) {
let osc_command_for_setting_terminal_title = "\x1b]0;";
let osc_end_command = "\x07";
print!(
"{}{}{}",
osc_command_for_setting_terminal_title, new_terminal_title, osc_end_command
);
io::stdout().flush().unwrap();
}
fn get_new_terminal_title(inputs: &Vec<Input>) -> String {
let mut new_terminal_title = "bat: ".to_string();
for (index, input) in inputs.iter().enumerate() {
new_terminal_title += input.description().title();
if index < inputs.len() - 1 {
new_terminal_title += ", ";
}
}
new_terminal_title
}
fn run_controller(inputs: Vec<Input>, config: &Config, cache_dir: &Path) -> Result<bool> { fn run_controller(inputs: Vec<Input>, config: &Config, cache_dir: &Path) -> Result<bool> {
let assets = assets_from_cache_or_binary(config.use_custom_assets, cache_dir)?; let assets = assets_from_cache_or_binary(config.use_custom_assets, cache_dir)?;
let controller = Controller::new(config, &assets); let controller = Controller::new(config, &assets);
if config.paging_mode != PagingMode::Never && config.set_terminal_title {
set_terminal_title_to(get_new_terminal_title(&inputs));
}
controller.run(inputs, None) controller.run(inputs, None)
} }

View File

@ -94,6 +94,9 @@ pub struct Config<'a> {
// Whether or not to use $LESSOPEN if set // Whether or not to use $LESSOPEN if set
#[cfg(feature = "lessopen")] #[cfg(feature = "lessopen")]
pub use_lessopen: bool, pub use_lessopen: bool,
// Weather or not to set terminal title when using a pager
pub set_terminal_title: bool,
} }
#[cfg(all(feature = "minimal-application", feature = "paging"))] #[cfg(all(feature = "minimal-application", feature = "paging"))]

View File

@ -936,6 +936,18 @@ fn env_var_bat_paging() {
}); });
} }
#[test]
fn basic_set_terminal_title() {
bat()
.arg("--paging=always")
.arg("--set-terminal-title")
.arg("test.txt")
.assert()
.success()
.stdout("\u{1b}]0;bat: test.txt\x07hello world\n")
.stderr("");
}
#[test] #[test]
fn diagnostic_sanity_check() { fn diagnostic_sanity_check() {
bat() bat()