Reformat codebase by subhramit · Pull Request #13872 · JabRef/jabref

subhramit · 2025-09-13T11:47:52Z

Use IntelliJ reformat with our config xml

Steps to test

Mandatory checks

I own the copyright of the code submitted and I license it under the MIT license
[/] I manually tested my changes in running JabRef (always required)
[/] I added JUnit tests for changes (if applicable)
[/] I added screenshots in the PR description (if change is visible to the user)
[/] I described the change in CHANGELOG.md in a way that is understandable for the average user (if change is visible to the user)
[/] I checked the user 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 updating file(s) in https://github.com/JabRef/user-documentation/tree/main/en.

subhramit · 2025-09-13T11:57:13Z

Lol this was more of a disaster than I presumed

koppor · 2025-09-13T12:37:55Z

Currently compile errors - I don't understand why they are introduced. Maybe, someone can look based on main, why some formatting changes lead to compile errors:

Compiling with JDK Java compiler API.
/home/runner/work/jabref/jabref/jablib/src/main/java/org/jabref/model/entry/field/StandardField.java:198: error: name() in StandardField cannot override name() in Enum
    public String name() {
                  ^
  overridden method is final
/home/runner/work/jabref/jabref/jablib/src/main/java/org/jabref/model/entry/types/StandardEntryType.java:54: error: name() in StandardEntryType cannot override name() in Enum
    public String name() {
                  ^
  overridden method is final
warning: unknown enum constant Id.CLASS
  reason: class file for com.fasterxml.jackson.annotation.JsonTypeInfo$Id not found
/home/runner/work/jabref/jabref/jablib/src/main/java/org/jabref/logic/layout/format/NameFormatterPreferences.java:12: error: constructor is not canonical, so it must invoke another constructor of class NameFormatterPreferences
    public NameFormatterPreferences(List<String> nameFormatterKey, List<String> nameFormatterValue) {
           ^
/home/runner/work/jabref/jabref/jablib/src/main/java/org/jabref/logic/protectedterms/ProtectedTermsPreferences.java:14: error: constructor is not canonical, so it must invoke another constructor of class ProtectedTermsPreferences
    public ProtectedTermsPreferences(List<String> enabledInternalTermLists,
           ^
/home/runner/work/jabref/jabref/jablib/src/main/java/org/jabref/logic/util/UnknownFileType.java:11: error: constructor is not canonical, so it must invoke another constructor of class UnknownFileType
    public UnknownFileType(String... extensions) {
           ^
/home/runner/work/jabref/jabref/jablib/src/main/java/org/jabref/model/entry/field/InternalField.java:83: error: name() in InternalField cannot override name() in Enum
    public String name() {
                  ^
  overridden method is final
/home/runner/work/jabref/jabref/jablib/src/main/java/org/jabref/model/entry/field/BiblatexSoftwareField.java:63: error: name() in BiblatexSoftwareField cannot override name() in Enum
    public String name() {
                  ^
  overridden method is final
/home/runner/work/jabref/jabref/jablib/src/main/java/org/jabref/model/entry/field/AMSField.java:51: error: name() in AMSField cannot override name() in Enum
    public String name() {
                  ^
  overridden method is final
/home/runner/work/jabref/jabref/jablib/src/main/java/org/jabref/model/entry/field/BiblatexApaField.java:65: error: name() in BiblatexApaField cannot override name() in Enum
    public String name() {
                  ^
  overridden method is final
/home/runner/work/jabref/jabref/jablib/src/main/java/org/jabref/model/entry/field/SpecialField.java:93: error: name() in SpecialField cannot override name() in Enum
    public String name() {
                  ^
  overridden method is final
/home/runner/work/jabref/jabref/jablib/src/main/java/org/jabref/model/entry/field/IEEEField.java:39: error: name() in IEEEField cannot override name() in Enum
    public String name() {
                  ^
  overridden method is final
/home/runner/work/jabref/jabref/jablib/src/main/java/org/jabref/model/entry/types/BiblatexSoftwareEntryType.java:27: error: name() in BiblatexSoftwareEntryType cannot override name() in Enum
    public String name() {
                  ^
  overridden method is final
/home/runner/work/jabref/jabref/jablib/src/main/java/org/jabref/model/entry/types/SystematicLiteratureReviewStudyEntryType.java:25: error: name() in SystematicLiteratureReviewStudyEntryType cannot override name() in Enum
    public String name() {
                  ^
  overridden method is final
/home/runner/work/jabref/jabref/jablib/src/main/java/org/jabref/model/entry/types/IEEETranEntryType.java:27: error: name() in IEEETranEntryType cannot override name() in Enum
    public String name() {
                  ^
  overridden method is final
/home/runner/work/jabref/jabref/jablib/src/main/java/org/jabref/model/entry/types/BiblatexApaEntryType.java:28: error: name() in BiblatexApaEntryType cannot override name() in Enum
    public String name() {
                  ^
  overridden method is final
/home/runner/work/jabref/jabref/jablib/src/main/java/org/jabref/model/openoffice/rangesort/RangeSort.java:66: error: constructor is not canonical, so it must invoke another constructor of class HolderComparatorWithinPartition
            private HolderComparatorWithinPartition(XText cmp) {
                    ^

koppor · 2025-09-13T12:38:36Z

This is an alternative to JabRef#717

trag-bot · 2025-09-13T13:08:53Z

.jbang/JabSrvLauncher.java

@@ -1,4 +1,4 @@
-///usr/bin/env jbang "$0" "$@" ; exit $?
+/// usr/bin/env jbang "$0" "$@" ; exit $?


Code reformatting without adding new statements violates best practices. The change only adds a space after '///' which is purely cosmetic and doesn't improve functionality.

OMG - the code formatter -- not that important - we could also remove that line

But maybe, we add this to exceptions

calixtus · 2025-09-13T13:11:39Z

Chris just recently fixed this. Please check if you have the very latest intellij config configured.

koppor · 2025-09-13T13:11:59Z

The fix of chris was #13817

calixtus · 2025-09-13T13:14:38Z

Seems weird putting enums at the end of a file

jabgui/src/main/java/org/jabref/Launcher.java

calixtus · 2025-09-13T13:15:48Z

No space between last variable declaration and method name?

calixtus · 2025-09-13T13:16:07Z

jabgui/src/main/java/org/jabref/cli/ArgumentProcessor.java

calixtus · 2025-09-13T13:19:07Z

Deliberately inserted newlines for readability should somehow be kept:
jabgui/src/main/java/org/jabref/gui/LibraryTab.java

calixtus · 2025-09-13T13:22:10Z

Incorporated file from another project with their own copyright header.

.jbang/CheckoutPR.java

trag-bot · 2025-09-13T13:31:47Z

.jbang/JabKitLauncher.java

@@ -1,4 +1,4 @@
-///usr/bin/env jbang "$0" "$@" ; exit $?
+/// usr/bin/env jbang "$0" "$@" ; exit $?


Code reformatting was done without adding new statements. The addition of a space after '///' is purely syntactical and violates the code reformatting policy.

trag-bot · 2025-09-13T13:33:00Z

.jbang/JabLsLauncher.java

@@ -1,4 +1,4 @@
-///usr/bin/env jbang "$0" "$@" ; exit $?
+/// usr/bin/env jbang "$0" "$@" ; exit $?


Code reformatting without adding new statements violates the principle of meaningful changes. The addition of a space after '///' is purely cosmetic and doesn't improve functionality.

trag-bot · 2025-09-13T13:34:00Z

build-support/src/main/java/CitationStyleCatalogGenerator.java

@@ -1,4 +1,4 @@
-///usr/bin/env jbang "$0" "$@" ; exit $?
+/// usr/bin/env jbang "$0" "$@" ; exit $?


Comments should add new information and not just restate what's obvious from the code. The shebang line is self-explanatory and doesn't need additional comment formatting.

trag-bot · 2025-09-13T13:38:54Z

jabgui/src/main/java/org/jabref/gui/ai/components/aichat/AiChatComponent.java

+                case PROCESSING ->
+                        notifications.add(new Notification(


Code reformatting with changed indentation is purely cosmetic and doesn't introduce new functionality. Such changes should be combined with actual code modifications.

trag-bot · 2025-09-13T13:39:55Z

jabgui/src/main/java/org/jabref/gui/ai/components/util/notifications/Notification.java

+public record Notification(
+        String title,


The code was reformatted without adding new statements. According to guidelines, code should not be reformatted only for syntax reasons without adding new functionality.

trag-bot · 2025-09-13T13:40:48Z

jabgui/src/main/java/org/jabref/gui/autocompleter/PersonNameStringConverter.java

+                case ONLY_ABBREVIATED,
+                     BOTH:


The code is being reformatted without adding new statements, which violates the principle of not reformatting code solely for syntax reasons without functional changes.

trag-bot · 2025-09-13T13:49:24Z

jabgui/src/main/java/org/jabref/gui/cleanup/CleanupSingleAction.java

    private void cleanup(BibDatabaseContext databaseContext, CleanupPreferences cleanupPreferences) {
-            // undo granularity is on entry level
-            NamedCompound ce = new NamedCompound(Localization.lang("Cleanup entry"));
+        // undo granularity is on entry level


Comment merely restates what is obvious from the code and variable naming. It does not provide additional information about reasoning or implementation details.

trag-bot · 2025-09-13T13:50:07Z

jabgui/src/main/java/org/jabref/gui/collab/DatabaseChangeDetailsViewFactory.java

+            case EntryChange entryChange ->
+                    new EntryChangeDetailsView(


The code reformatting appears to be purely cosmetic without adding new statements. The indentation and line breaks were modified without functional changes, which violates the reformatting policy.

calixtus · 2025-09-13T16:20:48Z

calixtus · 2025-09-13T16:21:00Z

calixtus · 2025-09-13T16:21:08Z

calixtus · 2025-09-13T16:24:14Z

.../main/resources/org/jabref/gui/ai/components/aichat/chatmessage/ChatMessageComponent.fxml

subhramit · 2025-09-13T16:25:22Z

@koppor what do we do about these?
Git revert and do another without *.fxml?
Manually reverting each will take years

calixtus · 2025-09-13T16:26:54Z

Is @subhramit hidden as commit author to avoid git history misleading bc just reformatting?

calixtus · 2025-09-13T16:31:38Z

jablib/src/main/java/org/jabref/logic/UiCommand.java

subhramit · 2025-09-13T16:31:55Z

Can this be done with checkstyle? Empty line at the end of the comment

With checkstyle - yes, with intellij auto format configuration - no
@koppor would take a call on whether we want more warnings "after" an auto-format is done

However, I think in these cases, the formatter just moved */ to the next line, as there was already a * in the line (treating it as a valid comment line) (intended behavior - in a way, so needs manual removal).

calixtus · 2025-09-13T16:32:20Z

calixtus · 2025-09-13T16:33:27Z

Needs probably some thought

calixtus · 2025-09-13T16:34:19Z

koppor · 2025-09-13T16:35:25Z

Is @subhramit hidden as commit author to avoid git history misleading bc just reformatting?

Yes --> #13881

calixtus · 2025-09-13T16:36:02Z

Deliberately set apart

calixtus · 2025-09-13T16:40:12Z

koppor · 2025-09-13T16:41:50Z

This is wrong JavaDoc by authors - needs manual fix.

calixtus · 2025-09-13T16:50:35Z

I like this very much:

calixtus · 2025-09-13T16:51:41Z

calixtus · 2025-09-13T16:52:56Z

calixtus · 2025-09-13T16:53:24Z

calixtus · 2025-09-13T16:54:24Z

This made me laugh a bit:

calixtus · 2025-09-13T16:55:43Z

No lines between methods? jablib/src/test/java/org/jabref/logic/citationkeypattern/BracketedPatternTest.java

calixtus · 2025-09-13T17:00:41Z

subhramit · 2025-09-13T17:27:04Z

No lines between methods? jablib/src/test/java/org/jabref/logic/citationkeypattern/BracketedPatternTest.java

That's gap between method and csvsource, not method and method

koppor · 2025-09-13T17:34:52Z

This is minor, isn't it? -> should be converted to markdown in all cases?

koppor · 2025-09-13T17:52:47Z

Deliberately set apart

One could introduce <p> if this is inteded. Not a show stupper

koppor · 2025-09-13T17:55:23Z

Reason for records reformatting: We began to use records, but did not update our code style.

Fixed at #13889

subhramit marked this pull request as draft September 13, 2025 11:54

subhramit force-pushed the reformat branch from c78b24e to 7bafe6e Compare September 13, 2025 13:02

trag-bot bot reviewed Sep 13, 2025

View reviewed changes

Try again

362873f

subhramit force-pushed the reformat branch from 95b3a0c to 362873f Compare September 13, 2025 13:24

Use jspecify

65b2e4f

trag-bot bot reviewed Sep 13, 2025

View reviewed changes

.jbang/CheckoutPR.java Show resolved Hide resolved

trag-bot bot reviewed Sep 13, 2025

View reviewed changes

Adjust checkstyle scope

7955f62

koppor mentioned this pull request Sep 13, 2025

Adapt code style #13874

Merged

1 task

trag-bot bot reviewed Sep 13, 2025

View reviewed changes

subhramit added 3 commits September 13, 2025 19:36

Merge branch 'main' into reformat

b1fce46

Fix checkstyle

30d39a8

undo changes to license

fb49850

koppor mentioned this pull request Sep 13, 2025

Manual code reformattings #13883

Merged

1 task

koppor mentioned this pull request Sep 13, 2025

Add .git-blame-ignore-revs #13884

Merged

1 task

koppor mentioned this pull request Sep 13, 2025

Reformat codebase (more carefully) #13885

Merged

1 task

koppor mentioned this pull request Sep 13, 2025

Fix record wrapping #13889

Merged

1 task

		@@ -1,4 +1,4 @@
		///usr/bin/env jbang "$0" "$@" ; exit $?
		/// usr/bin/env jbang "$0" "$@" ; exit $?

Uh oh!

Conversation

subhramit commented Sep 13, 2025

Steps to test

Mandatory checks

Uh oh!

subhramit commented Sep 13, 2025

Uh oh!

koppor commented Sep 13, 2025

Uh oh!

koppor commented Sep 13, 2025

Uh oh!

trag-bot bot Sep 13, 2025

Choose a reason for hiding this comment

Uh oh!

koppor Sep 13, 2025

Choose a reason for hiding this comment

Uh oh!

calixtus commented Sep 13, 2025

Uh oh!

koppor commented Sep 13, 2025

Uh oh!

calixtus commented Sep 13, 2025

Uh oh!

calixtus commented Sep 13, 2025

Uh oh!

calixtus commented Sep 13, 2025

Uh oh!

calixtus commented Sep 13, 2025

Uh oh!

calixtus commented Sep 13, 2025

Uh oh!

Uh oh!

trag-bot bot Sep 13, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot bot Sep 13, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot bot Sep 13, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot bot Sep 13, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot bot Sep 13, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot bot Sep 13, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot bot Sep 13, 2025

Choose a reason for hiding this comment

Uh oh!

trag-bot bot Sep 13, 2025

Choose a reason for hiding this comment

Uh oh!

calixtus commented Sep 13, 2025

Uh oh!

calixtus commented Sep 13, 2025

Uh oh!

calixtus commented Sep 13, 2025

Uh oh!

calixtus commented Sep 13, 2025

Uh oh!

subhramit commented Sep 13, 2025

Uh oh!

calixtus commented Sep 13, 2025

Uh oh!

calixtus commented Sep 13, 2025

Uh oh!

subhramit commented Sep 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

calixtus commented Sep 13, 2025

Uh oh!

calixtus commented Sep 13, 2025

Uh oh!

calixtus commented Sep 13, 2025

Uh oh!

subhramit commented Sep 13, 2025 •

edited

Loading