Skip to content

Conversation

@opazenha
Copy link
Contributor

@opazenha opazenha commented Nov 26, 2025

Closes #13275

Refactored jabkit CLI to improve output formatting and code organization. Changes include clearing unused imports, skipping redundant format footers for check-consistency command, reorganizing method order, adding documentation, and improving usage footer generation with export format support.

Steps to test

  1. Build the project: ./gradlew build
  2. Run jabkit commands to verify output formatting:
    • ./gradlew :jabkit-cli:run --args="check-consistency"
    • ./gradlew :jabkit-cli:run --args="export --help"
  3. Verify that redundant footers are no longer displayed
  4. Check that usage information is properly formatted

Mandatory checks

  • 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 described the change in CHANGELOG.md in a way that is understandable for the average user (if change is visible to the user)
  • [/] I checked the user 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 updating file(s) in https://github.com/JabRef/user-documentation/tree/main/en.

…at support

Extract option checking logic into helper method and use Map to track command options.
Add constants for footer labels and implement support for export format footers
alongside existing input and output formats.
Move hasCommandOption method below applyUsageFooters for better logical grouping
and add comprehensive JavaDoc documentation to explain the usage footer
application functionality.
@github-actions
Copy link
Contributor

Hey @opazenha!

Thank you for contributing to JabRef! Your help is truly appreciated ❤️

We have automated checks in place, based on which you will soon get feedback if any of them are failing. In a while, maintainers will also review your contribution. Once that happens, you can go through their comments in the "Files changed" tab and act on them, or reply to the conversation if you have further inputs.

Please re-check our contribution guide in case of any other doubts related to our contribution workflow.

@opazenha opazenha force-pushed the fix-for-issue-13275 branch from b2ebb8b to 057e0fd Compare November 26, 2025 14:44
- Replace hardcoded strings with Localization.lang() calls
- Add missing 'Available output formats:' localization key
- Fixes failing LocalizationConsistencyTest
@opazenha opazenha changed the title Fix for issue 13275 Fix for JabKit CLI help output format #13275 Nov 26, 2025
@koppor koppor added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Nov 26, 2025
@calixtus calixtus added this pull request to the merge queue Nov 26, 2025
Merged via the queue into JabRef:main with commit 898bda6 Nov 26, 2025
73 of 79 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

first contrib status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Do not output "export formats" for consistency check help

3 participants