Enabled configuration of citation key patterns at the CLI #14726

prerak09 · 2025-12-26T13:26:26Z

Added option in Jabkit CLI to change citation key patterns per entry type , same as available in Jabref GUI

Attached Video show testing of the TestCases.

Steps to test

Create a test file .
I am attaching the test file i created to test (test.bib)

@Article{,
  author  = {Author1 and Author2},
  title   = {ArticleTitle1},
  journal = {Journal1},
  year    = {2025},
}

@Book{,
  author    = {Author3},
  title     = {BookTitle1},
  publisher = {Publisher1},
  year      = {2026},
}

@InProceedings{,
  author    = {Author4 and Author5},
  title     = {ConferencePaper1},
  booktitle = {Conference1},
  year      = {2027},
}

@Misc{existingKey2024,
  author = {Author6},
  title  = {MiscTitle1},
  year   = {2024},
}

Test 1 -
This Will check Global pattern

./gradlew :jabkit:run --args="citationkeys generate \
  --input=test.bib \
  --pattern=[auth][year]"

Test 2 -
This Will check per entry type changing for article and book

./gradlew :jabkit:run --args="citationkeys generate \
  --input=test.bib \
  --pattern=[auth][year] \
  --entry-type-pattern=article=[auth][year] \
  --entry-type-pattern=book=[auth][year]"

Test 3 -
This Will check invalid entry type
there is no entry like invalid type so it should through an error

./gradlew :jabkit:run --args="citationkeys generate \
  --input=test.bib \
  --entry-type-pattern=invalidtype=[auth][year]"

Test 4 -
This Will check invalid map syntax

./gradlew :jabkit:run --args="citationkeys generate \
  --input=test.bib \
  --entry-type-pattern=article"

Screenshots

Screen.Recording.2025-12-26.at.6.09.41.PM-converted-converted.mp4

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.

prerak09 · 2025-12-26T13:28:18Z

@Siedlerchr I created this draft pull request .
Please look at my changes once and let me know if i am doing correct or if any changes are required

jabref-machine · 2025-12-26T13:34:44Z

Your code currently does not meet JabRef's code guidelines. We use Checkstyle to identify issues. You can see which checks are failing by locating the box "Some checks were not successful" on the pull request page. To see the test output, locate "Source Code Tests / Checkstyle (pull_request)" and click on it.

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.

Please carefully follow the setup guide for the codestyle. Afterwards, please run checkstyle locally and fix the issues, commit, and push.

calixtus · 2025-12-26T21:12:24Z

jabkit/src/main/java/org/jabref/toolkit/converter/KeySuffixConverter.java

