palantir / palantir/palantir-java-format

Wrong indentation formatting multiple long method param annotations

Open
#799 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

What happened?

When formatting the following snippet, the method parameter annotations are not aligned. I.e. this is the formatting output using version 2.26.0:

interface MyClass {

    MyCustomReturnType getReturnType(
            @Nullable
                    @DoNotLog
                    @Request.Header(value = HttpHeaders.AUTHORIZATION, encoder = AuthHeaderParamEncoder.class)
                    AuthHeader authHeader);
}

What did you want to happen?

When breaking multiple param annotations into one line each, I would expect all annotations to have the same indentation level.

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

Use the Java snippet in issue #799 as the reproduction case and inspect how the formatter handles method parameter annotations when each annotation is placed on its own line. Compare the current output with the requested output, where all annotations share one indentation level; done means the formatting is corrected for this case without regressing related formatting.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.