Fix issue parsing block comments, and always retain prefix comments for cgo imports. (#49)

* Fix "Error: an error occured while trying to parse imports: path is missing starting quotes" when parsing a file with block comments.

Fixes #48.

Note that this only handles simple cases for block comments, and does
not cover more complex cases (see FIXME in parse.go).

Signed-off-by: Charles Korn <[email protected]>

* Make block comment parsing more robust to different formatting.

Signed-off-by: Charles Korn <[email protected]>

* Add test case for multiple comments before a "C" import.

Signed-off-by: Charles Korn <[email protected]>

Author: charleskorn

pkg/constants/sequences.go

@@ -1,9 +1,11 @@
 package constants
 
 const (
-	CommentFlag     = "//"
-	ImportStartFlag = "\nimport (\n"
-	ImportEndFlag   = "\n)"
+	LineCommentFlag       = "//"
+	BlockCommentStartFlag = "/*"
+	BlockCommentEndFlag   = "*/"
+	ImportStartFlag       = "\nimport (\n"
+	ImportEndFlag         = "\n)"
 
 	Blank     = " "
 	Indent    = "\t"

pkg/gci/imports/import.go

@@ -56,7 +56,7 @@ func (i ImportDef) String() string {
 func (i ImportDef) Format(cfg configuration.FormatterConfiguration) string {
 	linePrefix := constants.Indent
 	var output string
-	if cfg.NoPrefixComments == false {
+	if cfg.NoPrefixComments == false || i.QuotedPath == `"C"` {
 		for _, prefixComment := range i.PrefixComment {
 			output += linePrefix + prefixComment + constants.Linebreak
 		}

pkg/gci/internal/testdata/cgo-block-mixed-with-content.cfg.yaml

@@ -0,0 +1 @@
+no-prefixComments: true

pkg/gci/internal/testdata/cgo-block-mixed-with-content.in.go

@@ -0,0 +1,6 @@
+package main
+
+import (
+	/* #include "types.h"
+	   #include "other.h" */"C"
+)

pkg/gci/internal/testdata/cgo-block-mixed-with-content.out.go

@@ -0,0 +1,9 @@
+package main
+
+import (
+	/*
+		#include "types.h"
+		#include "other.h"
+	*/
+	"C"
+)

pkg/gci/internal/testdata/cgo-block-mixed.cfg.yaml

@@ -0,0 +1 @@
+no-prefixComments: true

pkg/gci/internal/testdata/cgo-block-mixed.in.go

@@ -0,0 +1,6 @@
+package main
+
+import (
+	/* #include "types.h"
+	 */"C"
+)

pkg/gci/internal/testdata/cgo-block-mixed.out.go

@@ -0,0 +1,8 @@
+package main
+
+import (
+	/*
+		#include "types.h"
+	*/
+	"C"
+)

pkg/gci/internal/testdata/cgo-block-prefix.cfg.yaml

@@ -0,0 +1 @@
+no-prefixComments: true

pkg/gci/internal/testdata/cgo-block-prefix.in.go

@@ -0,0 +1,5 @@
+package main
+
+import (
+	/* #include "types.h" */ "C"
+)