Add Modified Line exec command feature

This adds an optional feature, where a exec command is injected with the
provided script after every modified line.

Author: MitMaro

CHANGELOG.md

@@ -3,6 +3,11 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## [Unreleased]
+### Added
+- Post modified line exec command ([#888](https://github.com/MitMaro/git-interactive-rebase-tool/pull/888))
+
+
 ## [2.3.0] - 2023-07-19
 ### Added
 - Support for update-ref action ([#801](https://github.com/MitMaro/git-interactive-rebase-tool/pull/801))

README.md

@@ -76,6 +76,53 @@ Need to do something in your Git editor? Quickly shell out to your editor, make
 
 ![Shell out to editor](/docs/assets/images/girt-external-editor.gif?raw=true)
 
+### Advanced Features
+
+#### Modified line exec command
+
+This optional feature allows for the injection of an `exec` action after modified lines, where modified is determined as a changed action, command, or reference. This can be used to amend commits to update references in the commit message or run a test suite only on modified commits.
+
+To enable this option, set the `interactive-rebase-tool.postModifiedLineExecCommand` option, providing an executable or script.
+
+```shell
+git config --global interactive-rebase-tool.postModifiedLineExecCommand "/path/to/global/script"
+```
+
+Or using repository-specific configuration, for targeted scripts.
+
+```shell
+git config --global interactive-rebase-tool.postModifiedLineExecCommand "/path/to/repo/script"
+```
+
+The first argument provided to the script will always be the action performed. Then, depending on the action, the script will be provided a different set of arguments.
+
+For `drop`, `fixup`, `edit`, `pick`, `reword` and `squash` actions, the script will additionally receive the original commit hash, for `exec` the original and new commands are provided, and for `label`, `reset`, `merge`, and `update-ref` the original label/reference and new label/reference are provided.
+
+Full example of a resulting rebase todo file, assuming that `interactive-rebase-tool.postModifiedLineExecCommand` was set to `script.sh`.
+
+```
+# original line: label onto
+label new-onto
+exec script.sh "label" "onto" "new-onto"
+
+# original line: reset onto
+reset new-onto
+exec script.sh "reset" "onto" "new-onto"
+
+pick   a12345 My feature
+# original line: pick b12345 My change
+squash b12345 My change
+exec script.sh "squash" "b12345"
+
+# original line: label branch
+label branch
+exec script.sh "label" "branch" "new-branch"
+
+# original line: exec command
+exec new-command
+exec script.sh "exec" "command" "new-command"
+```
+
 ## Setup
 
 ### Most systems

readme/customization.md

@@ -39,17 +39,18 @@ Some values from your Git Config are directly used by this application.
 
 ## General
 
-| Key                        | Default | Type    | Description                                                                                 |
-|----------------------------|---------|---------|---------------------------------------------------------------------------------------------|
-| `autoSelectNext`           | false   | bool    | If true, auto select the next line after action modification                                |
-| `diffIgnoreBlankLines`     | none    | String¹ | If to ignore blank lines during diff.                                                       |
-| `diffIgnoreWhitespace`     | none    | String¹ | If and how to ignore whitespace during diff.                                                |
-| `diffShowWhitespace`       | both    | String² | If and how to show whitespace during diff.                                                  |
-| `diffSpaceSymbol`          | ·       | String  | The visible symbol for the space character. Only used when `diffShowWhitespace` is enabled. |
-| `diffTabSymbol`            | →       | String  | The visible symbol for the tab character. Only used when `diffShowWhitespace` is enabled.   |
-| `diffTabWidth`             | 4       | Integer | The width of the tab character                                                              |
-| `undoLimit`                | 5000    | Integer | Number of undo operations to store.                                                         |
-| `verticalSpacingCharacter` | ~       | String  | Vertical spacing character. Can be set to an empty string.                                  |
+| Key                           | Default | Type    | Description                                                                                 |
+|-------------------------------|---------|---------|---------------------------------------------------------------------------------------------|
+| `autoSelectNext`              | false   | bool    | If true, auto select the next line after action modification                                |
+| `diffIgnoreBlankLines`        | none    | String¹ | If to ignore blank lines during diff.                                                       |
+| `diffIgnoreWhitespace`        | none    | String¹ | If and how to ignore whitespace during diff.                                                |
+| `diffShowWhitespace`          | both    | String² | If and how to show whitespace during diff.                                                  |
+| `diffSpaceSymbol`             | ·       | String  | The visible symbol for the space character. Only used when `diffShowWhitespace` is enabled. |
+| `diffTabSymbol`               | →       | String  | The visible symbol for the tab character. Only used when `diffShowWhitespace` is enabled.   |
+| `diffTabWidth`                | 4       | Integer | The width of the tab character                                                              |
+| `undoLimit`                   | 5000    | Integer | Number of undo operations to store.                                                         |
+| `postModifiedLineExecCommand` |         | String  | Exec command to attach to modified lines. See [modified line exec command] for details.     |
+| `verticalSpacingCharacter`    | ~       | String  | Vertical spacing character. Can be set to an empty string.                                  |
 
 ¹ Ignore whitespace can be:
 - `change` to ignore changed whitespace in diffs, same as the [`--ignore-space-change`][diffIgnoreSpaceChange] flag
@@ -62,6 +63,7 @@ Some values from your Git Config are directly used by this application.
 - `true`, `on` or `both` to show both leading and trailing whitespace
 - `false`, `off`, `none` to show no whitespace
 
+[modified line exec command]:../README.md#modified-line-exec-command
 [diffIgnoreSpaceChange]:https://git-scm.com/docs/git-diff#Documentation/git-diff.txt---ignore-space-change
 [diffIgnoreAllSpace]:https://git-scm.com/docs/git-diff#Documentation/git-diff.txt---ignore-all-space
 

src/config/src/lib.rs

@@ -162,7 +162,10 @@ pub use self::{
 	key_bindings::KeyBindings,
 	theme::Theme,
 };
-use crate::errors::{ConfigError, ConfigErrorCause};
+use crate::{
+	errors::{ConfigError, ConfigErrorCause},
+	utils::get_optional_string,
+};
 
 const DEFAULT_SPACE_SYMBOL: &str = "\u{b7}"; // ·
 const DEFAULT_TAB_SYMBOL: &str = "\u{2192}"; // →
@@ -185,6 +188,8 @@ pub struct Config {
 	pub diff_tab_symbol: String,
 	/// The display width of the tab character.
 	pub diff_tab_width: u32,
+	/// If set, automatically add an exec line with the command after every modified line
+	pub post_modified_line_exec_command: Option<String>,
 	/// The maximum number of undo steps.
 	pub undo_limit: u32,
 	/// Configuration options loaded directly from Git.
@@ -221,6 +226,10 @@ impl Config {
 			diff_tab_symbol: get_string(git_config, "interactive-rebase-tool.diffTabSymbol", DEFAULT_TAB_SYMBOL)?,
 			diff_tab_width: get_unsigned_integer(git_config, "interactive-rebase-tool.diffTabWidth", 4)?,
 			undo_limit: get_unsigned_integer(git_config, "interactive-rebase-tool.undoLimit", 5000)?,
+			post_modified_line_exec_command: get_optional_string(
+				git_config,
+				"interactive-rebase-tool.postModifiedLineExecCommand",
+			)?,
 			git: GitConfig::new_with_config(git_config)?,
 			key_bindings: KeyBindings::new_with_config(git_config)?,
 			theme: Theme::new_with_config(git_config)?,
@@ -435,7 +444,6 @@ mod tests {
 	#[case::diff_tab_width("diffTabWidth", "42", 42, |config: Config| config.diff_tab_width)]
 	#[case::diff_tab_symbol_default("diffTabSymbol", "", String::from("→"), |config: Config| config.diff_tab_symbol)]
 	#[case::diff_tab_symbol("diffTabSymbol", "|", String::from("|"), |config: Config| config.diff_tab_symbol)]
-	#[case::diff_tab_symbol("diffTabSymbol", "|", String::from("|"), |config: Config| config.diff_tab_symbol)]
 	#[case::diff_space_symbol_default(
 		"diffSpaceSymbol",
 		"",
@@ -444,8 +452,20 @@ mod tests {
 	]
 	#[case::diff_space_symbol("diffSpaceSymbol", "-", String::from("-"), |config: Config| config.diff_space_symbol)]
 	#[case::undo_limit_default("undoLimit", "", 5000, |config: Config| config.undo_limit)]
-	#[case::undo_limit_default("undoLimit", "42", 42, |config: Config| config.undo_limit)]
-	pub(crate) fn theme_color<F, T>(
+	#[case::undo_limit("undoLimit", "42", 42, |config: Config| config.undo_limit)]
+	#[case::post_modified_line_exec_command(
+		"postModifiedLineExecCommand",
+		"command",
+		Some(String::from("command")),
+		|config: Config| config.post_modified_line_exec_command
+	)]
+	#[case::post_modified_line_exec_command_default(
+		"postModifiedLineExecCommand",
+		"",
+		None,
+		|config: Config| config.post_modified_line_exec_command
+	)]
+	pub(crate) fn config_test<F, T>(
 		#[case] config_name: &str,
 		#[case] config_value: &str,
 		#[case] expected: T,
@@ -497,9 +517,10 @@ mod tests {
 
 	#[rstest]
 	#[case::diff_tab_symbol("diffIgnoreWhitespace")]
-	#[case::diff_tab_symbol("diffShowWhitespace")]
+	#[case::diff_show_whitespace("diffShowWhitespace")]
 	#[case::diff_tab_symbol("diffTabSymbol")]
 	#[case::diff_space_symbol("diffSpaceSymbol")]
+	#[case::post_modified_line_exec_command("postModifiedLineExecCommand")]
 	fn value_parsing_invalid_utf(#[case] config_name: &str) {
 		with_git_config(
 			&[

src/config/src/theme.rs

@@ -2,13 +2,13 @@ use git::Config;
 
 use crate::{
 	errors::ConfigError,
-	utils::{_get_string, get_string},
+	utils::{get_optional_string, get_string},
 	Color,
 	ConfigErrorCause,
 };
 
 fn get_color(config: Option<&Config>, name: &str, default: Color) -> Result<Color, ConfigError> {
-	if let Some(value) = _get_string(config, name)? {
+	if let Some(value) = get_optional_string(config, name)? {
 		Color::try_from(value.to_lowercase().as_str()).map_err(|invalid_color_error| {
 			ConfigError::new(
 				name,

src/config/src/utils/get_bool.rs

@@ -1,6 +1,6 @@
 use git::{Config, ErrorCode};
 
-use crate::{utils::_get_string, ConfigError, ConfigErrorCause};
+use crate::{utils::get_optional_string, ConfigError, ConfigErrorCause};
 
 pub(crate) fn get_bool(config: Option<&Config>, name: &str, default: bool) -> Result<bool, ConfigError> {
 	if let Some(cfg) = config {
@@ -10,14 +10,14 @@ pub(crate) fn get_bool(config: Option<&Config>, name: &str, default: bool) -> Re
 			Err(e) if e.message().contains("failed to parse") => {
 				Err(ConfigError::new_with_optional_input(
 					name,
-					_get_string(config, name).ok().flatten(),
+					get_optional_string(config, name).ok().flatten(),
 					ConfigErrorCause::InvalidBoolean,
 				))
 			},
 			Err(e) => {
 				Err(ConfigError::new_with_optional_input(
 					name,
-					_get_string(config, name).ok().flatten(),
+					get_optional_string(config, name).ok().flatten(),
 					ConfigErrorCause::UnknownError(String::from(e.message())),
 				))
 			},

src/config/src/utils/get_string.rs

@@ -2,7 +2,7 @@ use git::{Config, ErrorCode};
 
 use crate::{ConfigError, ConfigErrorCause};
 
-pub(crate) fn _get_string(config: Option<&Config>, name: &str) -> Result<Option<String>, ConfigError> {
+pub(crate) fn get_optional_string(config: Option<&Config>, name: &str) -> Result<Option<String>, ConfigError> {
 	let Some(cfg) = config
 	else {
 		return Ok(None);
@@ -24,7 +24,7 @@ pub(crate) fn _get_string(config: Option<&Config>, name: &str) -> Result<Option<
 }
 
 pub(crate) fn get_string(config: Option<&Config>, name: &str, default: &str) -> Result<String, ConfigError> {
-	Ok(_get_string(config, name)?.unwrap_or_else(|| String::from(default)))
+	Ok(get_optional_string(config, name)?.unwrap_or_else(|| String::from(default)))
 }
 
 #[cfg(test)]

src/config/src/utils/get_unsigned_integer.rs

@@ -1,6 +1,6 @@
 use git::{Config, ErrorCode};
 
-use crate::{utils::_get_string, ConfigError, ConfigErrorCause};
+use crate::{utils::get_optional_string, ConfigError, ConfigErrorCause};
 
 pub(crate) fn get_unsigned_integer(config: Option<&Config>, name: &str, default: u32) -> Result<u32, ConfigError> {
 	if let Some(cfg) = config {
@@ -9,7 +9,7 @@ pub(crate) fn get_unsigned_integer(config: Option<&Config>, name: &str, default:
 				v.try_into().map_err(|_| {
 					ConfigError::new_with_optional_input(
 						name,
-						_get_string(config, name).ok().flatten(),
+						get_optional_string(config, name).ok().flatten(),
 						ConfigErrorCause::InvalidUnsignedInteger,
 					)
 				})
@@ -18,14 +18,14 @@ pub(crate) fn get_unsigned_integer(config: Option<&Config>, name: &str, default:
 			Err(e) if e.message().contains("failed to parse") => {
 				Err(ConfigError::new_with_optional_input(
 					name,
-					_get_string(config, name).ok().flatten(),
+					get_optional_string(config, name).ok().flatten(),
 					ConfigErrorCause::InvalidUnsignedInteger,
 				))
 			},
 			Err(e) => {
 				Err(ConfigError::new_with_optional_input(
 					name,
-					_get_string(config, name).ok().flatten(),
+					get_optional_string(config, name).ok().flatten(),
 					ConfigErrorCause::UnknownError(String::from(e.message())),
 				))
 			},

src/config/src/utils/mod.rs

@@ -12,6 +12,6 @@ pub(crate) use self::{
 	get_diff_rename::git_diff_renames,
 	get_diff_show_whitespace::get_diff_show_whitespace,
 	get_input::get_input,
-	get_string::{_get_string, get_string},
+	get_string::{get_optional_string, get_string},
 	get_unsigned_integer::get_unsigned_integer,
 };

src/core/src/application.rs

@@ -152,11 +152,16 @@ where ModuleProvider: module::ModuleProvider + Send + 'static
 		Config::try_from(repo).map_err(|err| Exit::new(ExitStatus::ConfigError, format!("{err:#}").as_str()))
 	}
 
+	fn todo_file_options(config: &Config) -> TodoFileOptions {
+		let mut todo_file_options = TodoFileOptions::new(config.undo_limit, config.git.comment_char.as_str());
+		if let Some(command) = config.post_modified_line_exec_command.as_deref() {
+			todo_file_options.line_changed_command(command);
+		}
+		todo_file_options
+	}
+
 	fn load_todo_file(filepath: &str, config: &Config) -> Result<TodoFile, Exit> {
-		let mut todo_file = TodoFile::new(
-			filepath,
-			TodoFileOptions::new(config.undo_limit, config.git.comment_char.as_str()),
-		);
+		let mut todo_file = TodoFile::new(filepath, Self::todo_file_options(config));
 		todo_file
 			.load_file()
 			.map_err(|err| Exit::new(ExitStatus::FileReadError, err.to_string().as_str()))?;
@@ -187,7 +192,7 @@ where ModuleProvider: module::ModuleProvider + Send + 'static
 mod tests {
 	use std::ffi::OsString;
 
-	use claims::assert_ok;
+	use claims::{assert_none, assert_ok};
 	use display::{testutil::CrossTerm, Size};
 	use input::{KeyCode, KeyEvent, KeyModifiers};
 	use runtime::{Installer, RuntimeError};
@@ -264,6 +269,36 @@ mod tests {
 		assert_eq!(exit.get_status(), &ExitStatus::ConfigError);
 	}
 
+	#[test]
+	fn todo_file_options_without_command() {
+		let mut config = Config::new();
+		config.undo_limit = 10;
+		config.git.comment_char = String::from("#");
+		config.post_modified_line_exec_command = None;
+
+		let expected = TodoFileOptions::new(10, "#");
+		assert_eq!(
+			Application::<TestModuleProvider<DefaultTestModule>>::todo_file_options(&config),
+			expected
+		);
+	}
+
+	#[test]
+	fn todo_file_options_with_command() {
+		let mut config = Config::new();
+		config.undo_limit = 10;
+		config.git.comment_char = String::from("#");
+		config.post_modified_line_exec_command = Some(String::from("command"));
+
+		let mut expected = TodoFileOptions::new(10, "#");
+		expected.line_changed_command("command");
+
+		assert_eq!(
+			Application::<TestModuleProvider<DefaultTestModule>>::todo_file_options(&config),
+			expected
+		);
+	}
+
 	#[test]
 	#[serial_test::serial]
 	fn load_todo_file_load_error() {