Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change default logging level of console apps #2871

Merged
merged 1 commit into from Feb 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion core/src/main/kotlin/utilities/DokkaLogging.kt
Expand Up @@ -39,7 +39,7 @@ fun interface MessageEmitter : (String) -> Unit {
}

class DokkaConsoleLogger(
val minLevel: LoggingLevel = LoggingLevel.DEBUG,
val minLevel: LoggingLevel = LoggingLevel.PROGRESS,
private val emitter: MessageEmitter = MessageEmitter.consoleEmitter
) : DokkaLogger {
private val warningsCounter = AtomicInteger()
Expand Down
Expand Up @@ -13,6 +13,7 @@ import org.jetbrains.dokka.testApi.testRunner.TestBuilder
import org.jetbrains.dokka.testApi.testRunner.TestMethods
import org.jetbrains.dokka.utilities.DokkaConsoleLogger
import org.jetbrains.dokka.utilities.DokkaLogger
import org.jetbrains.dokka.utilities.LoggingLevel

class MultiModuleDokkaTestGenerator(
configuration: DokkaConfiguration,
Expand Down Expand Up @@ -85,7 +86,7 @@ class MultiModuleTestBuilder : TestBuilder<MultiModuleTestMethods>() {
)
}

abstract class MultiModuleAbstractTest(logger: TestLogger = TestLogger(DokkaConsoleLogger())) :
abstract class MultiModuleAbstractTest(logger: TestLogger = TestLogger(DokkaConsoleLogger(LoggingLevel.DEBUG))) :
AbstractTest<MultiModuleTestMethods, MultiModuleTestBuilder, MultiModuleDokkaTestGenerator>(
::MultiModuleTestBuilder,
::MultiModuleDokkaTestGenerator,
Expand Down
Expand Up @@ -9,12 +9,13 @@ import org.jetbrains.dokka.model.doc.DocTag
import org.jetbrains.dokka.model.properties.PropertyContainer
import org.jetbrains.dokka.pages.*
import org.jetbrains.dokka.utilities.DokkaConsoleLogger
import org.jetbrains.dokka.utilities.LoggingLevel

fun testPage(callback: PageContentBuilder.DocumentableContentBuilder.() -> Unit): RawTestPage {
val content = PageContentBuilder(
EmptyCommentConverter,
KotlinSignatureProvider(EmptyCommentConverter, DokkaConsoleLogger()),
DokkaConsoleLogger()
KotlinSignatureProvider(EmptyCommentConverter, DokkaConsoleLogger(LoggingLevel.DEBUG)),
DokkaConsoleLogger(LoggingLevel.DEBUG)
).contentFor(
DRI.topLevel,
emptySet(),
Expand Down Expand Up @@ -51,4 +52,4 @@ internal object EmptyCommentConverter : CommentsToContentConverter {
styles: Set<Style>,
extras: PropertyContainer<ContentNode>
): List<ContentNode> = emptyList()
}
}
3 changes: 2 additions & 1 deletion plugins/base/src/test/kotlin/basic/FailOnWarningTest.kt
Expand Up @@ -5,6 +5,7 @@ import org.jetbrains.dokka.testApi.logger.TestLogger
import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
import org.jetbrains.dokka.utilities.DokkaConsoleLogger
import org.jetbrains.dokka.utilities.DokkaLogger
import org.jetbrains.dokka.utilities.LoggingLevel
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.assertThrows

Expand Down Expand Up @@ -116,7 +117,7 @@ class FailOnWarningTest : BaseAbstractTest() {
}

private class ZeroErrorOrWarningCountDokkaLogger(
logger: DokkaLogger = DokkaConsoleLogger()
logger: DokkaLogger = DokkaConsoleLogger(LoggingLevel.DEBUG)
) : DokkaLogger by logger {
override var warningsCount: Int = 0
override var errorsCount: Int = 0
Expand Down
Expand Up @@ -7,6 +7,7 @@ import org.jetbrains.dokka.model.doc.DocumentationNode
import org.jetbrains.dokka.plugability.DokkaContext
import org.jetbrains.dokka.testApi.logger.TestLogger
import org.jetbrains.dokka.utilities.DokkaConsoleLogger
import org.jetbrains.dokka.utilities.LoggingLevel
import org.junit.jupiter.api.Assertions.assertEquals
import org.junit.jupiter.api.BeforeEach
import org.junit.jupiter.api.Test
Expand Down Expand Up @@ -75,7 +76,7 @@ class ContextModuleAndPackageDocumentationReaderTest1 : AbstractContextModuleAnd
private val context by lazy {
DokkaContext.create(
configuration = configurationBuilder.build(),
logger = TestLogger(DokkaConsoleLogger()),
logger = TestLogger(DokkaConsoleLogger(LoggingLevel.DEBUG)),
pluginOverrides = emptyList()
)
}
Expand Down
Expand Up @@ -4,6 +4,7 @@ import org.jetbrains.dokka.base.transformers.documentables.ModuleAndPackageDocum
import org.jetbrains.dokka.links.DRI
import org.jetbrains.dokka.plugability.DokkaContext
import org.jetbrains.dokka.utilities.DokkaConsoleLogger
import org.jetbrains.dokka.utilities.LoggingLevel
import org.junit.jupiter.api.BeforeEach
import org.junit.jupiter.api.Test
import testApi.testRunner.TestDokkaConfigurationBuilder
Expand Down Expand Up @@ -36,7 +37,7 @@ class ContextModuleAndPackageDocumentationReaderTest3 : AbstractContextModuleAnd
private val context by lazy {
DokkaContext.create(
configuration = configurationBuilder.build(),
logger = DokkaConsoleLogger(),
logger = DokkaConsoleLogger(LoggingLevel.DEBUG),
pluginOverrides = emptyList()
)
}
Expand Down
Expand Up @@ -3,6 +3,7 @@ package transformers
import org.jetbrains.dokka.base.transformers.documentables.ModuleAndPackageDocumentationReader
import org.jetbrains.dokka.plugability.DokkaContext
import org.jetbrains.dokka.utilities.DokkaConsoleLogger
import org.jetbrains.dokka.utilities.LoggingLevel
import org.junit.jupiter.api.BeforeEach
import org.junit.jupiter.api.Test
import testApi.testRunner.TestDokkaConfigurationBuilder
Expand Down Expand Up @@ -52,14 +53,14 @@ class InvalidContentModuleAndPackageDocumentationReaderTest : AbstractContextMod
private val contextA by lazy {
DokkaContext.create(
configuration = configurationBuilderA.build(),
logger = DokkaConsoleLogger(),
logger = DokkaConsoleLogger(LoggingLevel.DEBUG),
pluginOverrides = emptyList()
)
}
private val contextB by lazy {
DokkaContext.create(
configuration = configurationBuilderB.build(),
logger = DokkaConsoleLogger(),
logger = DokkaConsoleLogger(LoggingLevel.DEBUG),
pluginOverrides = emptyList()
)
}
Expand Down
Expand Up @@ -12,6 +12,7 @@ import org.jetbrains.dokka.testApi.testRunner.TestBuilder
import org.jetbrains.dokka.testApi.testRunner.TestMethods
import org.jetbrains.dokka.utilities.DokkaConsoleLogger
import org.jetbrains.dokka.utilities.DokkaLogger
import org.jetbrains.dokka.utilities.LoggingLevel

class TemplatingDokkaTestGenerator(
configuration: DokkaConfiguration,
Expand Down Expand Up @@ -61,7 +62,7 @@ class TemplatingTestBuilder : TestBuilder<TemplatingTestMethods>() {
)
}

abstract class TemplatingAbstractTest(logger: TestLogger = TestLogger(DokkaConsoleLogger())) :
abstract class TemplatingAbstractTest(logger: TestLogger = TestLogger(DokkaConsoleLogger(LoggingLevel.DEBUG))) :
AbstractTest<TemplatingTestMethods, TemplatingTestBuilder, TemplatingDokkaTestGenerator>(
::TemplatingTestBuilder,
::TemplatingDokkaTestGenerator,
Expand Down
Expand Up @@ -120,13 +120,13 @@ class GlobalArguments(args: Array<String>) : DokkaConfiguration {
"WARN" -> LoggingLevel.WARN
"ERROR" -> LoggingLevel.ERROR
else -> {
println("""Failed to deserialize logging level, got $it expected one of
|"DEBUG", "PROGRESS", "INFO", "WARN", "ERROR", falling back to DEBUG""".trimMargin())
LoggingLevel.DEBUG
println("""Failed to deserialize logging level, got $it expected one of
|"DEBUG", "PROGRESS", "INFO", "WARN", "ERROR", falling back to PROGRESS""".trimMargin())
LoggingLevel.PROGRESS
}
}
}, toString = { it.toString() }
)).default(LoggingLevel.DEBUG)
)).default(LoggingLevel.PROGRESS)

override val modules: List<DokkaConfiguration.DokkaModuleDescription> = emptyList()

Expand Down