saveourtool/diktat

New rule: Empty functions should be one-liner and return `Unit`

Open

#1,701 opened on Jun 29, 2023

View on GitHubContributor guide
 (2 comments) (1 reaction) (1 assignee)Kotlin (40 forks)github user discovery
enhancementgood first issue

Repository metrics

Stars
 (571 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

If for some reasons, function have no any logic, but exists only for some kind of execution: in cases of testing via JUnit Runners or JUnit Rules or some other purposes, it shouldn't have any body and should be fixed in the following way

@Test
@SomeAnnotation
fun foo() {
// no-op here
}

// no-op here
@Test
@SomeAnnotation
fun foo() = Unit

Contributor guide

Research direction
Review existing rule implementations in diktat for function related checks. Look at how rules check function bodies and annotations. Create a new rule that detects empty function bodies with the pattern shown and suggests replacing with '= Unit'.
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.
Clear
Prerequisites
KotlinGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75