Skip to content

Commit 9a0adb6

Browse files
jeejeeoneXiNiHa
authored andcommitted
Update docs for excludeDeprecated (ghostdogpr#2171)
1 parent 9fc5f28 commit 9a0adb6

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

vuepress/docs/docs/client-codegen.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -83,13 +83,14 @@ The settings available on the `cs` (`CalibanSettings`) builder are:
8383
- `enableFmt`: Enable code formatting with scalafmt (default: `true`).
8484
- `extensibleEnums`: Generate a fallback case class for unknown enum values (default: `false`).
8585
- `headers` (only defined for `url` settings): Supply extra headers when fetching the schema from a URL.
86+
- `excludeDeprecated`: Exclude fields and enum values with deprecated directive (default: `false`).
8687

8788
### Manual generation
8889

8990
If you prefer to generate the client explicitly rather than automatically, you can use `calibanGenClient` on the SBT CLI as follows:
9091

9192
```bash
92-
calibanGenClient schemaPath outputPath [--scalafmtPath path] [--headers name:value,name2:value2] [--genView true|false] [--scalarMappings gqlType:f.q.d.n.Type,gqlType2:f.q.d.n.Type2] [--imports a.b.c._,c.d.E] [--splitFiles true|false] [--enableFmt true|false]
93+
calibanGenClient schemaPath outputPath [--scalafmtPath path] [--headers name:value,name2:value2] [--genView true|false] [--scalarMappings gqlType:f.q.d.n.Type,gqlType2:f.q.d.n.Type2] [--imports a.b.c._,c.d.E] [--splitFiles true|false] [--enableFmt true|false] [--extensibleEnums true|false] [--excludeDeprecated true|false]
9394

9495
# example
9596
calibanGenClient project/schema.graphql src/main/client/Client.scala --genView true
@@ -172,6 +173,7 @@ This `ClientGenerationSettings` case class gives you the following configuration
172173
- `splitFiles`: Whether to split the generated code into multiple files (default: `false`).
173174
- `enableFmt`: Enable code formatting with scalafmt (default: `true`).
174175
- `extensibleEnums`: Generate a fallback case class for unknown enum values (default: `false`).
176+
- `excludeDeprecated`: Exclude fields or enum values with deprecated directive (default: `false`).
175177

176178
Let's take an example:
177179
```scala

0 commit comments

Comments
 (0)