feat: Add JSON "codegen" output (#1565)

* feat: Add JSON codegen output

Author: kyleconroy

internal/cmd/generate.go

@@ -12,6 +12,7 @@ import (
 	"strings"
 
 	"github.com/kyleconroy/sqlc/internal/codegen/golang"
+	"github.com/kyleconroy/sqlc/internal/codegen/json"
 	"github.com/kyleconroy/sqlc/internal/codegen/kotlin"
 	"github.com/kyleconroy/sqlc/internal/codegen/python"
 	"github.com/kyleconroy/sqlc/internal/compiler"
@@ -138,6 +139,12 @@ func Generate(ctx context.Context, e Env, dir, filename string, stderr io.Writer
 				Gen: config.SQLGen{Python: sql.Gen.Python},
 			})
 		}
+		if sql.Gen.JSON != nil {
+			pairs = append(pairs, outPair{
+				SQL: sql,
+				Gen: config.SQLGen{JSON: sql.Gen.JSON},
+			})
+		}
 	}
 
 	for _, sql := range pairs {
@@ -205,6 +212,9 @@ func Generate(ctx context.Context, e Env, dir, filename string, stderr io.Writer
 		case sql.Gen.Python != nil:
 			out = combo.Python.Out
 			genfunc = python.Generate
+		case sql.Gen.JSON != nil:
+			out = combo.JSON.Out
+			genfunc = json.Generate
 		default:
 			panic("missing language backend")
 		}

internal/cmd/shim.go

@@ -59,6 +59,7 @@ func pluginSettings(cs config.CombinedSettings) *plugin.Settings {
 		Python:    pluginPythonCode(cs.Python),
 		Kotlin:    pluginKotlinCode(cs.Kotlin),
 		Go:        pluginGoCode(cs.Go),
+		Json:      pluginJSONCode(cs.JSON),
 	}
 }
 
@@ -124,6 +125,13 @@ func pluginKotlinCode(s config.SQLKotlin) *plugin.KotlinCode {
 	}
 }
 
+func pluginJSONCode(s config.SQLJSON) *plugin.JSONCode {
+	return &plugin.JSONCode{
+		Out:    s.Out,
+		Indent: s.Indent,
+	}
+}
+
 func pluginCatalog(c *catalog.Catalog) *plugin.Catalog {
 	var schemas []*plugin.Schema
 	for _, s := range c.Schemas {

internal/codegen/json/gen.go

@@ -0,0 +1,40 @@
+package json
+
+import (
+	ejson "encoding/json"
+
+	"google.golang.org/protobuf/encoding/protojson"
+
+	"github.com/kyleconroy/sqlc/internal/plugin"
+)
+
+func Generate(req *plugin.CodeGenRequest) (*plugin.CodeGenResponse, error) {
+	indent := ""
+	if req.Settings != nil && req.Settings.Json != nil {
+		indent = req.Settings.Json.Indent
+	}
+	// The output of protojson has randomized whitespace
+	// https://github.com/golang/protobuf/issues/1082
+	m := &protojson.MarshalOptions{
+		EmitUnpopulated: true,
+		Indent:          "",
+		UseProtoNames:   true,
+	}
+	data, err := m.Marshal(req)
+	if err != nil {
+		return nil, err
+	}
+	var rm ejson.RawMessage = data
+	blob, err := ejson.MarshalIndent(rm, "", indent)
+	if err != nil {
+		return nil, err
+	}
+	return &plugin.CodeGenResponse{
+		Files: []*plugin.File{
+			{
+				Name:     "codegen_request.json",
+				Contents: append(blob, '\n'),
+			},
+		},
+	}, nil
+}

internal/config/config.go

@@ -114,6 +114,7 @@ type SQLGen struct {
 	Go     *SQLGo     `json:"go,omitempty" yaml:"go"`
 	Kotlin *SQLKotlin `json:"kotlin,omitempty" yaml:"kotlin"`
 	Python *SQLPython `json:"python,omitempty" yaml:"python"`
+	JSON   *SQLJSON   `json:"json,omitempty" yaml:"json"`
 }
 
 type SQLGo struct {
@@ -155,6 +156,11 @@ type SQLPython struct {
 	EmitPydanticModels  bool       `json:"emit_pydantic_models,omitempty" yaml:"emit_pydantic_models"`
 }
 
+type SQLJSON struct {
+	Out    string `json:"out" yaml:"out"`
+	Indent string `json:"indent,omitempty" yaml:"indent"`
+}
+
 type Override struct {
 	// name of the golang type to use, e.g. `github.com/segmentio/ksuid.KSUID`
 	GoType GoType `json:"go_type" yaml:"go_type"`
@@ -352,6 +358,7 @@ type CombinedSettings struct {
 	Go        SQLGo
 	Kotlin    SQLKotlin
 	Python    SQLPython
+	JSON      SQLJSON
 	Rename    map[string]string
 	Overrides []Override
 }
@@ -379,5 +386,8 @@ func Combine(conf Config, pkg SQL) CombinedSettings {
 		cs.Python = *pkg.Gen.Python
 		cs.Overrides = append(cs.Overrides, pkg.Gen.Python.Overrides...)
 	}
+	if pkg.Gen.JSON != nil {
+		cs.JSON = *pkg.Gen.JSON
+	}
 	return cs
 }

internal/config/v_two.go

@@ -75,6 +75,11 @@ func v2ParseConfig(rd io.Reader) (Config, error) {
 				}
 			}
 		}
+		if conf.SQL[j].Gen.JSON != nil {
+			if conf.SQL[j].Gen.JSON.Out == "" {
+				return conf, ErrNoOutPath
+			}
+		}
 	}
 	return conf, nil
 }

internal/endtoend/endtoend_test.go

@@ -116,7 +116,10 @@ func cmpDirectory(t *testing.T, dir string, actual map[string]string) {
 		if file.IsDir() {
 			return nil
 		}
-		if !strings.HasSuffix(path, ".go") && !strings.HasSuffix(path, ".kt") && !strings.HasSuffix(path, ".py") {
+		if !strings.HasSuffix(path, ".go") && !strings.HasSuffix(path, ".kt") && !strings.HasSuffix(path, ".py") && !strings.HasSuffix(path, ".json") {
+			return nil
+		}
+		if filepath.Base(path) == "sqlc.json" {
 			return nil
 		}
 		if strings.Contains(path, "/kotlin/build") {
@@ -126,7 +129,8 @@ func cmpDirectory(t *testing.T, dir string, actual map[string]string) {
 			return nil
 		}
 		if strings.Contains(path, "/python/.venv") || strings.Contains(path, "/python/src/tests/") ||
-			strings.HasSuffix(path, "__init__.py") || strings.Contains(path, "/python/src/dbtest/") {
+			strings.HasSuffix(path, "__init__.py") || strings.Contains(path, "/python/src/dbtest/") ||
+			strings.Contains(path, "/python/.mypy_cache") {
 			return nil
 		}
 		blob, err := os.ReadFile(path)