add ability to exclude whole type

Author: Dragomeat

README.md

@@ -30,7 +30,6 @@ It has the capability to create a GraphQL schema based on the database schema, a
     author(id: UUID!): Author!
 ```
 - Add the ability to rename Row type names by golang type names
-- Exclude types from the schema generation
 - Add config to generate everything in one file
 - Make the ability to generate query from comment that is like this
 ```sql
@@ -87,11 +86,15 @@ sql:
             ## override GO type with a custom GraphQL type
             - go_type: "tutorial/tutorial.NullImage"
               gql_type: "Image"
-          ## exclude columns from the generated schema
-          ## Test - is the generated Graphql object 
-          ## and CreatedAt is the column name to be excluded    
+          ## exclude entire graphql types or specific fields
           exclude:
-            - "Test.CreatedAt"
+            ## Exclude one specific field from a type
+            - "Author.CreatedAt"
+            ## You can exclude multiple fields from the same type
+            - "Author.UpdatedAt"
+            - "Author.DeletedAt" 
+            ## Exclude an entire type from the schema
+            - "BookAuthor"
           ## rename the GraphQL type
           rename:
             ## renames like this type RenamedAuthor @goModel(model: "authors/storage.Author")

internal/__snapshots__/TestGenerate_Exclude_type_1.snap.schema.graphql

@@ -0,0 +1,11 @@
+# Code generated by sqlc. DO NOT EDIT.
+# versions:
+#   sqlc v1.27.0
+
+
+enum Status  @goModel(model: "authors/storage.Status") {
+    active
+    inactive
+}
+
+

internal/gen_gql.go

