saveourtool/diktat

Multiline TODO/FixME

Open

#969 opened on Jul 7, 2021

View on GitHub
 (1 comment) (0 reactions) (1 assignee)Kotlin (40 forks)github user discovery
enhancementgood first issue

Repository metrics

Stars
 (571 stars)
PR merge metrics
 (PR metrics pending)

Description

It could be useful to process multiline comments, marked as TODO or FixME as follows:

// TODO: comment1
// comment2
// comment3

Change to

// TODO: comment1
// TODO: comment2
// TODO: comment3

Details

IDEA have logic for highlighting with blue all lines, only if lines starting from the second have extra spaces at the beginning:

// TODO: comment
//  now it's highlights too

But by default only line with TODO/FixME keyword will be highlighted.

However, it's not good approach to add extra space during the fix, since after when TODO/FixME will be done, there is a big chance, that developer will remove only the first line from TODO/FixME comment, since only it was highlighted. In aim to avoid this, we need to add TODO/FixME on each line

Contributor guide

Research direction
Examine existing TODO/FixME rule implementation in diktat and extend it to process continuation lines by adding the TODO/FixME keyword to each line.
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.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
Kotlin
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75