KoScopeCreator

interface KoScopeCreator

Scope creator.

Creates a KoScope instance from the given set of files such as all project files, single module, path etc.

Inheritors

Properties

Link copied to clipboard
abstract val projectRootPath: String

Creates a path to the root project directory.

Functions

Link copied to clipboard

Creates a KoScope containing all of Kotlin files in the given directories.

Link copied to clipboard
abstract fun scopeFromDirectory(path: String, vararg paths: String): KoScope

Creates a KoScope containing all of Kotlin files in the given directory.

Link copied to clipboard
abstract fun scopeFromExternalDirectories(absolutePaths: Collection<String>): KoScope

Creates a KoScope containing all of Kotlin files in the given directories. Some features (as KoFile.projectPath, KoFile.moduleName) do not work with this method.

Link copied to clipboard
abstract fun scopeFromExternalDirectory(absolutePath: String, vararg paths: String): KoScope

Creates a KoScope containing all of Kotlin files in the given directory. Some features (as KoFile.projectPath, KoFile.moduleName) do not work with this method.

Link copied to clipboard
abstract fun scopeFromFile(path: String, vararg paths: String): KoScope

Creates a KoScope of a given file.

Link copied to clipboard
abstract fun scopeFromFiles(paths: Collection<String>): KoScope

Creates a KoScope of a given files.

Link copied to clipboard
abstract fun scopeFromModule(moduleName: String, vararg moduleNames: String): KoScope

Creates a KoScope containing all of Kotlin files in the module. Method does return Kotlin files present in build directories such as "build" and "target".

Link copied to clipboard
abstract fun scopeFromModules(moduleNames: Collection<String>): KoScope

Creates a KoScope containing all of Kotlin files in the module. Method does return Kotlin files present in build directories such as "build" and "target".

Link copied to clipboard
abstract fun scopeFromPackage(packagee: String, moduleName: String? = null, sourceSetName: String? = null): KoScope

Creates a KoScope containing all of Kotlin files in the given package. Method does return Kotlin files present in build directories such as "build" and "target".

Link copied to clipboard
abstract fun scopeFromProduction(moduleName: String? = null, sourceSetName: String? = null): KoScope

Creates a KoScope containing all of Kotlin files in the production source sets. The production source set is the source set which name does not start and ends with "test". Method does return Kotlin files present in build directories such as "build" and "target".

Link copied to clipboard
abstract fun scopeFromProject(moduleName: String? = null, sourceSetName: String? = null, ignoreBuildConfig: Boolean = true): KoScope

Creates a KoScope containing all of Kotlin files in the project. Method does return Kotlin files present in build directories such as "build" and "target".

Link copied to clipboard
abstract fun scopeFromSourceSet(sourceSetName: String, vararg sourceSetNames: String): KoScope

Creates a KoScope containing all of Kotlin files in source set. If the source set is present in multiple modules then all of them will be included. Method does return Kotlin files present in build directories such as "build" and "target".

Link copied to clipboard
abstract fun scopeFromSourceSets(sourceSetNames: Collection<String>): KoScope

Creates a KoScope containing all of Kotlin files in source set. If the source set is present in multiple modules then all of them will be included. Method does return Kotlin files present in build directories such as "build" and "target".

Link copied to clipboard
abstract fun scopeFromTest(moduleName: String? = null, sourceSetName: String? = null): KoScope

Creates a KoScope containing all of Kotlin files in the test source sets. The test source set is the source set which name starts or ends with "test". Method does return Kotlin files present in build directories such as "build" and "target".