@@ -4,12 +4,13 @@ import (
 	"bufio"
 	"bytes"
 	"errors"
-	"github.com/debugger84/sqlc-graphql/internal/opts"
-	"github.com/sqlc-dev/plugin-sdk-go/plugin"
-	"github.com/sqlc-dev/plugin-sdk-go/sdk"
 	"slices"
 	"strings"
 	"text/template"
+
+	"github.com/debugger84/sqlc-graphql/internal/opts"
+	"github.com/sqlc-dev/plugin-sdk-go/plugin"
+	"github.com/sqlc-dev/plugin-sdk-go/sdk"
 )
 
 type gqlTmplCtx struct {
@@ -40,11 +41,11 @@ func generateGql(
 	structs []Struct,
 	queries []Query,
 ) (*plugin.GenerateResponse, error) {
-	excludedFields, err := getGqlExcluded(options)
+	excludedTypes, excludedFields, err := getGqlExcluded(options)
 	if err != nil {
 		return nil, err
 	}
-	structs = filterStructs(structs, excludedFields)
+	structs = filterStructs(structs, excludedTypes, excludedFields)
 
 	tctx := gqlTmplCtx{
 		ModelPackage:    options.Package,
@@ -75,7 +76,7 @@ func generateGql(
 		var b bytes.Buffer
 		w := bufio.NewWriter(&b)
 		tctx.SourceName = name
-		tctx.GoQueries = filterQueries(name, queries, excludedFields)
+		tctx.GoQueries = filterQueries(name, queries, excludedTypes, excludedFields)
 		tctx.ExtendedTypes = getExtendedTypes(tctx.GoQueries)
 		err := tmpl.ExecuteTemplate(w, templateName, &tctx)
 		w.Flush()
@@ -155,20 +156,25 @@ func extractGqlCommentsOnly(comments []string) []string {
 
 }
 
-func filterQueries(sourceName string, queries []Query, excludedFields map[string][]string) []Query {
+func filterQueries(
+	sourceName string,
+	queries []Query,
+	excludedTypes map[string]struct{},
+	excludedFields map[string][]string,
+) []Query {
 	var result []Query
 	for _, q := range queries {
 		if q.SourceName == sourceName {
 			q.Comments = extractGqlCommentsOnly(q.Comments)
 			if q.Arg.Struct != nil {
-				args := filterStructs([]Struct{*q.Arg.Struct}, excludedFields)
+				args := filterStructs([]Struct{*q.Arg.Struct}, excludedTypes, excludedFields)
 				if len(args) == 1 {
 					q.Arg.Struct = &args[0]
 				}
 			}
 
 			if q.Ret.Struct != nil {
-				returns := filterStructs([]Struct{*q.Ret.Struct}, excludedFields)
+				returns := filterStructs([]Struct{*q.Ret.Struct}, excludedTypes, excludedFields)
 				if len(returns) == 1 {
 					q.Ret.Struct = &returns[0]
 				}
@@ -194,36 +200,52 @@ func getExtendedTypes(queries []Query) []string {
 	return result
 }
 
-func getGqlExcluded(options *opts.Options) (map[string][]string, error) {
-	res := make(map[string][]string)
+func getGqlExcluded(options *opts.Options) (
+	excludedTypes map[string]struct{},
+	excludedFields map[string][]string,
+	err error,
+) {
+	excludedTypes = make(map[string]struct{})
+	excludedFields = make(map[string][]string)
 	if options == nil || options.Exclude == nil {
-		return nil, nil
+		return
 	}
 	for _, exclude := range options.Exclude {
 		parts := strings.Split(exclude, ".")
 
 		if len(parts) == 0 {
 			continue
 		}
-
-		if len(parts) != 2 {
-			return nil, errors.New("invalid exclude format. It should be in the format of 'GqlTypeName.fieldName'")
+		if len(parts) > 2 {
+			err = errors.New("invalid exclude format. To exclude single field from type use 'GqlTypeName.fieldName'. To exclude entire type use 'GqlTypeName'")
+			return
 		}
 		typeName := strings.ToLower(parts[0])
-		fieldName := strings.ToLower(parts[1])
-		if _, ok := res[typeName]; !ok {
-			res[typeName] = make([]string, 0)
+		if len(parts) == 1 {
+			excludedTypes[typeName] = struct{}{}
+			continue
+		}
+		if _, ok := excludedFields[typeName]; !ok {
+			excludedFields[typeName] = make([]string, 0)
 		}
-		res[typeName] = append(res[typeName], fieldName)
+		fieldName := strings.ToLower(parts[1])
+		excludedFields[typeName] = append(excludedFields[typeName], fieldName)
 	}
-	return res, nil
+	return
 }
 
-func filterStructs(structs []Struct, excludeFields map[string][]string) []Struct {
+func filterStructs(
+	structs []Struct,
+	excludedTypes map[string]struct{},
+	excludeFields map[string][]string,
+) []Struct {
 	var result []Struct
 	for _, s := range structs {
 		var fields []Field
 		structName := strings.ToLower(s.Name)
+		if _, ok := excludedTypes[structName]; ok {
+			continue
+		}
 		for _, f := range s.Fields {
 			if _, ok := excludeFields[structName]; ok {
 				fieldName := strings.ToLower(f.Name)

internal/gen_test.go

@@ -3,12 +3,13 @@ package golang_test
 import (
 	"context"
 	"encoding/json"
+	"testing"
+
 	golang "github.com/debugger84/sqlc-graphql/internal"
 	"github.com/debugger84/sqlc-graphql/internal/opts"
 	"github.com/gkampitakis/go-snaps/snaps"
 	"github.com/sqlc-dev/plugin-sdk-go/plugin"
 	"github.com/stretchr/testify/require"
-	"testing"
 )
 
 func TestGenerate(t *testing.T) {
@@ -153,6 +154,31 @@ func TestGenerate(t *testing.T) {
 		},
 	)
 
+	t.Run(
+		"Exclude type", func(t *testing.T) {
+			factory := NewGenReqFactory()
+			factory.options.Exclude = []string{"Author"}
+			req := factory.GenerateRequest()
+
+			resp, err := golang.Generate(ctx, req)
+
+			t.Log("Given the option to exclude the Author type is passed to the generator")
+			t.Log("When the generator is called")
+			t.Log("	Then the generator should return a response without an error")
+			require.NoError(t, err)
+			t.Log("	And the response should not contain Author type")
+			require.NotNil(t, resp)
+			require.Len(t, resp.Files, 2)
+			for _, file := range resp.Files {
+				if file.Name == "schema.graphql" {
+					snaps.WithConfig(snaps.Ext("."+file.Name)).
+						MatchStandaloneSnapshot(t, string(file.Contents))
+					require.NotContains(t, string(file.Contents), "type Author")
+				}
+			}
+		},
+	)
+
 	t.Run(
 		"Add directive to query", func(t *testing.T) {
 			factory := NewGenReqFactory()