+public class KeySuffixConverter
+        extends CaseInsensitiveEnumConverter<CitationKeyPatternPreferences.KeySuffix> {
+
+    public KeySuffixConverter() {


This class seems to be a bit superfluous to me. Or did i miss something? Can't you just inline CaseInsensitiveEnumConverter<CitationKeyPatternPreferences.KeySuffix> ?

I tried to inline CaseInsensitiveEnumConverter directly in the @option
here
@option(names = "--suffix", description = "Key suffix strategy: ${COMPLETION-CANDIDATES}", converter = CaseInsensitiveEnumConverter.class)
private CitationKeyPatternPreferences.KeySuffix keySuffix;
but i am facing some errors thats why i created a convertor for that
i will try again

calixtus · 2025-12-26T21:16:48Z

What might be helpful would be some hint to a list of allowed entrytypes, if one could not be found. Maybe by hardcoding it or by linking to some online documentation?
Other question is - maybe a user wants to define some citation key pattern for a custom entry type?

subhramit

It is good that you asked for feedback early, but please note the following comments. Breaking into multiple lines bulks the diff up.
Also, please set up Checkstyle on IntelliJ as it is one of the very first points of our contributing guidelines.

subhramit · 2025-12-26T22:53:30Z

jabkit/src/main/java/org/jabref/toolkit/commands/GenerateCitationKeys.java

+        CitationKeyPatternPreferences existingPreferences =
+                parentCommand.getParent().cliPreferences.getCitationKeyPatternPreferences();


We currently have limited time and a lot of PRs to review. Please help by not making us repeat the same comments on every PR.
#14620 (comment)

Sorry about that , i will fix that before my final PR.
I only created this Draft PR just to get some reviews over my code logic if i am on the right path or not

That is fine, it's just that style and formatting issues get in the way when the person is trying to look through your code and trying to provide feedback on the logic.

Please set up checkstyle so that you don't have to manually format code every time.

subhramit · 2025-12-26T22:53:39Z

jabkit/src/main/java/org/jabref/toolkit/commands/GenerateCitationKeys.java

+        GlobalCitationKeyPatterns patterns =
+                GlobalCitationKeyPatterns.fromPattern(defaultPattern);


#14620 (comment)

subhramit · 2025-12-26T22:54:47Z

jabkit/src/main/java/org/jabref/toolkit/converter/KeySuffixConverter.java

+public class KeySuffixConverter
+        extends CaseInsensitiveEnumConverter<CitationKeyPatternPreferences.KeySuffix> {


#14620 (comment)

prerak09 · 2025-12-27T03:14:06Z

What might be helpful would be some hint to a list of allowed entrytypes, if one could not be found. Maybe by hardcoding it or by linking to some online documentation? Other question is - maybe a user wants to define some citation key pattern for a custom entry type?

We can add a hint and i guess adding this documentation will be helpful
https://docs.jabref.org/setup/citationkeypatterns

prerak09 · 2025-12-27T03:17:25Z

What might be helpful would be some hint to a list of allowed entrytypes, if one could not be found. Maybe by hardcoding it or by linking to some online documentation? Other question is - maybe a user wants to define some citation key pattern for a custom entry type?

I will start working on that after fixing this issue
maybe we can create a Sub-Issue for that will that be fine?

koppor · 2025-12-27T14:25:00Z

What might be helpful would be some hint to a list of allowed entrytypes, if one could not be found. Maybe by hardcoding it or by linking to some online documentation? Other question is - maybe a user wants to define some citation key pattern for a custom entry type?

I will start working on that after fixing this issue maybe we can create a Sub-Issue for that will that be fine?

No sub issue. We are all in the context here. If there are no long delays in back and forth, this should be solvable.

Use org.jabref.model.entry.types.EntryTypeFactory#parse - you can output all org.jabref.model.entry.types.UnknownEntryType as warning?

prerak09 added 2 commits December 26, 2025 00:44

Enable per-entry-type citation key patterns in JabKit CLI

2396c0a

Enable per-entry-type citation key patterns in JabKit CLI

9452ddc

github-actions bot added the good second issue Issues that involve a tour of two or three interweaved components in JabRef label Dec 26, 2025

github-actions bot added the status: changes-required Pull requests that are not yet complete label Dec 26, 2025

subhramit requested a review from calixtus December 26, 2025 18:43

calixtus reviewed Dec 26, 2025

View reviewed changes

calixtus added component: citationkey-generator component: JabKit [cli] labels Dec 26, 2025

subhramit requested changes Dec 26, 2025

View reviewed changes

		CitationKeyPatternPreferences existingPreferences =
		parentCommand.getParent().cliPreferences.getCitationKeyPatternPreferences();

		GlobalCitationKeyPatterns patterns =
		GlobalCitationKeyPatterns.fromPattern(defaultPattern);

		public class KeySuffixConverter
		extends CaseInsensitiveEnumConverter<CitationKeyPatternPreferences.KeySuffix> {

Uh oh!

Enabled configuration of citation key patterns at the CLI #14726

Are you sure you want to change the base?

Enabled configuration of citation key patterns at the CLI #14726

Uh oh!

Conversation

prerak09 commented Dec 26, 2025 • edited by calixtus Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Steps to test

Screenshots

Mandatory checks

Uh oh!

prerak09 commented Dec 26, 2025

Uh oh!

jabref-machine commented Dec 26, 2025

Uh oh!

calixtus Dec 26, 2025

Choose a reason for hiding this comment

Uh oh!

prerak09 Dec 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

calixtus commented Dec 26, 2025

Uh oh!

subhramit left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

subhramit Dec 26, 2025

Choose a reason for hiding this comment

Uh oh!

prerak09 Dec 27, 2025

Choose a reason for hiding this comment

Uh oh!

subhramit Dec 27, 2025

Choose a reason for hiding this comment

Uh oh!

subhramit Dec 26, 2025

Choose a reason for hiding this comment

Uh oh!

subhramit Dec 26, 2025

Choose a reason for hiding this comment

Uh oh!

prerak09 commented Dec 27, 2025

Uh oh!

prerak09 commented Dec 27, 2025 • edited by calixtus Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

koppor commented Dec 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

prerak09 commented Dec 26, 2025 •

edited by calixtus

Loading

prerak09 Dec 27, 2025 •

edited

Loading

subhramit left a comment •

edited

Loading

prerak09 commented Dec 27, 2025 •

edited by calixtus

Loading