Skip to content

Remove empty lines in multiline comments for non-trailing imports #1415

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

Closed
lekhitha333 wants to merge 4 commits into from
+22 −2
Closed

Remove empty lines in multiline comments for non-trailing imports #1415

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eddd4c3
Remove empty lines in multiline comments for non-trailing imports (#1…
Jan 25, 2026
55d216e
spotlessApply
HT154 Jan 25, 2026
a89651a
Merge pull request #1 from apple/main
lekhitha333 Jan 26, 2026
0153393
Add snippet test for multi-line comment spacing
lekhitha333 Jan 26, 2026
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
5 changes: 4 additions & 1 deletion pkl-formatter/src/main/kotlin/org/pkl/formatter/Builder.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright © 2025 Apple Inc. and the Pkl project authors. All rights reserved.
* Copyright © 2025-2026 Apple Inc. and the Pkl project authors. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -1302,7 +1302,10 @@ internal class Builder(sourceText: String, private val grammarVersion: GrammarVe
}

private fun getBaseSeparator(prev: Node, next: Node): FormatNode? {

return when {
endsInLineComment(prev) && endsInLineComment(next) -> mustForceLine()
Copy link
Copy Markdown
Contributor

@stackoverflow stackoverflow Jan 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is too broad of a fix. You are changing how every line comment gets formatted.

// foo

// bar

The above code will have the newlines removed. You have to fix the import list specifically if you want to remove newlines from there.


endsInLineComment(prev) -> {
if (prev.linesBetween(next) > 1) {
TWO_NEWLINES
Expand Down
35 changes: 34 additions & 1 deletion pkl-formatter/src/test/kotlin/org/pkl/formatter/FormatterTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright © 2025 Apple Inc. and the Pkl project authors. All rights reserved.
* Copyright © 2025-2026 Apple Inc. and the Pkl project authors. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -120,4 +120,37 @@ class FormatterTest {
assertThat(format(src)).isEqualTo("\n")
}
}

@Test
fun `multi line comments - no extra empty lines`() {
val input =
"""
import "pkl:json" // used for doc comments
import "pkl:jsonnet"
import "pkl:math" // used for doc comments
import "pkl:pklbinary"
import "pkl:protobuf"
import "pkl:xml"
import "pkl:yaml" // used for doc comments
"""

val expected =
"""
// used for doc comments
// used for doc comments
// used for doc comments
import "pkl:json"
import "pkl:jsonnet"
import "pkl:math"
import "pkl:pklbinary"
import "pkl:protobuf"
import "pkl:xml"
import "pkl:yaml"

"""

val formatted = format(input)

assertThat(formatted).isEqualTo(expected.trimIndent())
}
}
Loading