Skip to content

Apply spring java format#716

Closed
koppor wants to merge 2 commits into
mainfrom
apply-spring-java-format
Closed

Apply spring java format#716
koppor wants to merge 2 commits into
mainfrom
apply-spring-java-format

Conversation

@koppor

@koppor koppor commented Aug 19, 2025

Copy link
Copy Markdown
Member

Follow-up to #672

I think spring-javaformat is our last chance if we don't want to configure our own rules. The plugin is automatically activated in IntelliJ. For the code style, see https://github.com/spring-projects/spring-framework/wiki/Code-Style

spaces instead of tabs are activated.

We still need

  • Variable naming conventions
  • Custom intellij rules for import statements

The source formatter does not fundamentally change your code. For example, it will not change the order of import statements. It is effectively limited to adding or removing whitespace and line feed

We need to accept that else starts on the "first" column. ("Kernighan and Ritchie style") -> https://github.com/spring-projects/spring-framework/wiki/Code-Style#block-like-constructs-kr-style

This is OK for me.

If this new coe style is OK, setup .git blame ignore - as outlined at JabRef#10646 (comment). Do a merge commit, not a squash-merge.

Steps to test

Open the code in IntelliJ

Mandatory checks

  • I own the copyright of the code submitted and I license it under the MIT license
  • [.] Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
  • [.] Tests created for changes (if applicable)
  • [.] Manually tested changed features in running JabRef (always required)
  • [.] Screenshots added in PR description (if change is visible to the user)
  • [.] Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
  • [.] Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

@koppor koppor mentioned this pull request Aug 19, 2025
Closed
@calixtus

calixtus commented Aug 19, 2025 •
edited
Loading

Copy link
Copy Markdown
Member

This is not working for me.

takes wastes too much space:
grafik

worsens overview:
grafik

not working correctly with flow-style:
grafik

Is there another codestyle available in the spring utility?

@koppor koppor closed this Aug 19, 2025
@koppor koppor deleted the apply-spring-java-format branch August 19, 2025 14:01
@koppor

koppor commented Aug 19, 2025

Copy link
Copy Markdown
Member Author

The bad formatting was already posted 2023 at #663 (comment) - but I totally forgot about it.

@koppor

koppor commented Aug 19, 2025

Copy link
Copy Markdown
Member Author

note that google java format also cannot be used, because it does not support Markdown comments: google/google-java-format#1193

@koppor

koppor commented Aug 19, 2025

Copy link
Copy Markdown
Member Author

spotless is still no option: diffplug/spotless#2599

@koppor

koppor commented Aug 19, 2025

Copy link
Copy Markdown
Member Author

IntelliJ can use Eclipse formatter: https://github.com/krasa/EclipseCodeFormatter

