saveourtool/diktat

Multiline strings and concatenation of strings

Open

#988 opened on Jul 16, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Kotlin (40 forks)github user discovery
enhancementgood first issuehelp wantedneeded

Repository metrics

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

Description

A lot of people follow java style and write the following code in Kotlin:

val a = "aaa \n" +
           "bbb \n" +
           "ccc \n"

We can make it look much better in kotlin like style:

val a = """
    |aaa
    |bbb
    |ccc
“””.trimMargin()

Diktat should be able to raise warnings in such case if the default mode is used. In fix mode (with -F option) it should automatically fix such code.

Contributor guide

Research direction
Study existing diktat rules to understand the pattern for detecting string concatenation and then implement a rule that suggests using multiline strings with trimMargin(). Follow the contribution guide in the repository.
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Kotlindiktat
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60