[Diff] Refactor for Diff3, Git, and conflicts #4111

michaelblyons · 2024-12-07T21:37:33Z

Big refactor of Diff syntax according to the GNU and SVN documentation. New Git Diff syntax, also used by Git Log.

Thank you to the reviewers!

Notable changes

Lots of documentation links
Lots of new tests, mostly pulled from relevant documentation
Some scope tweaking, but preserving the stacking from [Diff] Make scopes consistent (backwards compatible) #2178 for backwards-compatibility
New syntax for Git Diff emails (git am and git format-patch)
- When the normal Diff syntax detects the "magic" first line, it delegates out to Git Diff instead.
New support for
- Diff3 formats
- Conflict sections
- "Combined" unified diffs, only in Git Diff

Potentially controversial

Conflicts somewhat with [Common] Add git conflict marker highlighting #4047, but should now be nearly compatible.
storage.modifier distinguishes between the two Git file modes (namely 644 and 755)
Markup scopes color the ++++---- and similar, even though they're not actually markup.
Users and emails are delegated out to Mailmap.
Whatever you noticed.

Also include their file modes [Diff] Change file mode highlighting [Diff] Loosen file mode match

Includes the Git Commit Message stuff, because that's what it is.

[Diff] Empty file hash

Technically, this is called the "signature."

jrappen · 2024-12-20T20:23:26Z

let us know when/if you need any review or feedback 😁

michaelblyons · 2024-12-20T22:55:50Z

let us know when/if you need any review or feedback 😁

Haha. Sorry if you're flooded in notifications. The PR is a lot better after you and DeathAxe's reviews. I think if you're looking for something, ~~check my PRs to this PR (michaelblyons#11 and michaelblyons#10) and~~ decide if you care about any of the things in the "controversial" heading in OP.

Thanks again.

deathaxe · 2024-12-22T12:52:19Z

Empty lines between contexts is ok, but starting arbritary emptly lines between patterns is too much.

michaelblyons · 2024-12-22T13:14:09Z

There are places where I have considered newlines in stacked scopes, but I am not planning to add an empty line between meta and includes. PackageDev scoping is sufficient to make that distinction very obvious.

This commit... 1. adds more detailed scopes to conflict markers 2. adds conflicting blocks to symbol list 3. removes some multi-push and lookaheads 4. adds support for indented fenced diff code blocks (allow markers to be preceded by whitespace)

Unfortunately, line ranges (which start at BOL) cannot be tested.

It causes odd behavior when BOL is changed to allow spaces

if you're already in the Git Diff syntax

michaelblyons · 2025-02-10T19:23:57Z

Git Formats/Git Diff.sublime-syntax

I loaded a patch from patchwork.kernel.org and I was surprised not to get the full highlighting. It did not have a "magic" date. If the more lenient git_first_line should be bumped to Diff (Basic), let me know.

deathaxe · 2025-02-10T19:37:48Z

Diff/Diff (Basic).sublime-syntax

+  git_first_line: |-
+    {{bol}}(?x:
+      From [ ] \w+@z [ ]
+      Thu [ ] Jan [ ]{2} 1 [ ] 00:00:00 [ ] 1970  # git-send-email
+    | From [ ] {{git_hash_full}} [ ]
+      Mon [ ] Sep [ ]   17 [ ] 00:00:00 [ ] 2001  # git-format-patch
+    )


How magic is the date? Are these really only those two days?

