Gradle Plugin/kotlinx.rpc.protoc/ProtoSourceSet

ProtoSourceSet

Available in a dev version: 0․11․0-grpc-190

How to configure

sealed interface ProtoSourceSet : SourceDirectorySet(source)

Represents a source set for proto files.

Acts like a SourceDirectorySet but also allows configuring protoc plugins.

All source sets have kotlinMultiplatform and grpcKotlinMultiplatform plugins by default. Use includeDefaultProtobufPlugin and includeDefaultGrpcPlugin to opt out.

Example:

kotlin.sourceSets {
    commonMain {
        proto {
            exclude("some.proto")
            plugin { getByName("myPlugin") }
        }
    }
}

Properties

asFileTree

abstract val asFileTree: FileTree?

asPath

abstract val asPath: String?

bsrDeps

abstract val bsrDeps: BufDepsExtension

BSR (Buf Schema Registry) module dependencies for this source set.

buildDependencies

abstract val buildDependencies: TaskDependency?

classesDirectory

abstract val classesDirectory: Provider<Directory?>?

destinationDirectory

abstract val destinationDirectory: DirectoryProperty?

displayName

abstract val displayName: String?

elements

abstract val elements: Provider<Set<FileSystemLocation?>?>?

excludes

abstract val excludes: Set<String?>?

fileImports

abstract val fileImports: ConfigurableFileCollection

A collection of proto files that are imported by this source set but do not belong to any other source set.

files

abstract val files: Set<File?>?

filter

abstract val filter: PatternFilterable?

imports

abstract val imports: SetProperty<ProtoSourceSet>

List of all imported proto source sets.

includeDefaultGrpcPlugin

abstract val includeDefaultGrpcPlugin: Property<Boolean>

Whether to include the default grpcKotlinMultiplatform protoc plugin for this source set.

includeDefaultProtobufPlugin

abstract val includeDefaultProtobufPlugin: Property<Boolean>

Whether to include the default kotlinMultiplatform protoc plugin for this source set.

includes

abstract val includes: Set<String?>?

isEmpty

abstract val isEmpty: Boolean

name

abstract val name: String?

plugins

abstract val plugins: SetProperty<ProtocPlugin>

Protoc plugins that will be applied to proto files in this source set.

singleFile

abstract val singleFile: File?

sourceDirectories

abstract val sourceDirectories: FileCollection?

srcDirs

abstract val srcDirs: Set<File?>?

srcDirTrees

abstract val srcDirTrees: Set<DirectoryTree?>?

Functions

addToAntBuilder

abstract fun addToAntBuilder(builder: Any?, nodeName: String?, type: FileCollection.AntType?)

abstract fun addToAntBuilder(builder: Any?, nodeName: String?): Any?

bsrDeps

abstract fun bsrDeps(configure: Action<BufDepsExtension>)

Configures the bsrDeps of this source set.

compiledBy

abstract fun <T : Task?> compiledBy(taskProvider: TaskProvider<T?>?, mapping: Function<T?, DirectoryProperty?>?)

contains

abstract operator fun contains(file: File?): Boolean

exclude

abstract fun exclude(excludeSpec: Closure<*>?): PatternFilterable?

abstract fun exclude(excludes: Iterable<String?>?): PatternFilterable?

abstract fun exclude(excludeSpec: Spec<FileTreeElement?>?): PatternFilterable?

abstract fun exclude(vararg excludes: String?): PatternFilterable?

extendsFrom

abstract fun extendsFrom(protoSourceSet: ProtoSourceSet)

Proto source sets that this source set extends from. All proto files from protoSourceSet will be used for code generation. All imports from protoSourceSet will be included as well, along with its BSR module dependencies. Its buf.lock file, if set, is adopted by this source set.

filter

abstract fun filter(filterClosure: Closure<*>?): FileCollection?

abstract fun filter(filterSpec: Spec<in File?>?): FileCollection?

importsAllFrom

abstract fun importsAllFrom(protoSourceSets: Provider<List<ProtoSourceSet>>)

Proto files from protoSourceSets will be available as import, but will not be used for code generation. Their BSR module dependencies are included as well, and the first buf.lock file found among them, if any, is adopted.

importsFrom

abstract fun importsFrom(protoSourceSet: ProtoSourceSet)

abstract fun importsFrom(protoSourceSet: Provider<ProtoSourceSet>)

Proto files from protoSourceSet will be available as import, but will not be used for code generation. Its BSR module dependencies are included as well, and its buf.lock file, if set, is adopted.

include

abstract fun include(includeSpec: Closure<*>?): PatternFilterable?

abstract fun include(includes: Iterable<String?>?): PatternFilterable?

abstract fun include(includeSpec: Spec<FileTreeElement?>?): PatternFilterable?

abstract fun include(vararg includes: String?): PatternFilterable?

iterator

abstract operator override fun iterator(): MutableIterator<File?>

matching

abstract fun matching(@DelegatesTo(value = PatternFilterable::class) filterConfigClosure: Closure<*>?): FileTree?

abstract fun matching(filterConfigAction: Action<in PatternFilterable?>?): FileTree?

abstract fun matching(patterns: PatternFilterable?): FileTree?

minus

abstract operator fun minus(collection: FileCollection?): FileCollection?

plugin

abstract fun plugin(plugin: ProtocPlugin, configure: Action<ProtocPlugin>? = null)

abstract fun plugin(configure: Action<ProtocPlugin>? = null, select: NamedDomainObjectContainer<ProtocPlugin>.() -> ProtocPlugin)

abstract fun plugin(provider: NamedDomainObjectProvider<ProtocPlugin>, configure: Action<ProtocPlugin>? = null)

abstract fun plugin(provider: Provider<ProtocPlugin>, configure: Action<ProtocPlugin>? = null)

Add a plugin to this source set and allows to configure it specifically for this source set.

plus

abstract operator fun plus(collection: FileCollection?): FileCollection?

abstract operator fun plus(fileTree: FileTree?): FileTree?

setExcludes

abstract fun setExcludes(excludes: Iterable<String?>?): PatternFilterable?

setIncludes

abstract fun setIncludes(includes: Iterable<String?>?): PatternFilterable?

setSrcDirs

abstract fun setSrcDirs(srcPaths: Iterable<*>?): SourceDirectorySet?

source

abstract fun source(source: SourceDirectorySet?): SourceDirectorySet?

srcDir

abstract fun srcDir(srcPath: Any?): SourceDirectorySet?

srcDirs

abstract fun srcDirs(vararg srcPaths: @Nullable Any?): SourceDirectorySet?

visit

abstract fun visit(@DelegatesTo(value = FileVisitDetails::class) visitor: Closure<*>?): FileTree?

abstract fun visit(visitor: Action<in FileVisitDetails?>?): FileTree?

abstract fun visit(visitor: FileVisitor?): FileTree?