Skip to content

Commit d9f1034

Browse files
committed
Improve config section docs
1 parent 6c6feca commit d9f1034

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

docs/src/app/docs/configuration/page.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -466,6 +466,18 @@ auto_generate:
466466
# - "exclude": Automatically exclude fields with out-of-scope types
467467
# Default: "warn"
468468
out_of_scope_types: warn
469+
470+
# Type to use for unresolved generic type parameters
471+
# When a generic type parameter cannot be resolved (e.g., T in Result[T] when used standalone),
472+
# this determines what GraphQL type to use instead
473+
# Default: "" (keeps as-is, e.g., "T")
474+
# Common values: "Any", "JSON", or any custom scalar name
475+
unresolved_generic_type: ""
476+
477+
# Suppress out-of-scope warnings for common type parameters (T, K, V, etc.)
478+
# Useful when using generic types where type parameters are expected to be unresolved
479+
# Default: false
480+
suppress_generic_type_warnings: false
469481

470482
# CLI configuration
471483
cli:

gqlschemagen.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,17 @@ auto_generate:
241241
# - "exclude": Automatically exclude fields with out-of-scope types
242242
# Default: "warn"
243243
out_of_scope_types: warn
244+
# Type to use for unresolved generic type parameters
245+
# When a generic type parameter cannot be resolved (e.g., T in Result[T] when used standalone),
246+
# this determines what GraphQL type to use instead
247+
# Default: "" (keeps as-is, e.g., "T")
248+
# Common values: "Any", "JSON", or any custom scalar name
249+
unresolved_generic_type: ""
250+
251+
# Suppress out-of-scope warnings for common type parameters (T, K, V, etc.)
252+
# Useful when using generic types where type parameters are expected to be unresolved
253+
# Default: false
254+
suppress_generic_type_warnings: false
244255

245256
# CLI configuration
246257
cli:

0 commit comments

Comments
 (0)