`formatAnnotations()` removes line breaks between type annotations and types #1275

mernst · 2022-08-12T13:47:45Z

Type annotations should be on the same line as the type that they qualify.

  @Override
  @Deprecated
  @Nullable @Interned String s;

However, some tools format them incorrectly, like this:

  @Override
  @Deprecated
  @Nullable
  @Interned
  String s;

This pull request adds a formatAnnotations() step to correct the incorrect formatting.

…types

lib/src/main/java/com/diffplug/spotless/java/TypeAnnotationsStep.java

nedtwigg

Thanks for the PR! There are a few documentation bits missing:

there should be a TOC entry here https://github.com/diffplug/spotless/tree/main/plugin-gradle#table-of-contents
a quick example in the java section https://github.com/diffplug/spotless/tree/main/plugin-gradle#java
and then more detailed docs (linked from the TOC entry) like so https://github.com/diffplug/spotless/tree/main/plugin-gradle#simple

I have a grip (noted line above) about backward-compatibility and your giant magic value, I think maybe writing the details docs will help you think about the API a bit.

(Also don't worry about the CodeQL Regex gripes above, I think it's fine)

lib/src/main/java/com/diffplug/spotless/java/TypeAnnotationsStep.java

…eAnnotations

mernst · 2022-08-28T21:42:45Z

@nedtwigg I believe I have addressed your concerns. Could you take another look at the pull request? Thanks!

lib/src/main/java/com/diffplug/spotless/java/FormatAnnotationsStep.java

+						continue;
+					}
+					lines[i] = "";
+					lines[i + 1] = line.replaceAll("\\s+$", "") + " " + nextLine.replaceAll("^\\s+", "");


lib/src/main/java/com/diffplug/spotless/java/FormatAnnotationsStep.java

+		 */
+		boolean endsWithTypeAnnotation(String unixLine) {
+			// Remove trailing newline.
+			String line = unixLine.replaceAll("\\s+$", "");


…thanks to diffplug#1224 and diffplug#1228.

nedtwigg · 2022-09-14T00:19:24Z

Thanks very much for a great PR, sorry it took so long to get merged. This will be released by tomorrow morning!

mernst · 2022-09-14T00:45:14Z

Great, thank you for doing that.

nedtwigg · 2022-09-14T05:58:47Z

Released in plugin-gradle 6.11.0 and plugin-maven 2.26.0.

mernst · 2022-09-14T16:24:50Z

FYI, 2.30.0 has not yet shown up at
https://mvnrepository.com/artifact/com.diffplug.spotless/spotless-lib

I wonder whether that is related to the fact that the deploy and ext_deploy CircleCI checks are still yellow (in process) here:
https://github.com/diffplug/spotless/runs/8343619107

nedtwigg · 2022-09-14T17:51:12Z

Just a slow sync on the Sonatype side, should be resolved now (#1319).

chkpnt · 2022-10-11T13:10:21Z

lib/src/main/java/com/diffplug/spotless/java/FormatAnnotationsStep.java

+					"UpperBoundBottom",
+					"UpperBoundLiteral",
+					"UpperBoundUnknown",
+					"Value",


Which @Value-annotation is this? I've just stumbled over this, as formatAnnotations() removed a newline in my code base for a field annotation org.springframework.beans.factory.annotation.Value, which isn't a type annotation (@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE})).

Maybe this list should contain the fully-qualified name of the annotations. But yeah, the implementation would be more challenging.

As per the docs, you can use addTypeAnnotation and removeTypeAnnotation to tweak for your case.

It's referring to lombok.Value. I agree that fully-qualified names are the way to go. This would be trivial in (say) google-java-format -- the mechanism already exists -- but would require much more work within Spotless.

#1367 changes @Value from a type annotation.

Thanks for the clarification!

As you mention google-java-format: Have you thought about fixing this issue in the fork palantir-java-format? They seem to be more open for community contributions than Google.

As you mention google-java-format: Have you thought about fixing this issue in the fork palantir-java-format? They seem to be more open for community contributions than Google.

This is a good idea.

Is it actively maintained? I see only 3 substantive commits since April, and it has not integrated recent changes (including new features and bug commits) from google-java-format. An example is google/google-java-format@865cff01 from August 2021, which would be necessary.

