feat: configure Eclipse formatter for Spotless

[swetasamasti2310]

Title: feat: configure Eclipse formatter for Spotless
Description:

Changes

• Updated Eclipse formatter XML to match .editorconfig settings
• Changed indentation from 4 to 2 spaces
• Changed line length from 120 to 180 characters
• Enabled new lines before else/catch/finally
• Updated Spotless config to use Eclipse formatter

Testing

• Ran ./gradlew spotlessApply - formatting works correctly
• Ran ./gradlew spotlessCheck - all checks pass
• Verified 2-space indentation is applied

Resolves #378

[github-actions]

:java_duke: JaCoCo coverage report

Overall Project	46.12%	🔴

There is no coverage information present for the Files changed

[github-actions]

	Tests	Passed ✅	Skipped	Failed
Gradle Test Results (all modules & JDKs)	1520 ran	1520 passed	0 skipped	0 failed

Test	Result
No test annotations available

• View Gradle Test Results (all modules & JDKs)

[github-actions]

HTML test reports are available as workflow artifacts (zipped HTML).

• Download: Artifacts for this run

[github-actions]

HTML test reports are available as workflow artifacts (zipped HTML).

• Download: Artifacts for this run

[edeandrea]

Thanks for this @swetasamasti2310 !

See specific comments below.

Note that just running spotlessCheck or spotlessApply won't do anything unless there is a file which has changed. Spotless only looks at files that have changed status, so if you want to see what the rules are doing then you have to modify some files (add a blank line somewhere in a file will work).

One general comment I found when I tried this out. When I changed a file and re-ran spotlessApply I noticed that some enums got messed up:

Before

public enum ContentLayer {
    @JsonProperty("body") BODY,
    @JsonProperty("furniture") FURNITURE,
    @JsonProperty("background") BACKGROUND,
    @JsonProperty("invisible") INVISIBLE,
    @JsonProperty("notes") NOTES
  }

  public enum GroupLabel {
    @JsonProperty("unspecified") UNSPECIFIED,
    @JsonProperty("list") LIST,
    @JsonProperty("ordered_list") ORDERED_LIST,
    @JsonProperty("chapter") CHAPTER,
    @JsonProperty("section") SECTION,
    @JsonProperty("sheet") SHEET,
    @JsonProperty("slide") SLIDE,
    @JsonProperty("form_area") FORM_AREA,
    @JsonProperty("key_value_area") KEY_VALUE_AREA,
    @JsonProperty("comment_section") COMMENT_SECTION,
    @JsonProperty("inline") INLINE,
    @JsonProperty("picture_area") PICTURE_AREA
  }

After

  public enum ContentLayer {
    @JsonProperty("body") BODY, @JsonProperty("furniture") FURNITURE, @JsonProperty("background") BACKGROUND, @JsonProperty("invisible") INVISIBLE, @JsonProperty("notes") NOTES
  }

  public enum GroupLabel {
    @JsonProperty("unspecified") UNSPECIFIED, @JsonProperty("list") LIST, @JsonProperty("ordered_list") ORDERED_LIST, @JsonProperty("chapter") CHAPTER, @JsonProperty("section") SECTION, @JsonProperty("sheet") SHEET, @JsonProperty("slide") SLIDE, @JsonProperty("form_area") FORM_AREA, @JsonProperty("key_value_area") KEY_VALUE_AREA, @JsonProperty("comment_section") COMMENT_SECTION, @JsonProperty("inline") INLINE, @JsonProperty("picture_area") PICTURE_AREA
  }

Is there a way to ensure that enums constants stay on individual lines?

I also noticed that when I have chained items, like this:

request.headers()
          .map()
          .entrySet()
          .stream()
          .map(this::maskSensitiveHeaderValues)
          .forEach(entry -> stringBuilder.append("  %s: %s\n".formatted(entry.getKey(), String.join(", ", entry.getValue())))
      );

after re-running spotlessApply they get shrunk to a single line

request.headers().map().entrySet().stream().map(this::maskSensitiveHeaderValues).forEach(entry -> stringBuilder.append("  %s: %s\n".formatted(entry.getKey(), String.join(", ", entry.getValue())))
      );

Is there a way to turn that off?

[swetasamasti2310]

Thanks for this @swetasamasti2310 !

See specific comments below.

