Relocated constants for query flags to a dedicated package to allow for safer reuse.

Author: rhodeon

internal/cmd/vet.go

@@ -6,6 +6,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"github.com/sqlc-dev/sqlc/internal/constants"
 	"io"
 	"log"
 	"os"
@@ -38,9 +39,6 @@ var ErrFailedChecks = errors.New("failed checks")
 
 var pjson = protojson.UnmarshalOptions{AllowPartial: true, DiscardUnknown: true}
 
-const RuleDbPrepare = "sqlc/db-prepare"
-const QueryFlagSqlcVetDisable = "@sqlc-vet-disable"
-
 func NewCmdVet() *cobra.Command {
 	return &cobra.Command{
 		Use:   "vet",
@@ -110,7 +108,7 @@ func Vet(ctx context.Context, dir, filename string, opts *Options) error {
 	}
 
 	rules := map[string]rule{
-		RuleDbPrepare: {NeedsPrepare: true},
+		constants.QueryRuleDbPrepare: {NeedsPrepare: true},
 	}
 
 	for _, c := range conf.Rules {
@@ -540,7 +538,7 @@ func (c *checker) checkSQL(ctx context.Context, s config.SQL) error {
 	cfg := vetConfig(req)
 	for i, query := range req.Queries {
 		md := result.Queries[i].Metadata
-		if md.Flags[QueryFlagSqlcVetDisable] {
+		if md.Flags[constants.QueryFlagSqlcVetDisable] {
 			// If the vet disable flag is specified without any rules listed, all rules are ignored.
 			if len(md.RuleSkiplist) == 0 {
 				if debug.Active {

internal/constants/query.go

@@ -0,0 +1,12 @@
+package constants
+
+// Flags
+const (
+	QueryFlagParam          = "@param"
+	QueryFlagSqlcVetDisable = "@sqlc-vet-disable"
+)
+
+// Rules
+const (
+	QueryRuleDbPrepare = "sqlc/db-prepare"
+)

internal/metadata/meta.go

@@ -3,6 +3,7 @@ package metadata
 import (
 	"bufio"
 	"fmt"
+	"github.com/sqlc-dev/sqlc/internal/constants"
 	"strings"
 	"unicode"
 
@@ -134,7 +135,7 @@ func ParseParamsAndFlags(comments []string) (map[string]string, map[string]bool,
 		}
 
 		switch token {
-		case "@param":
+		case constants.QueryFlagParam:
 			s.Scan()
 			name := s.Text()
 			var rest []string
@@ -144,7 +145,7 @@ func ParseParamsAndFlags(comments []string) (map[string]string, map[string]bool,
 			}
 			params[name] = strings.Join(rest, " ")
 
-		case "@sqlc-vet-disable":
+		case constants.QueryFlagSqlcVetDisable:
 			flags[token] = true
 
 			// Vet rules can all be disabled in the same line or split across lines .i.e.