Add auto-renaming of linked files on entry data change #13295

paudelritij · 2025-06-09T17:14:11Z

This PR introduces an option to automatically rename linked files when the associated entry data is modified. The feature is configurable in Preferences under Linked files -> Linked file name conventions, with a default setting of false. It also includes handling for entries with multiple attached files and adds relevant test cases.

Steps to test

Open JabRef and go to Preferences > Linked files.
Enable [ ] Auto rename files if entry changes.
Create a new entry and attach a file.
Modify any field in the entry.
Check that the linked file's name updates to match the new citation key.
Test with multiple files to ensure all are renamed.

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.

- Implemented a preference option under Linked files -> Linked file name conventions to enable auto-renaming of files when entry data changes (default: false). - Added functionality to listen for entry change events and rename files if the preference is enabled and the file name matches the defined pattern. - Ensured that no action is taken if the pattern is empty, as the file name would not match. - Considered scenarios where an entry has multiple files attached and handled them appropriately. - Added test cases to verify the new functionality.

jabgui/src/main/java/org/jabref/gui/externalfiles/AutoRenameFileOnEntryChange.java

jabgui/src/main/java/org/jabref/gui/preferences/linkedfiles/LinkedFilesTab.java

jabgui/src/main/java/org/jabref/gui/preferences/linkedfiles/LinkedFilesTabViewModel.java

jabgui/src/test/java/org/jabref/gui/externalfiles/AutoRenameFileOnEntryChangeTest.java

trag-bot · 2025-06-09T17:17:25Z

jabgui/src/test/java/org/jabref/gui/externalfiles/AutoRenameFileOnEntryChangeTest.java

+    @Test
+    void multipleFilesRenameOnEntryChange() throws IOException {
+        // create multiple entries
+        List<String> fileNames = Arrays.asList(


Modern Java data structures should be used. Instead of Arrays.asList, consider using List.of for better performance and readability.

trag-bot · 2025-06-09T17:17:55Z

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

@@ -106,6 +109,18 @@ public void setStoreFilesRelativeToBibFile(boolean shouldStoreFilesRelativeToBib
        this.storeFilesRelativeToBibFile.set(shouldStoreFilesRelativeToBibFile);
    }

+    public boolean shouldAutoRenameFilesOnChange() {


The method should return an Optional instead of a primitive boolean to avoid returning null and to align with modern Java practices.

trag-bot · 2025-06-10T00:57:33Z

jabgui/src/main/java/org/jabref/gui/LibraryTab.java

@@ -203,6 +204,7 @@ private void initializeComponentsAndListeners(boolean isDummyContext) {

        bibDatabaseContext.getDatabase().registerListener(this);
        bibDatabaseContext.getMetaData().registerListener(this);
+        new AutoRenameFileOnEntryChange(bibDatabaseContext, preferences);


The instantiation of AutoRenameFileOnEntryChange should be moved to org.jabref.logic package as it involves non-GUI operations, adhering to the layered architecture principle.

trag-bot · 2025-06-10T00:57:54Z

jabgui/src/main/java/org/jabref/gui/externalfiles/AutoRenameFileOnEntryChange.java

+    }
+
+    private boolean relatesToFilePattern(String fileNamePattern, FieldChangedEvent event) {
+        Set<String> extractedFields = new HashSet<>();


Using 'new HashSet<>()' is not optimal. Consider using 'Set.of()' for better readability and performance as per modern Java practices.

trag-bot · 2025-06-10T00:59:50Z

jabgui/src/test/java/org/jabref/gui/externalfiles/AutoRenameFileOnEntryChangeTest.java

+        // change year only
+        entry.setField(StandardField.YEAR, "2082");
+        assertEquals("newKey2082.pdf", entry.getFiles().getFirst().getLink());
+        assertTrue(Files.exists(tempDir.resolve("newKey2082.pdf")));


The assertion checks for a boolean condition instead of asserting the expected content of the object. Use assertEquals to compare expected and actual values.

trag-bot · 2025-06-11T10:19:01Z

@trag-bot didn't find any issues in the code! ✅✨