wire-gradle-plugin/com.squareup.wire.gradle/WireExtension

WireExtension

open class WireExtension(project: Project)

Constructors

constructor(project: Project)

Types

Aggregates inputs for a run of Wire. Instances of this are either proto sources (these emit code) or proto paths (these are only used to resolve references).

Properties

dryRun

var dryRun: Boolean

True to not write generated types to disk, but emit the names of the source files that would otherwise be generated.

outputs

val outputs: MutableList<WireOutput>

Specified what types to output where. Maps to com.squareup.wire.schema.Target

protoLibrary

var protoLibrary: Boolean

True to emit .proto files into the output resources. Use this when your .jar file can be used as a library for other proto or Wire projects.

rejectUnusedRootsOrPrunes

var rejectUnusedRootsOrPrunes: Boolean

If true, Wire will fail if not all roots and prunes are used when tree-shaking the schema. This can help discover incorrect configurations early and avoid misexpectations about the built schema. See treeShakingRoots and treeShakingRubbish.

rules

var rules: String?

A user-provided file listing roots and prunes.

Functions

custom

fun custom(action: Action<CustomOutput>)

Defines a Custom target. See com.squareup.wire.schema.CustomTarget.

eventListenerFactories

fun eventListenerFactories(): Set<EventListener.Factory>

eventListenerFactory

fun eventListenerFactory(eventListenerFactory: EventListener.Factory)

Add a EventListener.Factory.

eventListenerFactoryClass

fun eventListenerFactoryClass(eventListenerFactoryClass: String)

Add a EventListener.Factory by name. The referred class must have a no-arguments constructor.

eventListenerFactoryClasses

fun eventListenerFactoryClasses(): Set<String>

java

fun java(action: Action<JavaOutput>)

Defines a Java target. See com.squareup.wire.schema.JavaTarget.

kotlin

fun kotlin(action: Action<KotlinOutput>)

Defines a Kotlin target. See com.squareup.wire.schema.KotlinTarget.

move

fun move(action: Action<Move>)

See com.squareup.wire.schema.WireRun.moves.

moves

fun moves(): List<Move>

onlyVersion

fun onlyVersion(): String?

fun onlyVersion(onlyVersion: String)

See com.squareup.wire.schema.WireRun.onlyVersion.

opaque

fun opaque(vararg opaques: String)

See com.squareup.wire.schema.WireRun.opaqueTypes.

opaques

fun opaques(): Set<String>

permitPackageCycles

fun permitPackageCycles(): Boolean

fun permitPackageCycles(permitPackageCycles: Boolean)

See com.squareup.wire.schema.WireRun.permitPackageCycles.

proto

fun proto(action: Action<ProtoOutput>)

Defines a Proto target. See com.squareup.wire.schema.ProtoTarget.

protoPath

fun protoPath(vararg protoPaths: String)

Proto paths for local jars and directories, as well as remote binary dependencies

fun protoPath(action: Action<WireExtension.ProtoRootSet>)

Proto paths for local file trees, backed by a org.gradle.api.file.SourceDirectorySet. Must provide at least a org.gradle.api.file.SourceDirectorySet.srcDir.

prune

fun prune(vararg prunes: String)

See com.squareup.wire.schema.WireRun.treeShakingRubbish.

prunes

fun prunes(): Set<String>

root

fun root(vararg roots: String)

See com.squareup.wire.schema.WireRun.treeShakingRoots.

roots

fun roots(): Set<String>

sinceVersion

fun sinceVersion(): String?

fun sinceVersion(sinceVersion: String)

See com.squareup.wire.schema.WireRun.sinceVersion.

sourcePath

fun sourcePath(vararg sourcePaths: String)

Source paths for local jars and directories, as well as remote binary dependencies

fun sourcePath(action: Action<WireExtension.ProtoRootSet>)

Source paths for local file trees, backed by a org.gradle.api.file.SourceDirectorySet. Must provide at least a org.gradle.api.file.SourceDirectorySet.srcDir.

untilVersion

fun untilVersion(): String?

fun untilVersion(untilVersion: String)

See com.squareup.wire.schema.WireRun.untilVersion.