Exclude certain fields from Consistency check

[koppor]

JabRef can check for consistency of BibEntries. For the GUI, it is described at https://docs.jabref.org/finding-sorting-and-cleaning-entries/checkconsistency.

This check returns too much inconsistencies. For instance, comments on entries should not be checked.

Task

1. Introduce FILTERED_FIELDS at org.jabref.logic.quality.consistency.BibliographyConsistencyCheck. It should contain:
   • all fields of org.jabref.model.entry.field.StandardField#AUTOMATIC_FIELDS
   • org.jabref.model.entry.field.StandardField#COMMENT
   • org.jabref.model.entry.field.StandardField#CROSSREF
   • org.jabref.model.entry.field.StandardField#CITES
   • org.jabref.model.entry.field.StandardField#PDF
   • org.jabref.model.entry.field.StandardField#REVIEW
   • org.jabref.model.entry.field.StandardField#SORTKEY
   • org.jabref.model.entry.field.StandardField#SORTNAME
   • org.jabref.model.entry.field.StandardField#TYPE
   • org.jabref.model.entry.field.StandardField#XREF
   • org.jabref.model.entry.field.StandardField#GROUPS
2. Modify org.jabref.logic.quality.consistency.BibliographyConsistencyCheck#collectEntriesIntoMaps to filter entry.getField() according to FILTERED_FIELDS . Moreover, It should remove all instance of org.jabref.model.entry.field.SpecialField and all instanceof org.jabref.model.entry.field.UserSpecificCommentField
3. Create tests org.jabref.logic.quality.consistency.BibliographyConsistencyCheckTest

[lawmeyian]

/assign-me

[github-actions]

👋 Hey @lawmeyian, looks like you’re eager to work on this issue—great! 🎉 It also looks like you skipped reading our CONTRIBUTING.md, which explains exactly how to participate. No worries, it happens to the best of us. Give it a read, and you’ll discover the ancient wisdom of assigning issues to yourself. Trust me, it’s worth it. 🚀

[lawmeyian]

/assign-me

[github-actions]

👋 Hey @lawmeyian, thank you for your interest in this issue! 🎉

We're excited to have you on board. Start by exploring our Contributing guidelines, and don't forget to check out our workspace setup guidelines to get started smoothly.

In case you encounter failing tests during development, please check our developer FAQs!

Having any questions or issues? Feel free to ask here on GitHub. Need help setting up your local workspace? Join the conversation on JabRef's Gitter chat. And don't hesitate to open a (draft) pull request early on to show the direction it is heading towards. This way, you will receive valuable feedback.

Happy coding! 🚀

[github-actions]

⏰ Assignment Reminder

Hi @lawmeyian, this is a friendly reminder about your assignment to this issue.

Warning

This issue will be automatically unassigned in 11 days if there's no activity.

Remember that you can ask the JabRef Guru about anything regarding JabRef. Additionally, our contributing guide has hints on creating a pull request and a link to our Gitter chat.

How to keep your assignment

If you are working on it, you can prevent automatic unassignment by:

• Submitting a draft PR with your progress
• Asking for the 📌 Pinned label if you need more time

We appreciate your contribution and are here to help if needed!

[lawmeyian]

Thank you for your reminder. I have done some change to the code and will pull request soon.