vaclavt/vdiff
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

stage action moves to next unstaged file (there is setting to turn this off)

Browse Source
This commit is contained in:
Vaclav Tvrdik
2026-09-25 09:35:49 +02:00
parent 57476e78dc
commit 0655d3b74a
4 changed files with 145 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -18,7 +18,7 @@ Keys inside the review view:
| key | action |
|---|---|
| `f` / `c` | changed files / recent commits panel |
| `s` / `u` / `d` | stage / unstage / discard the file (uncommitted mode) |
| `s` / `u` / `d` | stage / unstage / discard the file (uncommitted mode); `s` then moves on to the next unstaged file |
| `C` or `m` | commit the staged files, typing the message in an input panel |
| `o` or Enter | open the real file at this line |
| `]` / `[` | next / previous change (wraps at the ends) |

125
tests/test_commands.py
View File

@@ -2,17 +2,37 @@ import pytest
import sublime # the stub, via conftest
from vdiff import commands, git, state
from vdiff import commands, git, state, utils
def change(path, status="M"):
return git.FileChange(path, status, False, 1, 1, None)
def flagged(*flags):
"""f0.py, f1.py ... with the given staged flags"""
return [git.FileChange("f{}.py".format(i), "M", flag, 1, 1, None) for i, flag in enumerate(flags)]
def option(monkeypatch, name, value):
"""Set a plugin setting for one test; the stub hands out one Settings dict per file"""
monkeypatch.setitem(sublime.load_settings(utils.SETTINGS_FILE), name, value)
def flush_previews():
"""The stub runs set_timeout synchronously, so previews are already shown"""
def at_change(blocks, row):
"""A rendered view with `blocks` as its changes and the caret on `row`"""
view = sublime.View()
st = state.ViewState("/repo")
st.blocks = blocks
view.text = "\n" + "\n".join("l{}".format(i) for i in range(20))
view.sel().add(sublime.Region(commands.render.index_point(view, row)))
return view, st
def test_esc_restores_previous_file_and_mode(monkeypatch):
shown = []
monkeypatch.setattr(commands, "show_file", lambda view, st, c: shown.append((st.sha, c.path)))
@@ -83,18 +103,15 @@ def test_on_cancel_goes_back_to_commit_list(monkeypatch):
assert back == [1] and st.sha is None
def test_step_change_uses_blocks():
view = sublime.View()
st = state.ViewState("/repo")
st.blocks = [(2, 4), (7, 8)]
view.text = "\n" + "\n".join("l{}".format(i) for i in range(10))
view.sel().add(sublime.Region(commands.render.index_point(view, 0)))
def test_step_change_uses_blocks(rings):
view, st = at_change([(2, 4), (7, 8)], 0)
commands.ACTIONS["next_change"](view, None, st)
assert commands.render.caret_index(view) == 2
commands.ACTIONS["next_change"](view, None, st)
assert commands.render.caret_index(view) == 7
commands.ACTIONS["prev_change"](view, None, st)
assert commands.render.caret_index(view) == 2
# stepping inside the list stays silent
assert commands.render.caret_index(view) == 2 and rings == []
def test_file_items_annotations():
@@ -151,7 +168,7 @@ def test_j_and_k_move_the_caret_one_line():
def staged_state(*flags):
st = state.ViewState("/repo")
st.files = [git.FileChange("f{}.py".format(i), "M", flag, 1, 1, None) for i, flag in enumerate(flags)]
st.files = flagged(*flags)
return st
@@ -273,7 +290,7 @@ def commit_panel(files):
def numbered(count=5):
return [git.FileChange("f{}.py".format(i), "M", False, 1, 1, None) for i in range(count)]
return flagged(*(False,) * count)
def requested_path(queue):
@@ -405,16 +422,6 @@ def test_first_step_without_a_shown_file_picks_an_end(loading, rings):
assert rings == []
def at_change(blocks, row):
"""A rendered view with `blocks` as its changes and the caret on `row`"""
view = sublime.View()
st = state.ViewState("/repo")
st.blocks = blocks
view.text = "\n" + "\n".join("l{}".format(i) for i in range(20))
view.sel().add(sublime.Region(commands.render.index_point(view, row)))
return view, st
def test_next_change_wraps_past_the_last(rings):
view, st = at_change([(2, 4), (7, 8)], 7)
@@ -429,14 +436,6 @@ def test_prev_change_wraps_before_the_first(rings):
assert commands.render.caret_index(view) == 7 and len(rings) == 1
def test_stepping_inside_the_changes_does_not_ring(rings):
view, st = at_change([(2, 4), (7, 8), (12, 13)], 7)
commands.ACTIONS["next_change"](view, None, st)
commands.ACTIONS["prev_change"](view, None, st)
assert commands.render.caret_index(view) == 7 and rings == []
def test_single_change_rings_and_stays_put(rings):
view, st = at_change([(2, 4)], 2)
@@ -449,5 +448,73 @@ def test_a_file_without_changes_neither_moves_nor_rings(rings):
view, st = at_change([], 3)
commands.ACTIONS["next_change"](view, None, st)
commands.ACTIONS["prev_change"](view, None, st)
assert commands.render.caret_index(view) == 3 and rings == []
# --- staging moves on to the next unstaged file -----------------------------
def press(monkeypatch, action, before, path, after):
"""Run `action` on `path` of `before`; git then reports `after`. Returns the paths shown
ACTIONS captured git.stage and friends when the table was built, so the subprocess is stubbed
one level down, at git.run; that keeps the real wiring of the action under test.
"""
shown = []
monkeypatch.setattr(commands.git, "run", lambda repo, args, ok_codes=(0,): "")
monkeypatch.setattr(commands.git, "changed_files", lambda repo: after)
monkeypatch.setattr(commands, "show_file", lambda view, st, c: shown.append(c.path))
view, window, st = at_file(before, path)
commands.ACTIONS[action](view, window, st)
return shown
def test_next_unstaged_scans_forward_and_wraps():
files = flagged(False, True, False, True)
assert commands._next_unstaged(files, 1) == 2
assert commands._next_unstaged(files, 2) == 2 # the slot we count from counts itself
assert commands._next_unstaged(files, 3) == 0 # wraps past the end
assert commands._next_unstaged(flagged(True, True), 0) == -1
def test_staging_moves_to_the_next_unstaged_file(monkeypatch):
shown = press(monkeypatch, "stage", flagged(True, False, True, False), "f1.py", flagged(True, True, True, False))
assert shown == ["f3.py"]
def test_staging_wraps_to_an_unstaged_file_above(monkeypatch):
shown = press(monkeypatch, "stage", flagged(False, True, False), "f2.py", flagged(False, True, True))
assert shown == ["f0.py"]
def test_staging_the_last_unstaged_file_stays_put(monkeypatch):
shown = press(monkeypatch, "stage", flagged(True, False), "f1.py", flagged(True, True))
assert shown == ["f1.py"]
def test_staging_a_file_that_leaves_the_list_counts_from_its_slot(monkeypatch):
# staging can make the entry vanish (the change was identical to HEAD); f2.py takes the slot
before = flagged(True, False, False)
after = [before[0], before[2]]
shown = press(monkeypatch, "stage", before, "f1.py", after)
assert shown == ["f2.py"]
def test_staging_does_not_move_when_the_option_is_off(monkeypatch):
option(monkeypatch, "stage_and_move_next_file", False)
shown = press(monkeypatch, "stage", flagged(True, False, False), "f1.py", flagged(True, True, False))
assert shown == ["f1.py"]
def test_unstage_and_discard_do_not_move(monkeypatch):
option(monkeypatch, "confirm_discard", False)
files = flagged(True, True, False)
assert press(monkeypatch, "unstage", files, "f1.py", flagged(True, False, False)) == ["f1.py"]
assert press(monkeypatch, "discard", files, "f1.py", flagged(True, False, False)) == ["f1.py"]
def test_staging_the_only_file_leaves_an_empty_listing(monkeypatch):
messages = []
monkeypatch.setattr(commands.render, "render_message", lambda view, st, text: messages.append(text))
assert press(monkeypatch, "stage", flagged(False), "f0.py", []) == []
assert messages == ["No uncommitted changes in /repo"]

