Automatically manage trailing commas when running with --google-style #427

nreid260 · 2023-10-07T08:38:51Z

Commas are added/removed according to the following rules:

Lambda param lists => remove
Single element lists => remove
Lists that fit on one line => remove
All other lists (multiline lists) => add

nreid260 · 2023-10-07T08:40:41Z

I know we talked about this idea a bit several months ago. I've limited the impl to --google-style, but it could easily be expanded to more styles, or possibly a separate flag.

nreid260 · 2023-11-07T00:07:39Z

@hick209 Is anyone available to review?

hick209 · 2023-11-07T20:05:32Z

Hey @nreid260, sorry I'm out on paternity leave.

I'll ping the group internally to get into this though

facebook-github-bot · 2023-11-08T15:47:27Z

@strulovich has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

strulovich

Generally looks ok, and terribly sorry you had to wait for so long. A bunch of mostly style issues and requirement for extra documentation so it's easier to jump to and we should be good to go.

strulovich · 2023-11-08T15:51:06Z

core/src/main/java/com/facebook/ktfmt/format/Formatter.kt

+            .let { addRedundantElements(it, options) }
+            .let { convertLineSeparators(it, Newlines.guessLineSeparator(kotlinCode)!!) }
+
+    return if (shebang.isNotEmpty()) { shebang + "\n" + formatted } else { formatted }


Style nit: If we're restyling this, maybe add this check to the let chain as well

strulovich · 2023-11-08T15:51:42Z

core/src/main/java/com/facebook/ktfmt/format/FormattingOptions.kt

+    /** Remove and insert trialing commas based on how the code would format without them. */
+    val manageTrailingCommas: Boolean = false,


Could you please elaborate more? The best way would be with 1-2 code examples that explain what the user can expect to see.

strulovich · 2023-11-08T15:53:22Z

core/src/main/java/com/facebook/ktfmt/format/RedundantElementManager.kt

+    file.accept(
+        object : KtTreeVisitorVoid() {
+          override fun visitKtElement(element: KtElement) {
+            trailingCommaSuggestor.takeElement(element)
+            super.visitElement(element)
+          }
+        })


You can just use forEachDescendantOfType or collectDescendantsOfType for shorter and simpler code.

takeElement decides which elements to track. It would be error prone to duplicate that knowledge into the traversal.

I don't think I understood your comment, I was suggesting:

file.forEachDescendantOfType<KtElement> { trailingommaSuggestor.takeElement(element) }

strulovich · 2023-11-08T15:54:42Z

core/src/main/java/com/facebook/ktfmt/format/TrailingCommas.kt

+
+    fun takeElement(element: KtElement) {
+      if (!element.text.contains("\n")) {
+        return // Only suggest trailing commas where there is already a line break


Again, a bunch of code examples above the method would really help people maintaining this years from now

strulovich · 2023-11-08T15:55:04Z

core/src/main/java/com/facebook/ktfmt/format/TrailingCommas.kt

+    }
+  }
+
+  private fun PsiElement.leftLeafIgnoringCommentsAndWhitespace(): PsiElement {


Add examples code and what it means

strulovich · 2023-11-08T15:55:58Z

core/src/main/java/com/facebook/ktfmt/format/TrailingCommas.kt

+    // TODO(nickreid): What about:
+    //  - function-type param lists
+    //  - destructuring declarations


This is not Meta style, so let's try to stick to something that's more applicable: Can you open issues and link to them from the TODO instead? You can have the issues assigned to you.

davidtorosyan · 2023-11-09T18:23:10Z

core/src/main/java/com/facebook/ktfmt/format/RedundantElementManager.kt

      result.replace(element.startOffset, element.endOffset, replacement)
    }

    return result.toString()
  }

