Disambiguating multiple formatted files when writing to standard output
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 38/100
Research direction
Start with the google-java-format CLI invocation shown in the issue, focusing on multi-file formatting sent to standard output. Determine a clear way to associate each formatted result with its source path, then verify the behavior with the four-file example and equivalent batched input.
Written by the indexing model from the issue text.
Description
When using google-java-format to format multiple files and print their formatted results to standard-out, it's unclear how I'm supposed to disambiguate between the results in the output. For performance reasons, I am running google-java-format against my codebase in batches of 100 files at a time, and for various other reasons, formatting in-place is not preferred.
For example, running this:
java -jar $HOME/bin/google-java-format --aosp path/to/file1.java path/to/file2.java path/to/file3.java path/to/file4.java
results in output like this:
/* my file 1 */
public class File1 {
// ...
}
/* my file 2 */
public class File2 {
// ...
}
/* my file 3 */
public class File3 {
// ...
}
/* my file 4 */
public class File4 {
// ...
}
This example is kind of contrived, but the main point is that the end of file1.java and the start of file2.java, and so on, are not delimited in a clear way. What can I do here to clearly associate the output for each formatted file with its source path?
- Dominant language
- Java
- Stars
- 6.2k
- Forks
- 936
- Avg merge
- 6m
- Merged PRs (30d)
- 3
Getting set up
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.
More from google/google-java-format
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
google/google-java-format#1094 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 15/100
google/google-java-format#1450 · 1 reaction ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 55/100
google/google-java-format#1439 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 3/5 1-2 days Newbie friendliness 62/100
google/google-java-format#1436 · 2 comments ·
Maintainers usually reply within 1 day
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
google/google-java-format#1428 · 4 comments ·
Maintainers usually reply within 1 day
All issues in google/google-java-format
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
checkstyle/checkstyle#21755 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
agentic-workflows
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/copilot-sdk#2782 ·
Maintainers usually reply within 1 day
-
documentation Good for newcomer quick win
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
CodeForPhilly/benefit-decision-toolkit#519 ·
Maintainers usually reply within 1 day
-
area-deployment triage:bot-seen triage:needs-human
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
microsoft/aspire#20533 · 1 comment ·
Maintainers usually reply within 1 day