Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michaelboyles/dgs-codegen-maven-plugin
A Maven port of Netflix's DGS codegen gradle plugin
https://github.com/michaelboyles/dgs-codegen-maven-plugin
dgs graphql maven-plugin
Last synced: 1 day ago
JSON representation
A Maven port of Netflix's DGS codegen gradle plugin
- Host: GitHub
- URL: https://github.com/michaelboyles/dgs-codegen-maven-plugin
- Owner: michaelboyles
- License: apache-2.0
- Created: 2021-02-28T17:50:57.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2022-12-16T13:43:57.000Z (almost 2 years ago)
- Last Synced: 2023-05-11T10:28:09.319Z (over 1 year ago)
- Topics: dgs, graphql, maven-plugin
- Language: Java
- Homepage:
- Size: 66.4 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/michaelboyles/dgs-codegen-maven-plugin/actions) [](https://github.com/michaelboyles/dgs-codegen-maven-plugin/releases) [](https://github.com/michaelboyles/dgs-codegen-maven-plugin/blob/develop/LICENSE)
A Maven port of Netflix's [DGS codegen gradle plugin](https://github.com/Netflix/dgs-codegen).
The core code to generate the classes [already exists as its own module](https://github.com/Netflix/dgs-codegen/tree/master/graphql-dgs-codegen-core),
so this is plugin is just a thin wrapper around that.
## Sample Usage
Add the following plugin to your Maven build:
```xml
com.github.michaelboyles
dgs-codegen-maven-plugin
1.3.0
generate
com.foo.bar
```
The dependency is available from [jitpack.io](https://jitpack.io/). You can use the following repo declaration:
```xml
jitpack.io
https://jitpack.io
```
## Goals
### dgs-codegen-maven-plugin:generate
Generates classes for the [DGS framework](https://github.com/Netflix/dgs-framework).
Binds by default to the [lifecycle phase](http://maven.apache.org/ref/3.6.3/maven-core/lifecycles.html): generate-sources.
**Required Parameters**
| Property | Type | Since | Description |
| ----------- | ----------- | ----- | --------------------------------------------- |
| packageName | String | 1.0.0 | The package name to use for generated classes |
**Optional Parameters**
| Property | Type | Since | Description |
| -------------------------------- | -------- | ----- | --------------------------------------------- |
| schemaPaths | File[] | 1.0.0 | Path to directory/directories containing GraphQL schemas. Default: `${project.build.sourceDirectory}/../resources/schema` |
| subPackageNameClient | String | 1.0.0 | The package under `packageName` to place client classes. Default: `client` |
| subPackageNameDatafetchers | String | 1.0.0 | The package under `packageName` to place data fetcher classes. Default: `datafetchers` |
| subPackageNameTypes | String | 1.0.0 | The package under `packageName` to place types. Default: `types` |
| language | String | 1.0.0 | The programming language that generated classes should use. Valid values are KOTLIN and JAVA. Default is inferred from the classpath |
| typeMapping | Map | 1.0.0 | A map from GraphQL type name to Java class name, e.g. for scalars |
| generateBoxedTypes | boolean | 1.0.0 | Whether to use boxed types, e.g. `java.lang.Integer`, for non-nullable fields (nullable fields must use boxed types, so that `null` can represent absence of a value). Default: `false` |
| generateClient | boolean | 1.0.0 | Whether to generate classes for a GraphQL client. Default: `false` |
| generateDataTypes | boolean | 1.1.0 | Generate data types. Useful for only generating a Query API. Input types are still generated when `generateClient` is true. Default: `true` |
| generateInterfaces | boolean | 1.1.0 | Whether to generate additional interfaces with an 'I' prefix for classes. Default: `false` |
| generateKotlinNullableClasses | boolean | 1.4.0 | Whether to generate data classes matching GraphQL nullability. Default: `false` |
| generateKotlinClosureProjections | boolean | 1.4.0 | ????. Default: `false` |
| generateInterfaceSetters | boolean | 1.3.0 | Whether to include setters in generated interfaces. Default: `true` |
| outputDir | File | 1.0.0 | The directory to place generated classes. Default: `${project.build.directory}/generated-sources/annotations/` |
| examplesOutputDir | File | 1.0.0 | The directory to place generated examples. Default: `${project.build.directory}/generated-examples` |
| includeQueries | String[] | 1.0.0 | If present, only generate classes for the queries specified in this list |
| includeMutations | String[] | 1.0.0 | If present, only generate classes for the mutations in this list |
| includeSubscriptions | String[] | 1.3.0 | If present, only generate classes for the subscriptions in this list |
| skipEntityQueries | boolean | 1.0.0 | Whether to skip [entity](https://www.apollographql.com/docs/federation/entities/) queries. Default: `false` |
| shortProjectionNames | boolean | 1.0.0 | Whether to shorten projection names. See [`ClassnameShortener`](https://github.com/Netflix/dgs-codegen/blob/master/graphql-dgs-codegen-core/src/main/kotlin/com/netflix/graphql/dgs/codegen/generators/shared/ClassnameShortener.kt). e.g. "ThisIsATest" becomes "ThIsATe". Default: `false` |
| omitNullInputFields | boolean | 1.2.0 | If `true`, fields with null values won't be included in `toString()` output. Default: `false` |
| maxProjectionDepth | int | 1.1.0 | Maximum projection depth to generate. Useful for (federated) schemas with very deep nesting. Default: `10` |
| kotlinAllFieldsOptional | boolean | 1.2.0 | If `true`, generates nullable fields in Kotlin even when a field is defined non-nullable in the schema. Default: `false` |
| snakeCaseConstantNames | boolean | 1.2.0 | If `true`, constants will be named in snake case e.g. `PERSON_META_DATA`. If false, they will be named without underscores, e.g. `PERSONMETADATA`. Default: `false` |
| generateCustomAnnotations | boolean | 1.4.0 | Whether to generate custom annotations. Default: `false` |
| includeImports | Map | 1.4.0 | Maps the custom annotation type to the package the annotations belong to. Only used when generateCustomAnnotations is enabled |
| includeEnumImports | Map | 1.4.0 | Maps the custom annotation and enum argument names to the enum packages. Only used when generateCustomAnnotations is enabled |
| javaGenerateAllConstructor | boolean | 1.4.0 | Whether to generate an all-arg constructor for data classes. Default: `true` |
| implementSerializable | boolean | 1.4.0 | Whether generated classes implement Serializable. Default: `false` |
| addGeneratedAnnotation | boolean | 1.4.0 | Whether to generate and apply a class-retention Generated annotation. Default: `false` |
| addDeprecatedAnnotation | boolean | 1.4.0 | Whether to add the Deprecated annotation to schema fields with a deprecated directive. Default: `false` |
## Upgrading the core
It's likely that the Gradle plugin will be updated more frequently than I update this Maven plugin. Provided their
changes are backwards-compatible, you don't have to wait for a release of the Maven plugin to pick up a change. You can
simply [override the version](https://blog.sonatype.com/2008/04/how-to-override-a-plugins-dependency-in-maven/) of
`graphql-dgs-codegen-core` to use the newer version. There's an example of how to do that
[here](https://github.com/michaelboyles/dgs-codegen-maven-plugin/blob/develop/src/it/basicTest/pom.xml#L42).