palantir / palantir/palantir-java-format

Special case log.*

Open
#40 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

What happened?

String.format is special cased such that parameters can be on their own line.
However there is no special handling for log methods.

What did you want to happen?

We should do the same for logging methods on org.slf4j.Logger, such that arguments (except exception) can stay on the same line if they fit.

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 locating the existing String.format special-case in the Java formatter and trace how method calls are classified. Compare that behavior with org.slf4j.Logger methods, including calls with an exception argument. Done means logging arguments can remain on the same line when they fit, while the exception is handled separately.

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.