Fix comment issue (#136)

* README: update isolated comment blocks Signed-off-by: Loong <[email protected]> * fix the top comment Signed-off-by: Loong <[email protected]> --------- Signed-off-by: Loong <[email protected]>
daixiang0 · Feb 7, 2023 · 7f0d0bc · 7f0d0bc
1 parent 33a14c3
commit 7f0d0bc
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -9,7 +9,20 @@ GCI considers a import block based on AST as below:
 Doc
 Name Path Comment
 ```
-All comments will keep as they were, except the independent comment blocks(line breaks before and after).
+All comments will keep as they were, except the isolated comment blocks.
+
+The isolated comment blocks like below:
+```
+import (
+  "fmt" 
+  // this line is isolated comment
+
+  // those lines belong to one
+  // isolated comment blocks
+
+  "github.com/daixiang0/gci"
+)
+```
 
 GCI splits all import blocks into different sections, now support five section type:
 - standard: Golang official imports, like "fmt"

diff --git a/pkg/gci/gci.go b/pkg/gci/gci.go
@@ -170,6 +170,7 @@ func LoadFormatGoFile(file io.FileObj, cfg config.Config) (src, dist []byte, err
 
 	// add beginning of import block
 	head = append(head, `import (`...)
+	head = append(head, utils.Linebreak)
 	// add end of import block
 	body = append(body, []byte{utils.RightParenthesis, utils.Linebreak}...)
 

diff --git a/pkg/gci/internal/testdata/comment-top.cfg.yaml b/pkg/gci/internal/testdata/comment-top.cfg.yaml
@@ -0,0 +1 @@
+common.cfg.yaml
diff --git a/pkg/gci/internal/testdata/comment-top.in.go b/pkg/gci/internal/testdata/comment-top.in.go
@@ -0,0 +1,7 @@
+package main
+
+import (
+	"os" // https://pkg.go.dev/os
+	// https://pkg.go.dev/fmt
+	"fmt"
+)
diff --git a/pkg/gci/internal/testdata/comment-top.out.go b/pkg/gci/internal/testdata/comment-top.out.go
@@ -0,0 +1,7 @@
+package main
+
+import (
+	// https://pkg.go.dev/fmt
+	"fmt"
+	"os" // https://pkg.go.dev/os
+)