com.apollographql.apollo.gradle.api.ApolloExtension.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of apollo-gradle-plugin Show documentation

Gradle plugin for generating java/kotlin classes for graphql files

There is a newer version: 4.1.0

package com.apollographql.apollo.gradle.api

import com.apollographql.apollo.gradle.internal.DefaultService
import org.gradle.api.Action
import org.gradle.api.provider.Property

/**
 * The entry point for configuring the apollo plugin.
 *
 * The apollo plugin creates a ApolloGenerateSourcesTask for each [CompilationUnit]. A [CompilationUnit]
 * is the combination of:
 * - a [Service]: an entity that describes a particular schema and GraphQL endpoint. If your project
 * interacts with several endpoints, you will needed several [Service].
 * - a variant: for android, this is the different variants as in https://developer.android.com/studio/build/build-variants.
 * For JVM, this is only main right now.
 *
 * Most of the configuration relies on [CompilerParams]. The [CompilerParams] are resolved in this order:
 * - ApolloExtension
 * - Service
 * - CompilationUnit
 *
 * CompilationUnit values override Service values which override the global ApolloExtension values.
 */
interface ApolloExtension: CompilerParams {

  /**
   * registers a new service
   *
   * @param name: the name of the service, must be unique
   * @param action: the configure action for the [Service]
   */
  fun service(name: String, action: Action)

  /**
   * [CompilationUnit] are created by the plugin based on the registered [Service]s and variants.
   * [onCompilationUnit] allows to retrieve and configure them.
   *
   * @param action: the configure action for the [CompilationUnit]
   */
  fun onCompilationUnit(action: Action)

}