update and align init template and config docs

docs/content/config.md

@@ -8,7 +8,7 @@ weight: -5
 
 gqlgen can be configured using a `gqlgen.yml` file, by default it will be loaded from the current directory, or any parent directory.
 
-Example:
+As an example, here is the default configuration file generated with `gqlgen init`:
 
 ```yml
 # Where are all the schema files located? globs are supported eg  src/**/*.graphqls
@@ -17,37 +17,53 @@ schema:
 
 # Where should the generated server code go?
 exec:
-  layout: follow-schema
-  dir: graph/generated
-  package: generated
-
-# Enable Apollo federation support
-federation:
-  filename: graph/federation.go
   package: graph
-  version: 2
-  options:
-    computed_requires: true
+  layout: single-file # Only other option is "follow-schema," ie multi-file.
+
+  # Only for single-file layout:
+  filename: graph/generated.go
+
+  # Only for follow-schema layout:
+  # dir: graph
+  # filename_template: "{name}.generated.go"
+
+  # Optional: Maximum number of goroutines in concurrency to use per child resolvers(default: unlimited)
+  # worker_limit: 1000
+
+# Uncomment to enable federation
+# federation:
+#   filename: graph/federation.go
+#   package: graph
+#   version: 2
+#   options:
+#     computed_requires: true
 
 # Where should any generated models go?
 model:
   filename: graph/model/models_gen.go
   package: model
+
   # Optional: Pass in a path to a new gotpl template to use for generating the models
   # model_template: [your/path/model.gotpl]
 
 # Where should the resolver implementations go?
 resolver:
-  layout: follow-schema
-  dir: graph
   package: graph
+  layout: follow-schema # Only other option is "single-file."
+
+  # Only for single-file layout:
+  # filename: graph/resolver.go
+
+  # Only for follow-schema layout:
+  dir: graph
   filename_template: "{name}.resolvers.go"
+
   # Optional: turn on to not generate template comments above resolvers
   # omit_template_comment: false
   # Optional: Pass in a path to a new gotpl template to use for generating resolvers
   # resolver_template: [your/path/resolver.gotpl]
-	# Optional: turn on to avoid rewriting existing resolver(s) when generating
-	# preserve_resolver: false
+  # Optional: turn on to avoid rewriting existing resolver(s) when generating
+  # preserve_resolver: false
 
 # Optional: turn on use ` + "`" + `gqlgen:"fieldName"` + "`" + ` tags in your models
 # struct_tag: json
@@ -86,8 +102,11 @@ resolver:
 # Optional: wrap nullable input fields with Omittable
 # nullable_input_omittable: true
 
-# Optional: wrap nullable input fields with Omittable
-# nullable_input_omittable: true
+# Optional: set to speed up generation time by not performing a final validation pass.
+# skip_validation: true
+
+# Optional: set to skip running `go mod tidy` when generating server code
+# skip_mod_tidy: true
 
 # Optional: if this is set to true, argument directives that
 # decorate a field with a null value will still be called.
@@ -96,12 +115,6 @@ resolver:
 # argument values but to set them even if they're null.
 call_argument_directives_with_null: true
 
-# Optional: set to speed up generation time by not performing a final validation pass.
-# skip_validation: true
-
-# Optional: set to skip running `go mod tidy` when generating server code
-# skip_mod_tidy: true
-
 # Optional: set build tags that will be used to load packages
 # go_build_tags:
 #  - private
@@ -116,8 +129,8 @@ call_argument_directives_with_null: true
 
 # gqlgen will search for any type names in the schema in these go packages
 # if they match it will use them, otherwise it will generate them.
-# autobind:
-#   - "github.com/[YOUR_APP_DIR]/graph/model"
+autobind:
+#  - "{{.}}/graph/model"
 
 # This section declares type mapping between the GraphQL and go type systems
 #
@@ -131,14 +144,26 @@ models:
       - github.com/99designs/gqlgen/graphql.Int
       - github.com/99designs/gqlgen/graphql.Int64
       - github.com/99designs/gqlgen/graphql.Int32
+  UUID:
+    model:
+      - github.com/99designs/gqlgen/graphql.UUID
+
+  # The GraphQL spec explicitly states that the Int type is a signed 32-bit
+  # integer. Using Go int or int64 to represent it can lead to unexpected
+  # behavior, and some GraphQL tools like Apollo Router will fail when
+  # communicating numbers that overflow 32-bits.
+  #
+  # You may choose to use the custom, built-in Int64 scalar to represent 64-bit
+  # integers, or ignore the spec and bind Int to graphql.Int / graphql.Int64
+  # (the default behavior of gqlgen). This is fine in simple use cases when you
+  # do not need to worry about interoperability and only expect small numbers.
   Int:
     model:
-      - github.com/99designs/gqlgen/graphql.Int
-      - github.com/99designs/gqlgen/graphql.Int64
       - github.com/99designs/gqlgen/graphql.Int32
-  UUID:
+  Int64:
     model:
-      - github.com/99designs/gqlgen/graphql.UUID
+      - github.com/99designs/gqlgen/graphql.Int
+      - github.com/99designs/gqlgen/graphql.Int64
 ```
 
 Everything has defaults, so add things as you need.