3
vDiff.sublime-settings
View File

@@ -5,6 +5,9 @@
// ask before discarding a file's changes
"confirm_discard": true,
// after staging a file, move on to the next unstaged file of the list
"stage_and_move_next_file": true,
// mark the changed characters inside paired deleted/inserted lines
"word_diff": true,

61
vdiff/commands.py
View File

@@ -176,8 +176,12 @@ def show_files_panel(window, view, st, files, kept, on_cancel=None, placeholder=
window.show_quick_panel(file_items(files), on_select, 0, selected, on_highlight, placeholder)
def refresh_listing(view, st, message=None):
"""Re-list the working tree changes and show the same file, or the next one when it is gone"""
def refresh_listing(view, st, message=None, pick=None):
"""Re-list the working tree changes and show the same file, or the next one when it is gone
`pick(files, index)` may name another file to show instead; `index` is where the shown file
sits in the new list, or the slot it left behind when it is gone.
"""
if message:
status(message)
previous_index = max(0, st.index())
@@ -187,13 +191,15 @@ def refresh_listing(view, st, message=None):
if not view.is_valid():
return
st.files = files
index = state.find_change(files, path)
if index >= 0:
show_file(view, st, files[index])
elif files:
show_file(view, st, files[min(previous_index, len(files) - 1)])
else:
if not files:
render.render_message(view, st, "No uncommitted changes in {}".format(st.repo))
return
index = state.find_change(files, path)
if index < 0:
# the file left the list: whatever moved up into its slot takes over
index = min(previous_index, len(files) - 1)
chosen = pick(files, index) if pick else None
show_file(view, st, chosen if chosen is not None else files[index])
run_async(lambda: git.changed_files(st.repo), done)
@@ -307,8 +313,11 @@ def _act_help(view, window, st):
render.show_help(view, st)
def _git_action(verb, done_verb, operation, confirm=None):
"""Action running `operation(repo, change)` on the shown working-tree file, then re-listing"""
def _git_action(verb, done_verb, operation, confirm=None, pick=None):
"""Action running `operation(repo, change)` on the shown working-tree file, then re-listing
`pick` is handed to refresh_listing to choose which file to show afterwards.
"""
def act(view, window, st):
if st.in_commit or st.change is None:
@@ -317,7 +326,10 @@ def _git_action(verb, done_verb, operation, confirm=None):
change = st.change
if confirm is not None and not confirm(change):
return
run_async(lambda: operation(st.repo, change), lambda _: refresh_listing(view, st, "{} {}".format(done_verb, change.path)))
run_async(
lambda: operation(st.repo, change),
lambda _: refresh_listing(view, st, "{} {}".format(done_verb, change.path), pick=pick),
)
return act
@@ -334,6 +346,24 @@ def _confirm_discard(change):
return sublime.ok_cancel_dialog(message, "Discard")
def _next_unstaged(files, start):
"""Index of the first unstaged file from `start` on, wrapping round; -1 when every file is staged"""
for offset in range(len(files)):
index = (start + offset) % len(files)
if not files[index].staged:
return index
return -1
def _stage_next(files, index):
"""After staging, the next unstaged file to show; None keeps the file the refresh would show"""
if not settings().get("stage_and_move_next_file", True):
return None
# the file just staged is staged now, so a scan starting on it moves off by itself
following = _next_unstaged(files, index)
return files[following] if following >= 0 else None
def _act_refresh(view, window, st):
if st.change is None:
return
@@ -381,14 +411,13 @@ def _step_change(delta):
def act(view, window, st):
starts = [start for start, _ in st.blocks]
if not starts:
status("no changes")
status("no changes to step through")
return
row = render.caret_index(view)
position = bisect.bisect_right(starts, row) if delta > 0 else bisect.bisect_left(starts, row) - 1
wrapped = not 0 <= position < len(starts)
position %= len(starts) # -1 is the last change, len(starts) the first
if wrapped:
if not 0 <= position < len(starts):
render.flash(view)
position %= len(starts) # -1 is the last change, len(starts) the first
point = render.index_point(view, starts[position])
view.sel().clear()
view.sel().add(sublime.Region(point))
@@ -432,7 +461,7 @@ ACTIONS = {
"commits": _act_commits,
"close": _act_close,
"help": _act_help,
"stage": _git_action("stage", "staged", git.stage),
"stage": _git_action("stage", "staged", git.stage, pick=_stage_next),
"unstage": _git_action("unstage", "unstaged", git.unstage),
"discard": _git_action("discard", "discarded", git.discard, confirm=_confirm_discard),
"commit": _act_commit,