The git-format-patch one is listed in the documentation. The git-send-email one I saw live in a different document online (context at dandavison/delta#1863), but does not appear in docs.

It wasn't until today that I saw a random date that I think matches the commit date.

As docs explicitly state about those fixed dates as "magic number" to separate patches from normal mails, we should probably keep going with them as is.

Sounds reasonable to me. The only counter argument I have in favor of putting the variable in Diff (Basic) is that you're already in the Diff syntax. Is "in the Diff syntax" and "first line is MBOX style" enough of a heuristic to have the Git Diff highlighting activate?

I wouldn't want to loosen the first_line_match.

Not my every day use case. So it is hard to judge. If such patch files however use *.patch extension, I am uncertain about use of Git Diff specific git_first_line as file extensions are preferred for highlighting, so normal Diff would win.

It would only apply to patch files without file extensions.

So whatever headers should be supported, they seem useful only in Diff (Basic).

So whatever headers should be supported, they seem useful only in Diff (Basic).

Maybe you forget that Diff (Basic) does that thing where if you actually have a Git Diff, it sends to Git Diff syntax instead. I don't have a problem making the git_first_line variable more lenient in Diff (Basic).

I am a little wary of changing the first_line_match in case you (a) have no MBOX syntax, and (b) load an MBOX file. At this point, with a lenient first_line_match, one of the diff syntaxes would load and try to highlight as a Git Diff. This may not actually be a bad thing since it marks email headers, but could conceivably freak out for multi-email MBOX files.

But if Sublime Text has chosen Diff or Git Diff by file extension, I think it would be polite to load up the Git Diff variant if the first line loosely matches.

I am probably not the right one to finally judge that.

michaelblyons added 30 commits December 7, 2024 15:55

[Diff] Support alt mode for Git's "patch email"

06e3966

[Diff] Add special Git email headers

b4d9e96

[Diff] Add a Git --stat block

3cf1c25

[Diff] Add binary files to --stat block

108b072

[Diff] Add a Git --shortstat block

c2b04b3

[Diff] Add create/delete files to --shortstat

2aa8ec9

Also include their file modes [Diff] Change file mode highlighting [Diff] Loosen file mode match

[Diff] Add/Move test files

a365452

[Diff] Add context for email body with formatting

c6b3af1

Includes the Git Commit Message stuff, because that's what it is.

[Diff] Split to Git, other, and common contexts

b06d2d3

[Diff] Add Git binary patch format

ad29849

[Diff] Empty file hash

[Diff] Git file headings

bb16650

[Diff] Fully split Git-special vs generic diffs

d0e546b

[Diff] Tweak commit hash scope

e65528c

[Diff] Git diff end block

6c10828

Technically, this is called the "signature."

[Diff] Consolidate some variables

ee7ffbf

[Diff] File mode stuff

388d3f6

[Diff] Filename in git diff headers

e5cd833

[Diff] Refactor Git file header

7731589

[Diff] Move Git Diff to its own file !!!!!

1e88e63

[Diff] Add more Git email headers

1eca9ec

[Diff] Rename hash variables

8780272

[Diff] Bailout for no-stat Git diff

5610274

[Diff] Refactor Git deltas

f9960f6

[Diff] Git diff signature. More file headers.

50ed8bc

[Diff] Modify file header first line detection

11292ec

[Diff] Refactor pre-EOL pops

8902243

[Diff] Block contexts for diff header and content

72d8215

fixup executable file mode scope

938ef14

[Diff] Drop unnecessary context

660fb2e

[Diff] WIP skippable stat

32326aa

deathaxe and others added 3 commits December 19, 2024 09:41

[Diff] Scope diff --git line meta.function-call

15622fc

[Diff] Update twodot scope

98fa1f8

[Diff] Support multiline email headers

39a126a

michaelblyons force-pushed the diff/git-patch branch from 31a90d5 to 39a126a Compare December 19, 2024 18:32

[Diff] Rescope paths

3d631ec

This comment was marked as resolved.

Sign in to view

michaelblyons added 2 commits December 20, 2024 13:47

[Diff] Add missing scopes for copy/move/etc.

12066ad

[Diff] Git diff file header paths

3685f51

[Diff] Embed Git Diff from Git Log

4ee85d3

deathaxe previously approved these changes Dec 27, 2024

View reviewed changes

jrappen approved these changes Dec 28, 2024

View reviewed changes

michaelblyons changed the title ~~[Diff] Organize contexts, add tests, support Git patch emails~~ [Diff] Refactor for Diff3, Git, and conflicts Dec 28, 2024

[Diff] Improve conflict markers

03488bb

This commit... 1. adds more detailed scopes to conflict markers 2. adds conflicting blocks to symbol list 3. removes some multi-push and lookaheads 4. adds support for indented fenced diff code blocks (allow markers to be preceded by whitespace)

deathaxe dismissed their stale review via 03488bb January 9, 2025 17:32

deathaxe previously approved these changes Jan 9, 2025

View reviewed changes

[Diff] Add some symbol tests

3a03a92

Unfortunately, line ranges (which start at BOL) cannot be tested.

michaelblyons dismissed deathaxe’s stale review via 3a03a92 January 9, 2025 18:13

[Diff] Configure extensible BOL whitespace (#12)

4cce8fb

deathaxe previously approved these changes Jan 12, 2025

View reviewed changes

[Diff] Remove side-by-side mode

f3ad356

It causes odd behavior when BOL is changed to allow spaces

michaelblyons dismissed deathaxe’s stale review via f3ad356 January 28, 2025 21:51

deathaxe previously approved these changes Jan 29, 2025

View reviewed changes

[Diff] More lenient Git first line

5341c70

if you're already in the Git Diff syntax

michaelblyons dismissed deathaxe’s stale review via 5341c70 February 10, 2025 19:14

michaelblyons commented Feb 10, 2025

View reviewed changes

deathaxe reviewed Feb 10, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Diff] Refactor for Diff3, Git, and conflicts #4111

[Diff] Refactor for Diff3, Git, and conflicts #4111

michaelblyons commented Dec 7, 2024 •

edited

Loading

This comment was marked as resolved.

jrappen commented Dec 20, 2024

michaelblyons commented Dec 20, 2024 •

edited

Loading

deathaxe commented Dec 22, 2024

michaelblyons commented Dec 22, 2024

michaelblyons Feb 10, 2025

deathaxe Feb 10, 2025

michaelblyons Feb 10, 2025

deathaxe Feb 10, 2025

michaelblyons Feb 11, 2025 •

edited

Loading

deathaxe Feb 11, 2025

michaelblyons Feb 11, 2025

deathaxe Feb 12, 2025

[Diff] Refactor for Diff3, Git, and conflicts #4111

Are you sure you want to change the base?

[Diff] Refactor for Diff3, Git, and conflicts #4111

Conversation

michaelblyons commented Dec 7, 2024 • edited Loading

Notable changes

Potentially controversial

This comment was marked as resolved.

jrappen commented Dec 20, 2024

michaelblyons commented Dec 20, 2024 • edited Loading

deathaxe commented Dec 22, 2024

michaelblyons commented Dec 22, 2024

michaelblyons Feb 10, 2025

Choose a reason for hiding this comment

deathaxe Feb 10, 2025

Choose a reason for hiding this comment

michaelblyons Feb 10, 2025

Choose a reason for hiding this comment

deathaxe Feb 10, 2025

Choose a reason for hiding this comment

michaelblyons Feb 11, 2025 • edited Loading

Choose a reason for hiding this comment

deathaxe Feb 11, 2025

Choose a reason for hiding this comment

michaelblyons Feb 11, 2025

Choose a reason for hiding this comment

deathaxe Feb 12, 2025

Choose a reason for hiding this comment

michaelblyons commented Dec 7, 2024 •

edited

Loading

michaelblyons commented Dec 20, 2024 •

edited

Loading

michaelblyons Feb 11, 2025 •

edited

Loading