detekt/detekt

Support merging of baselines for gradle plugin

Open

#1,589 opened on Apr 15, 2019

View on GitHub
 (15 comments) (0 reactions) (0 assignees)Kotlin (834 forks)batch import
gradle-pluginhelp wantedimprovement

Repository metrics

Stars
 (6,942 stars)
PR merge metrics
 (Avg merge 4d 9h) (65 merged PRs in 30d)

Description

I'm trying to add some rules into the Whitelist but it has no effect on the report file. There is an example of UndocumentedPublicClass in MenuEntryView.kt that should be white listed.

//detekt.gradle
detekt {
    config = files("$rootDir/default-detekt-config.yml")
    filters = ".*build.*,.*/resources/.*,.*/tmp/.*"
    baseline = file("$rootDir/detekt-baseline.xml")
}

<!--detekt-baseline.xml-->
<?xml version="1.0" ?>
<SmellBaseline>
    <Whitelist>
        <ID>
            UndocumentedPublicClass:MenuEntryView.kt$com.foo.bar.menu.MenuEntryView.kt
        </ID>
    </Whitelist>
</SmellBaseline>

I don't manage to see what I'm missing into the documentation

Contributor guide

Research direction
Investigate how baselines are merged in the Gradle plugin by examining the plugin source code for baseline handling.
Tech stack
kotlin
Domain
tooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GradleKotlindetekt configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60