Strip trailing newlines

Keluaa · Apr 1, 2024 · 48ecd70 · 48ecd70
1 parent bf0ff93
commit 48ecd70
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -22,7 +22,6 @@ top:                                   ┃ top:
   ret i64 %1                          ⟪╋⟫  ret i64 %2
                                        ┣⟫  %1 = sext i8 %0 to i64
 }                                      ┃ }
-                                       ┃
 
 julia> f2(a) = a - 1
 f2 (generic function with 1 method)
@@ -33,7 +32,6 @@ top:                                   ┃ top:
   %1 = add i64 %0, 1                  ⟪╋⟫  %1 = add i64 %0, -1
   ret i64 %1                           ┃   ret i64 %1
 }                                      ┃ }
-                                       ┃
 ```
 
 ## Supported languages

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -29,7 +29,6 @@ top:                                   ┃ top:
   ret i64 %1                          ⟪╋⟫  ret i64 %2
                                        ┣⟫  %1 = sext i8 %0 to i64
 }                                      ┃ }
-                                       ┃
 
 julia> f2(a) = a - 1
 f2 (generic function with 1 method)
@@ -40,7 +39,6 @@ top:                                   ┃ top:
   %1 = add i64 %0, 1                  ⟪╋⟫  %1 = add i64 %0, -1
   ret i64 %1                           ┃   ret i64 %1
 }                                      ┃ }
-                                       ┃
 ```
 
 Setting the environment variable `"CODE_DIFFS_LINE_NUMBERS"` to `true` will display line

diff --git a/src/compare.jl b/src/compare.jl
@@ -89,6 +89,13 @@ function compare_code(code₁::AbstractString, code₂::AbstractString, highligh
         code₂_colored = code₂
     end
 
+    if endswith(code₁, '\n') && endswith(code₂, '\n')
+        code₁ = rstrip(==('\n'), code₁)
+        code₁_colored = rstrip(==('\n'), code₁_colored)
+        code₂ = rstrip(==('\n'), code₂)
+        code₂_colored = rstrip(==('\n'), code₂_colored)
+    end
+
     diff = CodeDiff(code₁, code₂, code₁_colored, code₂_colored)
     optimize_line_changes!(diff)
     return diff
@@ -134,6 +141,13 @@ function compare_show(code₁, code₂; color=true, force_no_ansi=false)
         code₂_colored = code_str₂
     end
 
+    if endswith(code_str₁, '\n') && endswith(code_str₂, '\n')
+        code_str₁ = rstrip(==('\n'), code_str₁)
+        code₁_colored = rstrip(==('\n'), code₁_colored)
+        code_str₂ = rstrip(==('\n'), code_str₂)
+        code₂_colored = rstrip(==('\n'), code₂_colored)
+    end
+
     diff = CodeDiff(code_str₁, code_str₂, code₁_colored, code₂_colored)
     optimize_line_changes!(diff)
     return diff

diff --git a/test/runtests.jl b/test/runtests.jl
@@ -151,29 +151,36 @@ end
             @testset "Typed" begin
                 diff = CodeDiffs.compare_code_typed(f₁, args₁, f₂, args₂; color=true)
                 @test findfirst(CodeDiffs.ANSI_REGEX, diff.before) === nothing
+                @test !endswith(diff.before, '\n') && !endswith(diff.after, '\n')
+                println("\nTyped: $(nameof(f₁)) vs. $(nameof(f₂))")
                 printstyled(display_str(diff; columns=120))
                 println()
             end
 
             @testset "LLVM" begin
                 diff = CodeDiffs.compare_code_llvm(f₁, args₁, f₂, args₂; color=true, debuginfo=:none)
                 @test findfirst(CodeDiffs.ANSI_REGEX, diff.before) === nothing
-                @test (@io2str InteractiveUtils.print_llvm(IOContext(::IO, :color => true), diff.before)) == diff.highlighted_before
+                @test !endswith(diff.before, '\n') && !endswith(diff.after, '\n')
+                @test rstrip(@io2str InteractiveUtils.print_llvm(IOContext(::IO, :color => true), diff.before)) == diff.highlighted_before
+                println("\nLLVM: $(nameof(f₁)) vs. $(nameof(f₂))")
                 printstyled(display_str(diff; columns=120))
                 println()
             end
 
             @testset "Native" begin
                 diff = CodeDiffs.compare_code_native(f₁, args₁, f₂, args₂; color=true, debuginfo=:none)
                 @test findfirst(CodeDiffs.ANSI_REGEX, diff.before) === nothing
-                @test (@io2str InteractiveUtils.print_native(IOContext(::IO, :color => true), diff.before)) == diff.highlighted_before
+                @test !endswith(diff.before, '\n') && !endswith(diff.after, '\n')
+                @test rstrip(@io2str InteractiveUtils.print_native(IOContext(::IO, :color => true), diff.before)) == diff.highlighted_before
+                println("\nNative: $(nameof(f₁)) vs. $(nameof(f₂))")
                 printstyled(display_str(diff; columns=120))
                 println()
             end
 
             @testset "Line numbers" begin
                 diff = CodeDiffs.compare_code_typed(f₁, args₁, f₂, args₂; color=false)
                 withenv("CODE_DIFFS_LINE_NUMBERS" => true) do
+                    println("\nTyped + line numbers: $(nameof(f₁)) vs. $(nameof(f₂))")
                     printstyled(display_str(diff; color=false, columns=120))
                     println()
                 end