metadata: Support multiple comment prefixes

internal/endtoend/testdata/comment_syntax/mysql/query.sql

@@ -0,0 +1,10 @@
+CREATE TABLE foo (bar text);
+
+-- name: DoubleDash :one
+SELECT * FROM foo LIMIT 1;
+
+/* name: SlashStar :one */
+SELECT * FROM foo LIMIT 1;
+
+# name: Hash :one
+SELECT * FROM foo LIMIT 1;

internal/endtoend/testdata/comment_syntax/mysql/sqlc.json

@@ -0,0 +1,12 @@
+{
+  "version": "1",
+  "packages": [
+    {
+      "path": "go",
+      "engine": "mysql:beta",
+      "name": "querytest",
+      "schema": "query.sql",
+      "queries": "query.sql"
+    }
+  ]
+}

internal/endtoend/testdata/comment_syntax/postgresql/query.sql

@@ -0,0 +1,7 @@
+CREATE TABLE foo (bar text);
+
+-- name: DoubleDash :one
+SELECT * FROM foo LIMIT 1;
+
+/* name: SlashStar :one */
+SELECT * FROM foo LIMIT 1;

internal/endtoend/testdata/comment_syntax/postgresql/sqlc.json

@@ -0,0 +1,12 @@
+{
+  "version": "1",
+  "packages": [
+    {
+      "path": "go",
+      "engine": "postgresql",
+      "name": "querytest",
+      "schema": "query.sql",
+      "queries": "query.sql"
+    }
+  ]
+}

internal/engine/dolphin/parse.go

@@ -81,6 +81,11 @@ func (p *Parser) Parse(r io.Reader) ([]ast.Statement, error) {
 	return stmts, nil
 }
 
+// https://dev.mysql.com/doc/refman/8.0/en/comments.html
 func (p *Parser) CommentSyntax() metadata.CommentSyntax {
-	return metadata.CommentSyntaxStar
+	return metadata.CommentSyntax{
+		Dash:      true,
+		SlashStar: true,
+		Hash:      true,
+	}
 }

internal/engine/postgresql/parse.go

@@ -220,8 +220,12 @@ func (p *Parser) Parse(r io.Reader) ([]ast.Statement, error) {
 	return stmts, nil
 }
 
+// https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-COMMENTS
 func (p *Parser) CommentSyntax() metadata.CommentSyntax {
-	return metadata.CommentSyntaxDash
+	return metadata.CommentSyntax{
+		Dash:      true,
+		SlashStar: true,
+	}
 }
 
 func translate(node nodes.Node) (ast.Node, error) {

internal/engine/sqlite/parse.go

@@ -85,5 +85,7 @@ func (p *Parser) Parse(r io.Reader) ([]ast.Statement, error) {
 }
 
 func (p *Parser) CommentSyntax() metadata.CommentSyntax {
-	return metadata.CommentSyntaxDash
+	return metadata.CommentSyntax{
+		Dash: true,
+	}
 }

internal/metadata/meta.go

@@ -6,13 +6,11 @@ import (
 	"unicode"
 )
 
-type CommentSyntax int
-
-const (
-	CommentSyntaxDash CommentSyntax = iota
-	CommentSyntaxStar               // Note: this is the only style supported by the MySQL sqlparser
-	CommentSyntaxHash
-)
+type CommentSyntax struct {
+	Dash      bool
+	Hash      bool
+	SlashStar bool
+}
 
 const (
 	CmdExec       = ":exec"
@@ -43,15 +41,34 @@ func validateQueryName(name string) error {
 
 func Parse(t string, commentStyle CommentSyntax) (string, string, error) {
 	for _, line := range strings.Split(t, "\n") {
-		if commentStyle == CommentSyntaxDash && !strings.HasPrefix(line, "-- name:") {
+		var prefix string
+		if strings.HasPrefix(line, "--") {
+			if !commentStyle.Dash {
+				continue
+			}
+			prefix = "-- name:"
+		}
+		if strings.HasPrefix(line, "/*") {
+			if !commentStyle.SlashStar {
+				continue
+			}
+			prefix = "/* name:"
+		}
+		if strings.HasPrefix(line, "#") {
+			if !commentStyle.Hash {
+				continue
+			}
+			prefix = "# name:"
+		}
+		if prefix == "" {
 			continue
 		}
-		if commentStyle == CommentSyntaxStar && !strings.HasPrefix(line, "/* name:") {
+		if !strings.HasPrefix(line, prefix) {
 			continue
 		}
-		part := strings.Split(strings.TrimSpace(line), " ")
 
-		if commentStyle == CommentSyntaxStar {
+		part := strings.Split(strings.TrimSpace(line), " ")
+		if strings.HasPrefix(line, "/*") {
 			part = part[:len(part)-1] // removes the trailing "*/" element
 		}
 		if len(part) == 2 {

internal/metadata/meta_test.go

@@ -11,7 +11,7 @@ func TestParseMetadata(t *testing.T) {
 		`-- name: CreateFoo :one something`,
 		`-- name: `,
 	} {
-		if _, _, err := Parse(query, CommentSyntaxDash); err == nil {
+		if _, _, err := Parse(query, CommentSyntax{Dash: true}); err == nil {
 			t.Errorf("expected invalid metadata: %q", query)
 		}
 	}

internal/mysql/parse.go

@@ -141,7 +141,7 @@ func (q *Query) parseNameAndCmd() error {
 		return fmt.Errorf("cannot parse name and cmd from null query")
 	}
 	_, comments := sqlparser.SplitMarginComments(q.SQL)
-	name, cmd, err := metadata.Parse(comments.Leading, metadata.CommentSyntaxStar)
+	name, cmd, err := metadata.Parse(comments.Leading, metadata.CommentSyntax{SlashStar: true})
 	if err != nil {
 		return err
 	} else if name == "" || cmd == "" {