add cli flag to open files tab with selected file #2510

Author: laktak

CHANGELOG.md

@@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * new command-line option to override the default log file path (`--logfile`) [[@acuteenvy](https://github.com/acuteenvy)] ([#2539](https://github.com/gitui-org/gitui/pull/2539))
 * dx: `make check` checks Cargo.toml dependency ordering using `cargo sort` [[@naseschwarz](https://github.com/naseschwarz)]
 * add `use_selection_fg` to theme file to allow customizing selection foreground color [[@Upsylonbare](https://github.com/Upsylonbare)] ([#2515](https://github.com/gitui-org/gitui/pull/2515))
+* add `--file` cli flag to open the files tab with the given file already selected [[@laktak](https://github.com/laktak)] ([#2510](https://github.com/gitui-org/gitui/issues/2510))
 
 ### Changed
 * improve error messages [[@acuteenvy](https://github.com/acuteenvy)] ([#2617](https://github.com/gitui-org/gitui/pull/2617))

src/app.rs

@@ -155,6 +155,7 @@ impl App {
 		sender_app: Sender<AsyncAppNotification>,
 		input: Input,
 		theme: Theme,
+		select_file: Option<PathBuf>,
 		key_config: KeyConfig,
 	) -> Result<Self> {
 		log::trace!("open repo at: {:?}", &repo);
@@ -230,7 +231,21 @@ impl App {
 			popup_stack: PopupStack::default(),
 		};
 
-		app.set_tab(tab)?;
+		if let Some(file) = select_file {
+			app.set_tab(2)?;
+			// convert to relative git path
+			if let Ok(abs) = file.canonicalize() {
+				let repo =
+					app.repo.borrow().gitpath().canonicalize()?;
+				if let Ok(path) = abs.strip_prefix(repo) {
+					app.queue.push(InternalEvent::SelectFile {
+						path: Path::new(".").join(path),
+					});
+				}
+			}
+		} else {
+			app.set_tab(tab)?;
+		}
 
 		Ok(app)
 	}
@@ -771,6 +786,9 @@ impl App {
 			InternalEvent::SelectBranch => {
 				self.select_branch_popup.open()?;
 			}
+			InternalEvent::SelectFile { path } => {
+				self.files_tab.find_file(&path);
+			}
 			InternalEvent::ViewSubmodules => {
 				self.submodule_popup.open()?;
 			}

src/args.rs

@@ -17,13 +17,15 @@ const LOG_FILE_FLAG_ID: &str = "logfile";
 const LOGGING_FLAG_ID: &str = "logging";
 const THEME_FLAG_ID: &str = "theme";
 const WORKDIR_FLAG_ID: &str = "workdir";
+const FILE_FLAG_ID: &str = "file";
 const GIT_DIR_FLAG_ID: &str = "directory";
 const WATCHER_FLAG_ID: &str = "watcher";
 const DEFAULT_THEME: &str = "theme.ron";
 const DEFAULT_GIT_DIR: &str = ".";
 
 pub struct CliArgs {
 	pub theme: PathBuf,
+	pub select_file: Option<PathBuf>,
 	pub repo_path: RepoPath,
 	pub notify_watcher: bool,
 }
@@ -51,6 +53,10 @@ pub fn process_cmdline() -> Result<CliArgs> {
 			PathBuf::from,
 		);
 
+	let select_file = arg_matches
+		.get_one::<String>(FILE_FLAG_ID)
+		.map(PathBuf::from);
+
 	let repo_path = if let Some(w) = workdir {
 		RepoPath::Workdir { gitdir, workdir: w }
 	} else {
@@ -75,6 +81,7 @@ pub fn process_cmdline() -> Result<CliArgs> {
 
 	Ok(CliArgs {
 		theme,
+		select_file,
 		repo_path,
 		notify_watcher,
 	})
@@ -129,6 +136,13 @@ fn app() -> ClapApp {
 				.long("bugreport")
 				.action(clap::ArgAction::SetTrue),
 		)
+		.arg(
+			Arg::new(FILE_FLAG_ID)
+				.help("Select the file in the file tab")
+				.short('f')
+				.long("file")
+				.num_args(1),
+		)
 		.arg(
 			Arg::new(GIT_DIR_FLAG_ID)
 				.help("Set the git directory")

src/main.rs

@@ -105,7 +105,7 @@ use std::{
 	cell::RefCell,
 	io::{self, Stdout},
 	panic,
-	path::Path,
+	path::{Path, PathBuf},
 	time::{Duration, Instant},
 };
 use ui::style::Theme;
@@ -195,6 +195,7 @@ fn main() -> Result<()> {
 			app_start,
 			repo_path.clone(),
 			theme.clone(),
+			cliargs.select_file.clone(),
 			key_config.clone(),
 			&input,
 			updater,
@@ -212,10 +213,12 @@ fn main() -> Result<()> {
 	Ok(())
 }
 
+#[allow(clippy::too_many_arguments)]
 fn run_app(
 	app_start: Instant,
 	repo: RepoPath,
 	theme: Theme,
+	select_file: Option<PathBuf>,
 	key_config: KeyConfig,
 	input: &Input,
 	updater: Updater,
@@ -244,6 +247,7 @@ fn run_app(
 		tx_app,
 		input.clone(),
 		theme,
+		select_file,
 		key_config,
 	)?;
 

src/queue.rs

@@ -120,6 +120,8 @@ pub enum InternalEvent {
 	///
 	SelectBranch,
 	///
+	SelectFile { path: PathBuf },
+	///
 	OpenExternalEditor(Option<String>),
 	///
 	Push(String, PushType, bool, bool),

src/tabs/files.rs

@@ -58,6 +58,10 @@ impl FilesTab {
 	pub fn file_finder_update(&mut self, file: &Path) {
 		self.files.find_file(file);
 	}
+
+	pub fn find_file(&mut self, file: &Path) {
+		self.files.find_file(file);
+	}
 }
 
 impl DrawableComponent for FilesTab {