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.

Sign up for GitHub

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

Jump to bottom

Function signature preceded by an annotation array #1694

Merged
merged 2 commits into from
Nov 5, 2022
Merged

Function signature preceded by an annotation array #1694

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e603d5
Handle function signature preceded by an annotation array similar to …
paul-dingemans Nov 2, 2022
6bde6a5
Fix lint violation
paul-dingemans Nov 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ if (node.isRoot()) {
* Read `.editorconfig` when running CLI with options `--stdin` and `--editorconfig` ([#1651](https://github.com/pinterest/ktlint/issue/1651))
* Do not add a trailing comma in case a multiline function call argument is found but no newline between the arguments `trailing-comma-on-call-site` ([#1642](https://github.com/pinterest/ktlint/issue/1642))
* Add missing `ktlint_disabled_rules` to exposed `editorConfigProperties` ([#1671](https://github.com/pinterest/ktlint/issue/1671))
* A function signature preceded by an annotation array should be handled similar as function preceded by a singular annotation `function-signature` ([#1690](https://github.com/pinterest/ktlint/issue/1690))

### Changed
* Update Kotlin development version to `1.7.20` and Kotlin version to `1.7.20`.
Expand Down
6 changes: 5 additions & 1 deletion ...mental/src/main/kotlin/com/pinterest/ktlint/ruleset/experimental/FunctionSignatureRule.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import com.pinterest.ktlint.core.api.DefaultEditorConfigProperties.indentStylePr
import com.pinterest.ktlint.core.api.DefaultEditorConfigProperties.maxLineLengthProperty
import com.pinterest.ktlint.core.api.EditorConfigProperties
import com.pinterest.ktlint.core.api.UsesEditorConfigProperties
import com.pinterest.ktlint.core.ast.ElementType.ANNOTATION
import com.pinterest.ktlint.core.ast.ElementType.ANNOTATION_ENTRY
import com.pinterest.ktlint.core.ast.ElementType.BLOCK
import com.pinterest.ktlint.core.ast.ElementType.BLOCK_COMMENT
Expand Down Expand Up @@ -132,7 +133,10 @@ public class FunctionSignatureRule :
var currentNode: ASTNode
while (iterator.hasNext()) {
currentNode = iterator.next()
if (currentNode.elementType != ANNOTATION_ENTRY && currentNode.elementType != WHITE_SPACE) {
if (currentNode.elementType != ANNOTATION &&
currentNode.elementType != ANNOTATION_ENTRY &&
currentNode.elementType != WHITE_SPACE
) {
return currentNode
}
}
Expand Down
30 changes: 30 additions & 0 deletions ...al/src/test/kotlin/com/pinterest/ktlint/ruleset/experimental/FunctionSignatureRuleTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1046,6 +1046,36 @@ class FunctionSignatureRuleTest {
.hasNoLintViolations()
}

@Test
fun `Issue 1690 - Given a function preceded by an annotation array`() {
val code =
"""
// $MAX_LINE_LENGTH_MARKER $EOL_CHAR
internal fun foo1(foo1: Foo, foo2: Foo): Foo =
"foooooooooooooooooooooooooooooooooooooo"

@Bar
internal fun foo2(foo1: Foo, foo2: Foo): Foo =
"foooooooooooooooooooooooooooooooooooooo"

@[Bar]
internal fun foo2(foo1: Foo, foo2: Foo): Foo =
"foooooooooooooooooooooooooooooooooooooo"

@[Bar1 Bar2 Bar3 Bar4 Bar5 Bar6 Bar7 Bar8 Bar9]
internal fun foo2(foo1: Foo, foo2: Foo): Foo =
"foooooooooooooooooooooooooooooooooooooo"

@[Bar1 // some comment
Bar2]
internal fun foo2(foo1: Foo, foo2: Foo): Foo =
"foooooooooooooooooooooooooooooooooooooo"
""".trimIndent()
functionSignatureWrappingRuleAssertThat(code)
.setMaxLineLength()
.hasNoLintViolations()
}

private companion object {
const val EOL_CHAR = '#'
const val UNEXPECTED_SPACES = " "
Expand Down