Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix patch file creation using Gazelle in diff mode #1915

Merged
merged 3 commits into from
Sep 14, 2024
Merged

Fix patch file creation using Gazelle in diff mode #1915

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
323779a
Adding work around to strip trailing newlines from the resulting diff…
alandonham Sep 9, 2024
fd50d73
Update diff.go
alandonham Sep 9, 2024
415dd8f
Cleanup formatting
alandonham Sep 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions cmd/gazelle/diff.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,15 @@ func diffFile(c *config.Config, f *rule.File) error {
} else {
diff.ToFile = outPath
}
// Trim off trailing newline from the end of the file. Modern diff tools typically
// handle this, however difflib does not and is no longer maintained, so we need to
// handle it here.
if len(diff.A) > 0 {
if diff.A[len(diff.A)-1] == "\n" {diff.A = diff.A[:len(diff.A)-1]}
}
if len(diff.B) > 0 {
if diff.B[len(diff.B)-1] == "\n" {diff.B = diff.B[:len(diff.B)-1]}
}

uc := getUpdateConfig(c)
var out io.Writer = os.Stdout
Expand Down
11 changes: 4 additions & 7 deletions cmd/gazelle/diff_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,18 +50,17 @@ func TestDiffExisting(t *testing.T) {
Content: `
--- BUILD.bazel 1970-01-01 00:00:00.000000001 +0000
+++ BUILD.bazel 1970-01-01 00:00:00.000000001 +0000
@@ -1,3 +1,11 @@
@@ -1,2 +1,10 @@
+load("@io_bazel_rules_go//go:def.bzl", "go_library")

# gazelle:prefix example.com/hello
+
+go_library(
+ name = "hello",
+ srcs = ["hello.go"],
+ importpath = "example.com/hello",
+ visibility = ["//visibility:public"],
+)
+
`,
})
testtools.CheckFiles(t, dir, want)
Expand All @@ -88,7 +87,7 @@ func TestDiffNew(t *testing.T) {
Content: `
--- /dev/null 1970-01-01 00:00:00.000000001 +0000
+++ BUILD.bazel 1970-01-01 00:00:00.000000001 +0000
@@ -0,0 +1,9 @@
@@ -0,0 +1,8 @@
+load("@io_bazel_rules_go//go:def.bzl", "go_library")
+
+go_library(
Expand All @@ -97,7 +96,6 @@ func TestDiffNew(t *testing.T) {
+ importpath = "example.com/hello",
+ visibility = ["//visibility:public"],
+)
+
`,
})
testtools.CheckFiles(t, dir, want)
Expand Down Expand Up @@ -160,7 +158,7 @@ func TestDiffReadWriteDir(t *testing.T) {
wantPatch := fmt.Sprintf(`
--- %s 1970-01-01 00:00:00.000000001 +0000
+++ %s 1970-01-01 00:00:00.000000001 +0000
@@ -1 +1,11 @@
@@ -1 +1,10 @@
+load("@io_bazel_rules_go//go:def.bzl", "go_library")
+
# gazelle:prefix example.com/hello
Expand All @@ -171,7 +169,6 @@ func TestDiffReadWriteDir(t *testing.T) {
+ importpath = "example.com/hello",
+ visibility = ["//visibility:public"],
+)
+
`,
filepath.Join(dir, "read", "BUILD.bazel"),
filepath.Join(dir, "write", "BUILD.bazel"))
Expand Down
5 changes: 2 additions & 3 deletions tests/diff_mode/expectedStdout.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
--- /dev/null 1970-01-01 00:00:00.000000001 +0000
+++ BUILD.bazel 1970-01-01 00:00:00.000000001 +0000
@@ -0,0 +1,10 @@
@@ -0,0 +1,9 @@
+filegroup(
+ name = "all_files",
+ testonly = True,
Expand All @@ -9,5 +9,4 @@
+ "WORKSPACE",
+ ],
+ visibility = ["//visibility:public"],
+)
+
+)
5 changes: 2 additions & 3 deletions tests/loads_from_flag/expectedStdout.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
--- /dev/null 1970-01-01 00:00:00.000000001 +0000
+++ BUILD.bazel 1970-01-01 00:00:00.000000001 +0000
@@ -0,0 +1,4 @@
@@ -0,0 +1,3 @@
+load("@some//repo:rules.bzl", "custom_rule")
+
+custom_rule(name = "gen")
+
+custom_rule(name = "gen")