@koppor koppor mentioned this pull request Aug 19, 2025
Closed
3 tasks
@tsantalis tsantalis mentioned this pull request Aug 19, 2025
Closed
tsantalis added a commit to tsantalis/RefactoringMiner that referenced this pull request Aug 19, 2025
@tsantalis
Improved matching of re-formatted group-comments (#976)
394affa 
JabRef/jabref-koppor#716
jabgui/src/main/java/org/jabref/gui/groups/GroupNodeViewModel.java
jabgui/src/main/java/org/jabref/gui/groups/GroupTreeViewModel.java
tsantalis added a commit to tsantalis/RefactoringMiner that referenced this pull request Aug 19, 2025
@tsantalis
Fix for failing tests. Improve comment mappings (#976)
fae5c6a 
JabRef/jabref-koppor#716
jabgui/src/main/java/org/jabref/gui/groups/GroupTreeViewModel.java
within method addSelectedEntries()
tsantalis added a commit to tsantalis/RefactoringMiner that referenced this pull request Aug 20, 2025
@tsantalis
Improve comment mappings (#976)
9d18cba 
JabRef/jabref-koppor#716
jabgui/src/main/java/org/jabref/gui/importer/NewEntryAction.java
tsantalis added a commit to tsantalis/RefactoringMiner that referenced this pull request Aug 20, 2025
@tsantalis
Fix matching of @see Javadoc tags (#976)
877b85a 
JabRef/jabref-koppor#716
org.jabref.gui.ClipBoardManager
tsantalis added a commit to tsantalis/RefactoringMiner that referenced this pull request Aug 20, 2025
@tsantalis
Fix matching of throws Javadoc tags (#976)
8df7013 
JabRef/jabref-koppor#716
jablib/src/main/java/org/jabref/logic/crawler/StudyRepository.java
tsantalis added a commit to tsantalis/RefactoringMiner that referenced this pull request Aug 21, 2025
@tsantalis
Assign comments to attributes more accurately (#976)
d9e3c80 
JabRef/jabref-koppor#716
jabgui/src/main/java/org/jabref/gui/maintable/ColumnPreferences.java
jabgui/src/main/java/org/jabref/gui/maintable/MainTableColumnModel.java
jabgui/src/main/java/org/jabref/gui/preferences/network/NetworkTab.java
jabgui/src/main/java/org/jabref/gui/preferences/websearch/WebSearchTab.java
jabgui/src/main/java/org/jabref/gui/groups/GroupTreeView.java
jabgui/src/main/java/org/jabref/gui/preferences/ai/AiTabViewModel.java
@tsantalis tsantalis mentioned this pull request Aug 21, 2025
Closed
tsantalis added a commit to tsantalis/RefactoringMiner that referenced this pull request Aug 21, 2025
@tsantalis
Improve matching of . in Javadocs (#976)
e528141 
JabRef/jabref-koppor#716
jabgui/src/main/java/org/jabref/gui/desktop/os/NativeDesktop.java
jablib/src/main/java/org/jabref/logic/importer/SearchBasedParserFetcher.java
jablib/src/main/java/org/jabref/logic/importer/Importer.java
jablib/src/main/java/org/jabref/model/database/BibDatabaseContext.java
@tsantalis tsantalis mentioned this pull request Aug 21, 2025
Closed
tsantalis added a commit to tsantalis/RefactoringMiner that referenced this pull request Aug 21, 2025
@tsantalis
Add comments after top-level type declaration in the package declaration
f2dce48 
JabRef/jabref-koppor#716
jabgui/src/main/java/org/jabref/gui/openoffice/Bootstrap.java
(#976)
tsantalis added a commit to tsantalis/RefactoringMiner that referenced this pull request Aug 21, 2025
@tsantalis
Improve matching of multi-line comments with differences in empty lines
84ea159 
JabRef/jabref-koppor#716
org.jabref.gui.openoffice.OOBibBase
(#976)
@tsantalis tsantalis mentioned this pull request Aug 21, 2025
Closed
tsantalis added a commit to tsantalis/RefactoringMiner that referenced this pull request Aug 21, 2025
@tsantalis
Support text block indentation reformatting (#976)
80797ce 
JabRef/jabref-koppor#716
jablib/src/test/java/org/jabref/logic/git/GitSyncServiceTest.java
@koppor koppor mentioned this pull request Sep 13, 2025
Merged
1 task
maorethians pushed a commit to maorethians/RefactoringMiner that referenced this pull request Jun 8, 2026
@tsantalis
Improved matching of re-formatted group-comments (tsantalis#976)
13502dc 
JabRef/jabref-koppor#716
jabgui/src/main/java/org/jabref/gui/groups/GroupNodeViewModel.java
jabgui/src/main/java/org/jabref/gui/groups/GroupTreeViewModel.java
maorethians pushed a commit to maorethians/RefactoringMiner that referenced this pull request Jun 8, 2026
@tsantalis
Fix for failing tests. Improve comment mappings (tsantalis#976)
4d6f5a6 
JabRef/jabref-koppor#716
jabgui/src/main/java/org/jabref/gui/groups/GroupTreeViewModel.java
within method addSelectedEntries()
maorethians pushed a commit to maorethians/RefactoringMiner that referenced this pull request Jun 8, 2026
@tsantalis
Improve comment mappings (tsantalis#976)
0f3a933 
JabRef/jabref-koppor#716
jabgui/src/main/java/org/jabref/gui/importer/NewEntryAction.java
maorethians pushed a commit to maorethians/RefactoringMiner that referenced this pull request Jun 8, 2026
@tsantalis
Fix matching of @see Javadoc tags (tsantalis#976)
cf95666 
JabRef/jabref-koppor#716
org.jabref.gui.ClipBoardManager
maorethians pushed a commit to maorethians/RefactoringMiner that referenced this pull request Jun 8, 2026
@tsantalis
Fix matching of throws Javadoc tags (tsantalis#976)
52a5ee8 
JabRef/jabref-koppor#716
jablib/src/main/java/org/jabref/logic/crawler/StudyRepository.java
maorethians pushed a commit to maorethians/RefactoringMiner that referenced this pull request Jun 8, 2026
@tsantalis
Assign comments to attributes more accurately (tsantalis#976)
5a90c88 
JabRef/jabref-koppor#716
jabgui/src/main/java/org/jabref/gui/maintable/ColumnPreferences.java
jabgui/src/main/java/org/jabref/gui/maintable/MainTableColumnModel.java
jabgui/src/main/java/org/jabref/gui/preferences/network/NetworkTab.java
jabgui/src/main/java/org/jabref/gui/preferences/websearch/WebSearchTab.java
jabgui/src/main/java/org/jabref/gui/groups/GroupTreeView.java
jabgui/src/main/java/org/jabref/gui/preferences/ai/AiTabViewModel.java
maorethians pushed a commit to maorethians/RefactoringMiner that referenced this pull request Jun 8, 2026
@tsantalis
Improve matching of . in Javadocs (tsantalis#976)
2e9ef93 
JabRef/jabref-koppor#716
jabgui/src/main/java/org/jabref/gui/desktop/os/NativeDesktop.java
jablib/src/main/java/org/jabref/logic/importer/SearchBasedParserFetcher.java
jablib/src/main/java/org/jabref/logic/importer/Importer.java
jablib/src/main/java/org/jabref/model/database/BibDatabaseContext.java
maorethians pushed a commit to maorethians/RefactoringMiner that referenced this pull request Jun 8, 2026
@tsantalis
Add comments after top-level type declaration in the package declaration
3bd0008 
JabRef/jabref-koppor#716
jabgui/src/main/java/org/jabref/gui/openoffice/Bootstrap.java
(tsantalis#976)
maorethians pushed a commit to maorethians/RefactoringMiner that referenced this pull request Jun 8, 2026
@tsantalis
Improve matching of multi-line comments with differences in empty lines
ffb22ca 
JabRef/jabref-koppor#716
org.jabref.gui.openoffice.OOBibBase
(tsantalis#976)
maorethians pushed a commit to maorethians/RefactoringMiner that referenced this pull request Jun 8, 2026
@tsantalis
Support text block indentation reformatting (tsantalis#976)
f0c44f9 
JabRef/jabref-koppor#716
jablib/src/test/java/org/jabref/logic/git/GitSyncServiceTest.java
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@koppor @calixtus