Fix hash warning

[calixtus]

Related issues and pull requests

Follow up to #15559
Fixes https://github.com/JabRef/jabref-issue-melting-pot/issues/1279
Fixes #15586

PR Description

See qodo

Steps to test

Run JabRef, write something in entry editor, see no warning about hashes

Checklist

• 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 added a screenshot in the PR description showing a library with a single entry with me as author and as title the issue number
• [.] I described the change in CHANGELOG.md in a way that can be understood by the average user (if change is visible to the user)
• [.] I checked the user documentation for up to dateness and submitted a pull request to our user documentation repository

[qodo-free-for-open-source-projects]

Review Summary by Qodo

Fix hash warning in BibTeX string formatting

🐞 Bug fix

Walkthroughs

Description

• Fix incorrect hash warning triggered during entry editing
• Correct control flow logic in string formatting method
• Move warning condition inside proper conditional block

Diagram

flowchart LR
  A["String formatting logic"] -- "Fix control flow" --> B["Correct conditional nesting"]
  B -- "Move warning check" --> C["Warning only on unmatched hash"]
  C -- "Result" --> D["No spurious warnings"]

Loading

File Changes

1. jablib/src/main/java/org/jabref/logic/bibtex/FieldWriter.java 🐞 Bug fix +9/-9

Fix hash warning control flow in string formatting

• Fix control flow by moving the pos2 == -1 check inside the else block
• Correct indentation to reflect proper nesting of conditional logic
• Prevent spurious hash warnings when processing BibTeX strings
• Warning now only triggers when hash character is genuinely unmatched

jablib/src/main/java/org/jabref/logic/bibtex/FieldWriter.java

---

[qodo-free-for-open-source-projects]

Code Review by Qodo

🐞 Bugs (1) 📘 Rule violations (0) 📎 Requirement gaps (0)

1. Warning suppression untested 🐞 Bug ⚙ Maintainability

Description

formatAndResolveStrings now only logs the “character # is not allowed…” warning when a starting
# exists but no closing # is found, but no unit test would fail if this behavior regresses and
starts warning for hash-free values again. This makes it easy to reintroduce the original log-spam
problem without detection.

Code

jablib/src/main/java/org/jabref/logic/bibtex/FieldWriter.java[R195-203]

+                if (pos2 == -1) {
+                    pos1 = content.length();
+                    LOGGER.warn("The character {} is not allowed in BibTeX strings unless escaped as in '\\\\{}'. "
+                                    + "In JabRef, use pairs of # characters to indicate a string. "
+                                    + "Field value: {}",
+                            BIBTEX_STRING_START_END_SYMBOL,
+                            BIBTEX_STRING_START_END_SYMBOL,
+                            content);
+                }

Evidence

The warning is emitted inside the pos2 == -1 branch in formatAndResolveStrings, which is the
behavior adjusted by this PR. Existing unit tests cover hash-enclosed strings and some edge cases
(e.g., #jan# - #feb#, #text, \#text, te##xt), but they do not verify the warning behavior
(or its absence) for a hash-free month value that originally caused the false warning spam.

jablib/src/main/java/org/jabref/logic/bibtex/FieldWriter.java[175-223]
jablib/src/test/java/org/jabref/logic/bibtex/FieldWriterTest.java[157-179]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
The PR fixes when `FieldWriter.formatAndResolveStrings` logs a warning about `#`, but there is no unit test that would catch a regression (e.g., warning again when the input contains no `#`).

### Issue Context
This PR’s user-visible effect is “no warning about hashes” during editing; since this is primarily log/diagnostic behavior, it’s easy to break in the future without a targeted test.

### Fix Focus Areas
- jablib/src/test/java/org/jabref/logic/bibtex/FieldWriterTest.java[157-179]
- jablib/src/main/java/org/jabref/logic/bibtex/FieldWriter.java[175-205]

### Suggested test approach
1. Add a test like `monthWithoutHashDoesNotWarn()` that calls `writer.write(StandardField.MONTH, "January")` and asserts the output is `{January}`.
2. Capture and assert logging behavior for `FieldWriter` so the test also verifies that *no* WARN is emitted for hash-free input, while an unpaired-hash input (e.g., `"#text"`) *does* emit the WARN.
  - If the project already has a preferred SLF4J/logback test appender utility, use that; otherwise add a minimal test appender for this test class.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---

ⓘ The new review experience is currently in Beta. Learn more