init-templates/gqlgen.yml.gotmpl

@@ -4,8 +4,16 @@ schema:
 
 # Where should the generated server code go?
 exec:
-  filename: graph/generated.go
   package: graph
+  layout: single-file # Only other option is "follow-schema," ie multi-file.
+
+  # Only for single-file layout:
+  filename: graph/generated.go
+
+  # Only for follow-schema layout:
+  # dir: graph
+  # filename_template: "{name}.generated.go"
+
   # Optional: Maximum number of goroutines in concurrency to use per child resolvers(default: unlimited)
   # worker_limit: 1000
 
@@ -14,22 +22,35 @@ exec:
 #   filename: graph/federation.go
 #   package: graph
 #   version: 2
-#   options
+#   options:
 #     computed_requires: true
 
 # Where should any generated models go?
 model:
   filename: graph/model/models_gen.go
   package: model
 
+  # Optional: Pass in a path to a new gotpl template to use for generating the models
+  # model_template: [your/path/model.gotpl]
+
 # Where should the resolver implementations go?
 resolver:
-  layout: follow-schema
-  dir: graph
   package: graph
+  layout: follow-schema # Only other option is "single-file."
+
+  # Only for single-file layout:
+  # filename: graph/resolver.go
+
+  # Only for follow-schema layout:
+  dir: graph
   filename_template: "{name}.resolvers.go"
+
   # Optional: turn on to not generate template comments above resolvers
   # omit_template_comment: false
+  # Optional: Pass in a path to a new gotpl template to use for generating resolvers
+  # resolver_template: [your/path/resolver.gotpl]
+  # Optional: turn on to avoid rewriting existing resolver(s) when generating
+  # preserve_resolver: false
 
 # Optional: turn on use ` + "`" + `gqlgen:"fieldName"` + "`" + ` tags in your models
 # struct_tag: json
@@ -38,7 +59,7 @@ resolver:
 # omit_slice_element_pointers: false
 
 # Optional: turn on to omit Is<Name>() methods to interface and unions
-# omit_interface_checks : true
+# omit_interface_checks: true
 
 # Optional: turn on to skip generation of ComplexityRoot struct content and Complexity function
 # omit_complexity: false
@@ -49,6 +70,12 @@ resolver:
 # Optional: turn on to exclude the gqlgen version in the generated file notice. No effect if `omit_gqlgen_file_notice` is true.
 # omit_gqlgen_version_in_file_notice: false
 
+# Optional: turn on to exclude root models such as Query and Mutation from the generated models file.
+# omit_root_models: false
+
+# Optional: turn on to exclude resolver fields from the generated models file.
+# omit_resolver_fields: false
+
 # Optional: turn off to make struct-type struct fields not use pointers
 # e.g. type Thing struct { FieldA OtherThing } instead of { FieldA *OtherThing }
 # struct_fields_always_pointers: true
@@ -75,6 +102,18 @@ resolver:
 # argument values but to set them even if they're null.
 call_argument_directives_with_null: true
 
+# Optional: set build tags that will be used to load packages
+# go_build_tags:
+#  - private
+#  - enterprise
+
+# Optional: set to modify the initialisms regarded for Go names
+# go_initialisms:
+#   replace_defaults: false # if true, the default initialisms will get dropped in favor of the new ones instead of being added
+#   initialisms: # List of initialisms to for Go names
+#     - 'CC'
+#     - 'BCC'
+
 # gqlgen will search for any type names in the schema in these go packages
 # if they match it will use them, otherwise it will generate them.
 autobind:
@@ -92,6 +131,9 @@ models:
       - github.com/99designs/gqlgen/graphql.Int
       - github.com/99designs/gqlgen/graphql.Int64
       - github.com/99designs/gqlgen/graphql.Int32
+  UUID:
+    model:
+      - github.com/99designs/gqlgen/graphql.UUID
 
   # The GraphQL spec explicitly states that the Int type is a signed 32-bit
   # integer. Using Go int or int64 to represent it can lead to unexpected