Goto current line when opening internal text editor (#11191)

Goto currently selected line in diff/tree/commit editor, when opening the internal editor (e.g. with F4).
gitextensions · Sep 5, 2023 · 6a64d95 · 6a64d95
1 parent ee050a5
commit 6a64d95
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 11 deletions.
diff --git a/GitUI/CommandsDialogs/FormCommit.cs b/GitUI/CommandsDialogs/FormCommit.cs
@@ -2717,8 +2717,7 @@ private void editFileToolStripMenuItem_Click(object sender, EventArgs e)
                 return;
             }
 
-            UICommands.StartFileEditorDialog(fileName);
-
+            UICommands.StartFileEditorDialog(fileName, lineNumber: SelectedDiff.CurrentFileLine);
             UnstagedSelectionChanged(this, EventArgs.Empty);
         }
 

diff --git a/GitUI/CommandsDialogs/FormEditor.cs b/GitUI/CommandsDialogs/FormEditor.cs
@@ -22,7 +22,7 @@ private FormEditor()
             InitializeComponent();
         }
 
-        public FormEditor(GitUICommands commands, string? fileName, bool showWarning, bool readOnly = false)
+        public FormEditor(GitUICommands commands, string? fileName, bool showWarning, bool readOnly = false, int? lineNumber = null)
             : base(commands)
         {
             _fileName = fileName;
@@ -34,7 +34,7 @@ public FormEditor(GitUICommands commands, string? fileName, bool showWarning, bo
             // for translation form
             if (_fileName is not null)
             {
-                OpenFile(_fileName);
+                OpenFile(_fileName, lineNumber);
             }
 
             fileViewer.TextChanged += (s, e) => HasChanges = true;
@@ -54,11 +54,11 @@ private bool HasChanges
             }
         }
 
-        private void OpenFile(string fileName)
+        private void OpenFile(string fileName, int? line = null)
         {
             try
             {
-                fileViewer.ViewFileAsync(fileName);
+                fileViewer.ViewFileAsync(fileName, line: line);
                 fileViewer.IsReadOnly = false;
                 Text = fileName;
 

diff --git a/GitUI/CommandsDialogs/RevisionDiffControl.cs b/GitUI/CommandsDialogs/RevisionDiffControl.cs
@@ -993,8 +993,9 @@ private void diffEditWorkingDirectoryFileToolStripMenuItem_Click(object sender,
                 return;
             }
 
-            var fileName = _fullPathResolver.Resolve(DiffFiles.SelectedItem.Item.Name);
-            UICommands.StartFileEditorDialog(fileName);
+            string? fileName = _fullPathResolver.Resolve(DiffFiles.SelectedItem.Item.Name);
+            int? lineNumber = BlameControl.Visible ? BlameControl.CurrentFileLine : DiffText.CurrentFileLine;
+            UICommands.StartFileEditorDialog(fileName, lineNumber: lineNumber);
             RequestRefresh();
         }
 

diff --git a/GitUI/CommandsDialogs/RevisionFileTreeControl.cs b/GitUI/CommandsDialogs/RevisionFileTreeControl.cs
@@ -614,7 +614,8 @@ private void editCheckedOutFileToolStripMenuItem_Click(object sender, EventArgs
 
             var fileName = _fullPathResolver.Resolve(gitItem.FileName);
             Validates.NotNull(fileName);
-            UICommands.StartFileEditorDialog(fileName);
+            int? lineNumber = BlameControl.Visible ? BlameControl.CurrentFileLine : FileText.CurrentFileLine;
+            UICommands.StartFileEditorDialog(fileName, lineNumber: lineNumber);
             _refreshGitStatus?.Invoke();
         }
 

diff --git a/GitUI/GitUICommands.cs b/GitUI/GitUICommands.cs
@@ -1684,9 +1684,9 @@ private bool RunRebaseCommand(IReadOnlyDictionary<string, string?> arguments)
             return StartRebaseDialog(owner: null, onto: branch);
         }
 
-        public bool StartFileEditorDialog(string? filename, bool showWarning = false)
+        public bool StartFileEditorDialog(string? filename, bool showWarning = false, int? lineNumber = null)
         {
-            using FormEditor formEditor = new(this, filename, showWarning);
+            using FormEditor formEditor = new(this, filename, showWarning, lineNumber: lineNumber);
             return formEditor.ShowDialog() != DialogResult.Cancel;
         }
 

diff --git a/IntegrationTests/UI.IntegrationTests/CommandsDialogs/FormEditorTests.cs b/IntegrationTests/UI.IntegrationTests/CommandsDialogs/FormEditorTests.cs
@@ -64,6 +64,46 @@ public void HasChanges_updated_correctly()
             }
         }
 
+        [Test]
+        public void Should_set_linenumber_correctly()
+        {
+            string filePath = Path.Combine(_referenceRepository.Module.WorkingDir, Path.GetRandomFileName());
+
+            try
+            {
+                const int lineNumerDefault = 2;
+                File.WriteAllText(filePath, "Hello↔world\nline2\nline3\n\n\n", _commands.Module.FilesEncoding);
+
+                UITest.RunForm<FormEditor>(
+                    () =>
+                    {
+                        using FormEditor formEditor = new(_commands, filePath, showWarning: false, lineNumber: lineNumerDefault);
+                        formEditor.ShowDialog();
+                    },
+                    form =>
+                    {
+                        Assert.False(form.GetTestAccessor().HasChanges);
+
+                        var fileViewerInternal = form.GetTestAccessor().FileViewer.GetTestAccessor().FileViewerInternal;
+                        fileViewerInternal.SetText(fileViewerInternal.GetText() + "!", openWithDifftool: null, isDiff: false);
+
+                        Assert.True(form.GetTestAccessor().HasChanges);
+
+                        form.GetTestAccessor().SaveChanges();
+
+                        Assert.False(form.GetTestAccessor().HasChanges);
+
+                        Assert.AreEqual(lineNumerDefault, fileViewerInternal.CurrentFileLine(false));
+
+                        return Task.CompletedTask;
+                    });
+            }
+            finally
+            {
+                File.Delete(filePath);
+            }
+        }
+
         [Ignore("Unstable UTF8EncodingSealed result")]
         [Test]
         public void Should_preserve_encoding_utf8()