GUI for consistency check

[priyanshu16095]

Fixes #11950

This PR introduces a GUI for a bibliography consistency check to ensure consistency among BibTeX entries.

Mandatory checks

• I own the copyright of the code submitted and I licence 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 (for UI changes)
• 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.

[github-actions]

JUnit tests are failing. In the area "Some checks were not successful", locate "Tests / Unit tests (pull_request)" and click on "Details". This brings you to the test output.

You can then run these tests in IntelliJ to reproduce the failing tests locally. We offer a quick test running howto in the section Final build system checks in our setup guide.

[priyanshu16095]

Recording.2025-01-31.mp4

Added a table, but figuring out how to proceed with inserting data into the table as shown in the UI.

Please review.

[github-actions]

JUnit tests are failing. In the area "Some checks were not successful", locate "Tests / Unit tests (pull_request)" and click on "Details". This brings you to the test output.

You can then run these tests in IntelliJ to reproduce the failing tests locally. We offer a quick test running howto in the section Final build system checks in our setup guide.

[calixtus]

Just by a quick look two remarks
Also about the picture in the issue: The user needs some hints what o and ? and so on mean. It must be understandable somehow right away.

[github-actions]

Your code currently does not meet JabRef's code guidelines.
We use Checkstyle to identify issues.
Please carefully follow the setup guide for the codestyle.
Afterwards, please run checkstyle locally and fix the issues.

In case of issues with the import order, double check that you activated Auto Import.
You can trigger fixing imports by pressing Ctrl+Alt+O to trigger Optimize Imports.

[priyanshu16095]

I have taken a lot of code as it is from the BibliographyConsistencyCheckResultWriter class in the ConsistencyCheckDialogViewModel class. Is there a better way to do this?

[priyanshu16095]

Recording.2025-02-03.mp4

The table is displaying data correctly.
The tasks are running in background.

What remains to be done:

• Providing information of the symbols.
• Filtering data based on the selected value of the combo box
• Implementing the jump to the selected row feature

[calixtus]

Either i dont understand one comment or its an artifact from another pr?

[calixtus]

Everything else looks good to go. Thanks for your great addition!

fixed

[priyanshu16095]

This is redundant here, as records provide a built-in toString method.

The purpose of this method elsewhere in the codebase is when multiple fields are required, like "[ " + bibEntry.getCitationKey() + ", " + message.toString() + " ]". However, the message field itself already includes the citationKey.

jabref/src/main/java/org/jabref/logic/integrity/IntegrityMessage.java

Lines 11 to 14 in 39d7971

	@Override
	public String toString() {
	return "[" + entry().getCitationKey().orElse(entry().getAuthorTitleYear(50)) + "] in " + field.getDisplayName() + ": " + message();
	}

In the follow up PR, should I also remove this.

[subhramit]

Yes

[koppor]

@priyanshu16095 Thank you for the work on this - would you feel comfortable to write a blog entry for this? (JabRef/blog.jabref.org#108) - I think, you have enough domain knowledge to explain?

In your screenshot, I saw that there is the column "Pages" filled with "O". That should not happen - if everything is the same (presence), then there should be no output - or is the logic different.

Finally, the logic of the consistency check maybe should ignore JabRef's fields (ranking in your example). That can be a follow-up. Maybe even configurable during the check itself?

[priyanshu16095]

Sure! I'd be happy to write a blog entry for this.

I'll check why the "Pages" column is showing "o" and adjust the logic if needed.

Ignoring JabRef-specific fields in the consistency check sounds like a good idea. I'll definitely try it in a follow-up.

[koppor]

Sure! I'd be happy to write a blog entry for this.

Nice! In parallel, I would ask for a text for https://github.com/JabRef/user-documentation. I think, there is an overlap of 80% 😅 (Which is OK!). The blog won't evolve later, but the user documention 😅

[priyanshu16095]

Understood! I’ll ensure the core content fits both needs.

[koppor]

Follow-up issue: #12695

[koppor]

Follow-up issue #12696

[koppor]

Follow-up issue: #12697

Sorry for the many follow-up isuses. I was so happy to see this in, but did not thouroughly test it.

[koppor]

Follow up: #12487