Note that just running spotlessCheck or spotlessApply won't do anything unless there is a file which has changed. Spotless only looks at files that have changed status, so if you want to see what the rules are doing then you have to modify some files (add a blank line somewhere in a file will work).

One general comment I found when I tried this out. When I changed a file and re-ran spotlessApply I noticed that some enums got messed up:

Before

public enum ContentLayer {
    @JsonProperty("body") BODY,
    @JsonProperty("furniture") FURNITURE,
    @JsonProperty("background") BACKGROUND,
    @JsonProperty("invisible") INVISIBLE,
    @JsonProperty("notes") NOTES
  }

  public enum GroupLabel {
    @JsonProperty("unspecified") UNSPECIFIED,
    @JsonProperty("list") LIST,
    @JsonProperty("ordered_list") ORDERED_LIST,
    @JsonProperty("chapter") CHAPTER,
    @JsonProperty("section") SECTION,
    @JsonProperty("sheet") SHEET,
    @JsonProperty("slide") SLIDE,
    @JsonProperty("form_area") FORM_AREA,
    @JsonProperty("key_value_area") KEY_VALUE_AREA,
    @JsonProperty("comment_section") COMMENT_SECTION,
    @JsonProperty("inline") INLINE,
    @JsonProperty("picture_area") PICTURE_AREA
  }

After

  public enum ContentLayer {
    @JsonProperty("body") BODY, @JsonProperty("furniture") FURNITURE, @JsonProperty("background") BACKGROUND, @JsonProperty("invisible") INVISIBLE, @JsonProperty("notes") NOTES
  }

  public enum GroupLabel {
    @JsonProperty("unspecified") UNSPECIFIED, @JsonProperty("list") LIST, @JsonProperty("ordered_list") ORDERED_LIST, @JsonProperty("chapter") CHAPTER, @JsonProperty("section") SECTION, @JsonProperty("sheet") SHEET, @JsonProperty("slide") SLIDE, @JsonProperty("form_area") FORM_AREA, @JsonProperty("key_value_area") KEY_VALUE_AREA, @JsonProperty("comment_section") COMMENT_SECTION, @JsonProperty("inline") INLINE, @JsonProperty("picture_area") PICTURE_AREA
  }

Is there a way to ensure that enums constants stay on individual lines?

I also noticed that when I have chained items, like this:

request.headers()
          .map()
          .entrySet()
          .stream()
          .map(this::maskSensitiveHeaderValues)
          .forEach(entry -> stringBuilder.append("  %s: %s\n".formatted(entry.getKey(), String.join(", ", entry.getValue())))
      );

after re-running spotlessApply they get shrunk to a single line

request.headers().map().entrySet().stream().map(this::maskSensitiveHeaderValues).forEach(entry -> stringBuilder.append("  %s: %s\n".formatted(entry.getKey(), String.join(", ", entry.getValue())))
      );

Is there a way to turn that off?

@edeandrea Earlier I tested with code change only but I didn't change for all the settings. Now I have done changes for these also i.e. Enum and chained items also. In addition to this settings. I have also changed other settings trying to make as similar as possible to the settings given in .editorConfig. Tested for each scenario with code changes.

[github-actions]

HTML test reports are available as workflow artifacts (zipped HTML).

• Download: Artifacts for this run

[edeandrea]

Thanks @swetasamasti2310

This may not be the behavior of the current .editorConfig, but is there a way to tell it that something like this

@JsonProperty("children")
@JsonSetter(
     nulls = Nulls.AS_EMPTY)
@lombok.Singular("child")
private List<RefItem> children;

Should be this?

@JsonProperty("children")
@JsonSetter(nulls = Nulls.AS_EMPTY)
@lombok.Singular("child")
private List<RefItem> children;

The carriage return in the annotation parameter - there shouldn't be a preceding carriage return.

Similar with try & catch blocks:

try (
    InputStream is = (InputStream) body) {
  body = new String(is.readAllBytes(), StandardCharsets.UTF_8);
}
catch (
    IOException
    | InterruptedException e) {
  throw new DoclingServeClientException(e);
}

should be

try (InputStream is = (InputStream) body) {
  body = new String(is.readAllBytes(), StandardCharsets.UTF_8);
}
catch (IOException | InterruptedException e) {
  throw new DoclingServeClientException(e);
}

During a cast, there should also be an extra space

return (T) StreamResponse
          .body((InputStream)body)

should be

return (T) StreamResponse
          .body((InputStream) body)