+  fun addRedundantElements(code: String, options: FormattingOptions): String {
+    // TODO(nickreid): Generalize this for addtional sugested elements.


Same comment here re: TODOs

davidtorosyan · 2023-11-09T18:26:59Z

core/src/main/java/com/facebook/ktfmt/format/Formatter.kt

+    return kotlinCode
+      .let { convertLineSeparators(it) }
+      .let { sortedAndDistinctImports(it) }
+      .let { dropRedundantElements(it, options) }
+      .let { prettyPrint(it, options, "\n") }
+      .let { addRedundantElements(it, options) }
+      .let { convertLineSeparators(it, Newlines.guessLineSeparator(kotlinCode)!!) }
+      .let { if (shebang.isEmpty()) it else shebang + "\n" + it }


Commas are added/removed according to the following rules: - Lambda param lists => remove - Single element lists => remove - Lists that fit on one line => remove - All other lists (multiline lists) => add

strulovich

LGTM

strulovich · 2023-11-11T01:43:24Z

core/src/main/java/com/facebook/ktfmt/format/RedundantElementManager.kt

+    file.accept(
+        object : KtTreeVisitorVoid() {
+          override fun visitKtElement(element: KtElement) {
+            trailingCommaSuggestor.takeElement(element)
+            super.visitElement(element)
+          }
+        })


I don't think I understood your comment, I was suggesting:

file.forEachDescendantOfType<KtElement> { trailingommaSuggestor.takeElement(element) }

facebook-github-bot · 2023-11-11T01:45:47Z

@strulovich has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

nreid260 · 2023-11-11T06:04:39Z

Ooooh, yeah that seems fine.

facebook-github-bot · 2023-11-11T06:25:55Z

@strulovich merged this pull request in fa78077.

* upstream/main: Bump version to 0.47-SNAPSHOT Bump version to 0.47 Reformat Kotlin files Automatically manage trailing commas when running with --google-style (facebook#427)

facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Oct 7, 2023

nreid260 force-pushed the trailing_comma branch 2 times, most recently from 5aee7c8 to 663b6b9 Compare October 7, 2023 08:52

strulovich requested changes Nov 8, 2023

View reviewed changes

nreid260 force-pushed the trailing_comma branch from 663b6b9 to 91123b8 Compare November 8, 2023 22:28

nreid260 requested a review from strulovich November 8, 2023 22:43

davidtorosyan reviewed Nov 9, 2023

View reviewed changes

Automatically manage trailing commas when running with --google-style

b3e4fa6

Commas are added/removed according to the following rules: - Lambda param lists => remove - Single element lists => remove - Lists that fit on one line => remove - All other lists (multiline lists) => add

nreid260 force-pushed the trailing_comma branch from 91123b8 to b3e4fa6 Compare November 9, 2023 19:35

nreid260 requested a review from davidtorosyan November 9, 2023 19:35

strulovich reviewed Nov 11, 2023

View reviewed changes

facebook-github-bot closed this in fa78077 Nov 11, 2023

facebook-github-bot added the Merged label Nov 11, 2023

hongping-quora mentioned this pull request Mar 25, 2024

add trailing comma support to other non-google styles #442

Closed

nreid260 deleted the trailing_comma branch April 23, 2024 06:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Automatically manage trailing commas when running with --google-style #427

Automatically manage trailing commas when running with --google-style #427

nreid260 commented Oct 7, 2023

nreid260 commented Oct 7, 2023

nreid260 commented Nov 7, 2023

hick209 commented Nov 7, 2023

facebook-github-bot commented Nov 8, 2023

strulovich left a comment

strulovich Nov 8, 2023

nreid260 Nov 8, 2023

strulovich Nov 8, 2023

nreid260 Nov 8, 2023

strulovich Nov 8, 2023

nreid260 Nov 8, 2023

strulovich Nov 11, 2023

strulovich Nov 8, 2023

nreid260 Nov 8, 2023

strulovich Nov 8, 2023

nreid260 Nov 8, 2023

strulovich Nov 8, 2023

nreid260 Nov 8, 2023

davidtorosyan Nov 9, 2023

nreid260 Nov 9, 2023

davidtorosyan Nov 9, 2023

strulovich left a comment

strulovich Nov 11, 2023

facebook-github-bot commented Nov 11, 2023

nreid260 commented Nov 11, 2023

facebook-github-bot commented Nov 11, 2023

		/** Remove and insert trialing commas based on how the code would format without them. */
		val manageTrailingCommas: Boolean = false,

Automatically manage trailing commas when running with --google-style #427

Automatically manage trailing commas when running with --google-style #427

Conversation

nreid260 commented Oct 7, 2023

nreid260 commented Oct 7, 2023

nreid260 commented Nov 7, 2023

hick209 commented Nov 7, 2023

facebook-github-bot commented Nov 8, 2023

strulovich left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

strulovich left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

facebook-github-bot commented Nov 11, 2023

nreid260 commented Nov 11, 2023

facebook-github-bot commented Nov 11, 2023