palantir / palantir/palantir-java-format
Improve formatting for stacked annotations
Open
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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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