It is well-enough maintained for my decision to use it. :-) (I needed an alternative to google-java-format that doesn't force me to use 100 chars lines and 2-spacing-indentation.)

In January, they cherry-picked several commits from upstream, so I assume they are inclined to keep up with google-java-format.

…0.0 (mulk/mulkcms2!6) This MR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [com.diffplug.spotless:spotless-maven-plugin](https://github.com/diffplug/spotless) | build | minor | `2.29.0` -> `2.30.0` | --- ### Release Notes <details> <summary>diffplug/spotless</summary> ### [`v2.30.0`](https://github.com/diffplug/spotless/blob/HEAD/CHANGES.md#2300---2022-09-14) ##### Added - `formatAnnotations()` step to correct formatting of Java type annotations. It puts type annotations on the same line as the type that they qualify. Run it after a Java formatting step, such as `googleJavaFormat()`. ([#1275](diffplug/spotless#1275)) ##### Changes - Bump default `ktfmt` version to latest `0.39` -> `0.40` ([#1312](diffplug/spotless#1312)) - Bump default `ktlint` version to latest `0.46.1` -> `0.47.1` ([#1303](diffplug/spotless#1303)) - Also restored support for older versions of ktlint back to `0.31.0` </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

mernst added 4 commits August 12, 2022 06:44

typeAnnotations() removes line breaks between type annotations and …

1c60826

…types

Add changelog entry

105eb87

Changelog in plugin-gradle, too

6d76fc9

Don't use Java 11 APIs

0c5d1b6

github-advanced-security bot found potential problems Aug 19, 2022

View reviewed changes

lib/src/main/java/com/diffplug/spotless/java/TypeAnnotationsStep.java Fixed Show fixed Hide fixed

lib/src/main/java/com/diffplug/spotless/java/TypeAnnotationsStep.java Fixed Show fixed Hide fixed

nedtwigg requested changes Aug 19, 2022

View reviewed changes

lib/src/main/java/com/diffplug/spotless/java/TypeAnnotationsStep.java Outdated Show resolved Hide resolved

mernst added 13 commits August 25, 2022 09:28

Add documentation in README.md

42edcb1

Merge ../spotless into typeAnnotations

712d77a

Fix indentation

4ad48a9

The Checker Framework supports most known type annotations.

e886d24

Add line to table

8666f98

Tweak comment

68e4217

Add Maven support

e69ab4b

Fix test name

61da1b2

Define "type annotation"

9553e60

No reordering

d7cd9fd

Whitespace

d8f047e

List of type annotations is hard-coded

437636b

Merge ../spotless into typeAnnotations

45cb9e4

mernst changed the title ~~typeAnnotations() removes line breaks between type annotations and types~~ formatAnnotations() removes line breaks between type annotations and types Aug 28, 2022

mernst and others added 4 commits August 28, 2022 14:09

Support addTypeAnnotation() and removeTypeAnnotation()

d8b8a86

Merge branch 'typeAnnotations' of github.com:mernst/spotless into typ…

48394fe

…eAnnotations

Tweaks

263da38

Tabify

0404062

github-advanced-security bot found potential problems Aug 29, 2022

View reviewed changes

nedtwigg added 4 commits September 13, 2022 17:04

Merge branch 'main' into typeAnnotations

56b0ec9

Remove workarounds to diffplug#834 because they are no longer needed …

ef219c0

…thanks to diffplug#1224 and diffplug#1228.

Keep the step-specific sections specific to their section.

61d362b

Fix TOC entry to match the new formatAnnotations name.

7a434ce

Minor tweak to changelog.

78cd2ef

nedtwigg enabled auto-merge September 14, 2022 00:18

nedtwigg approved these changes Sep 14, 2022

View reviewed changes

nedtwigg disabled auto-merge September 14, 2022 04:41

nedtwigg merged commit 3a1104f into diffplug:main Sep 14, 2022

mernst deleted the typeAnnotations branch September 14, 2022 16:20

chkpnt reviewed Oct 11, 2022

View reviewed changes

nedtwigg mentioned this pull request Oct 11, 2022

formatAnnotations() contradicts Google Java style #1366

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`formatAnnotations()` removes line breaks between type annotations and types #1275

`formatAnnotations()` removes line breaks between type annotations and types #1275

mernst commented Aug 12, 2022 •

edited

Loading

nedtwigg left a comment •

edited

Loading

mernst commented Aug 28, 2022

nedtwigg commented Sep 14, 2022

mernst commented Sep 14, 2022

nedtwigg commented Sep 14, 2022

mernst commented Sep 14, 2022

nedtwigg commented Sep 14, 2022

chkpnt Oct 11, 2022

nedtwigg Oct 11, 2022

mernst Oct 11, 2022

mernst Oct 11, 2022

chkpnt Oct 13, 2022

mernst Oct 13, 2022

chkpnt Oct 13, 2022 •

edited

Loading

formatAnnotations() removes line breaks between type annotations and types #1275

formatAnnotations() removes line breaks between type annotations and types #1275

Conversation

mernst commented Aug 12, 2022 • edited Loading

nedtwigg left a comment • edited Loading

Choose a reason for hiding this comment

mernst commented Aug 28, 2022

nedtwigg commented Sep 14, 2022

mernst commented Sep 14, 2022

nedtwigg commented Sep 14, 2022

mernst commented Sep 14, 2022

nedtwigg commented Sep 14, 2022

chkpnt Oct 11, 2022

Choose a reason for hiding this comment

nedtwigg Oct 11, 2022

Choose a reason for hiding this comment

mernst Oct 11, 2022

Choose a reason for hiding this comment

mernst Oct 11, 2022

Choose a reason for hiding this comment

chkpnt Oct 13, 2022

Choose a reason for hiding this comment

mernst Oct 13, 2022

Choose a reason for hiding this comment

chkpnt Oct 13, 2022 • edited Loading

Choose a reason for hiding this comment

`formatAnnotations()` removes line breaks between type annotations and types #1275

`formatAnnotations()` removes line breaks between type annotations and types #1275

mernst commented Aug 12, 2022 •

edited

Loading

nedtwigg left a comment •

edited

Loading

chkpnt Oct 13, 2022 •

edited

Loading