palantir / palantir/palantir-java-format

Improve formatting for stacked annotations

Open
#310 4 comments 4 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?

        public void foo(
                @FirstAnnotation(value = SOME_CONSTANT, another = "string")
                        @SecondAnnotation(
                                something = SOME_CONSTANT,
                                array = {"one", "two", "three"})
                        @ThirdAnnotation("value")
                        MyType whatever,
                 MyOtherType somethingElse) {
        }

It's a bit difficult to see why it got formatted this way?

What did you want to happen?

        public void foo(
                @FirstAnnotation(value = SOME_CONSTANT, another = "string")
                @SecondAnnotation(
                        something = SOME_CONSTANT,
                        array = {"one", "two", "three"})
                @ThirdAnnotation("value")
                MyType whatever,
                MyOtherType somethingElse) {
        }

When a parameter has multiple annotations, I'd like them to be aligned to the left.

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

Start by reproducing the Java formatting example in the issue and tracing how parameter annotations are laid out. Compare the current output with the requested output, where stacked annotations and the following parameter are left-aligned. Done means the formatter produces the requested alignment consistently for this example.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.