detekt-test-utils/dev.detekt.test.utils

Package-level declarations

Types

KotlinAnalysisApiEngine

class KotlinAnalysisApiEngine : AutoCloseable

The object to use the Kotlin Analysis API for code compilation.

KotlinEnvironmentContainer

class KotlinEnvironmentContainer(val javaSourceRoots: List<Path>, val jvmClasspathRoots: List<Path>)

NullPrintStream

class NullPrintStream : PrintStream

StringPrintStream

class StringPrintStream : PrintStream

Functions

compileContentForTest

fun compileContentForTest(content: String, path: Path): KtFile

fun compileContentForTest(content: String, filename: String = "Test.kt"): KtFile

fun compileContentForTest(content: String, environment: KotlinEnvironmentContainer, kotlinAnalysisApiEngine: KotlinAnalysisApiEngine, filename: String = "Test.kt"): KtFile

Use this method if you define a kt file/class as a plain string in your test.

fun compileForTest(path: Path): KtFile

Use this method if you test a kt file/class in the test resources.

createEnvironment

fun createEnvironment(additionalJavaSourceRootPaths: List<Path> = emptyList()): KotlinEnvironmentContainer

Create a KotlinEnvironmentContainer used for test.

readResourceContent

fun readResourceContent(name: String): String

fun resource(name: String): URI

fun resourceAsPath(name: String): Path

fun resourceUrl(name: String): URL