palantir / palantir/palantir-java-format

Wrapping enhancements for records

Open
#834 1 comment 10 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
907
Forks
101
Avg merge
1d 3h
Merged PRs (30d)
19

Description

What happened?

Original:

public record ExtensionDTO(
        String extensionClass,
        boolean started,
        boolean running,
        List<String> extensionPointClasses
) implements ControllerDTO {
}

palantir-java-format output:

public record ExtensionDTO(String extensionClass, boolean started, boolean running, List<String> extensionPointClasses)
        implements ControllerDTO {}

What did you want to happen?

The original format is more readable for humans, so I suggest there can be some enhancements:

  1. Place each record component in a new line no matter how many components there are.
  2. Place the parent class or interface in a new line.

These enhancements can make the code easier for humans to read.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no source files, tests, or entry points. Start by locating the record-formatting logic and relevant formatter tests, then reproduce the ExtensionDTO example. Done means the formatter consistently applies the two requested wrapping rules and the behavior is covered by tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.