Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Cli option for BibliographyConsistencyCheckResultTxtWriter #11984

Open
koppor opened this issue Oct 16, 2024 · 4 comments
Open

Add Cli option for BibliographyConsistencyCheckResultTxtWriter #11984

koppor opened this issue Oct 16, 2024 · 4 comments
Labels
good first issue An issue intended for project-newcomers. Varies in difficulty.

Comments

@koppor
Copy link
Member

koppor commented Oct 16, 2024

JabRef has a functionality to check a set of BibTeX entries for consistency. (Introcued at #10778 and #10847)

There is no CLI for that. --check-consistency FILE[,FORMAT] and then the TXT is output. One could also output CSV. (not sure how to design the CLI for that, maybe --check-consistency-output-format TXT / CSV)

Actions:

  1. Add option to org.jabref.cli.CliOptions. Similar to importToOpen.
  2. Add methods to org.jabref.cli.ArgumentProcessor (similar to org.jabref.cli.ArgumentProcessor#importToOpenBase)

Optionally, one can port the command line parsing to JCommander and redesign the complete CLI, but this is a larger task.

@koppor koppor added the good first issue An issue intended for project-newcomers. Varies in difficulty. label Oct 16, 2024
@github-project-automation github-project-automation bot moved this to Free to take in Good First Issues Oct 16, 2024
@FeiLi-lab
Copy link

Hey! May I work on this issue? thank you!

@koppor
Copy link
Member Author

koppor commented Oct 16, 2024

/assign @FeiLi-lab

@github-actions github-actions bot added the 📍 Assigned Assigned by assign-issue-action (or manually assigned) label Oct 16, 2024
Copy link
Contributor

👋 Hey @,

Thanks for your interest in this issue! 🎉

Newcomers, 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.

Note that you will be unassigned if it isn't closed within ** days** (****).

Note

A maintainer can also add the **** label to prevent it from being unassigned automatically.

Happy coding! 🚀

@koppor
Copy link
Member Author

koppor commented Oct 16, 2024

@FeiLi-lab Sorry for the confusing message - I am testing a develoment version of an action supporting our maintenance - takanome-dev/assign-issue-action#245. You are assigned. Happy coding!

@github-actions github-actions bot removed the 📍 Assigned Assigned by assign-issue-action (or manually assigned) label Nov 16, 2024
@koppor koppor moved this from In Progress to Free to take in Good First Issues Dec 9, 2024
@JabRef JabRef deleted a comment from github-actions bot Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue An issue intended for project-newcomers. Varies in difficulty.
Projects
Status: Free to take
Status: Free to take
2 participants