Jump to entry key cli (WIP) #659

u7282852 · 2023-10-24T08:19:59Z

Addresses Issue: #540
Command line now supports option "jumpToEntryKey" or "-j" folowed by one entrykey argument.
Upon start up, jabref will search the imported files for the entrykey and focus this library and select this entry.

However, I am experiencing issues when there are previously opened databases that are not opened through the command line. The last database within the previously opened databases seems to always be the library focused on start up as they seem to run on a different thread or something.

Currently the key is searched only in the imported files specified in the commandline [BIBTEX_FILE] fields. I also request some assistance as to how I can search the previously opened/edited databases as well for the entrykey.

Mandatory checks

Change in CHANGELOG.md described in a way that is understandable for the average user (if applicable)
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.

koppor

Some small comments.

Please include it and submit to the main repo

koppor · 2023-10-24T11:03:02Z

src/main/java/org/jabref/cli/ArgumentProcessor.java

+                return;
+            }
+        }
+        LOGGER.error("Could not find given citation key to jump to");


Suggested change

LOGGER.error("Could not find given citation key to jump to");

LOGGER.error("Could not find citation key {} to jump to", citationKey);

Here, System.out.println is OK, because it was a CLI which outputs to the console. Please also add the output to the console. -- Maybe, even replace logger completely:

System.out.println("Could not find citation key %0 in any library", citationKey);

See https://devdocs.jabref.org/code-howtos/localization.html for steps for the localiaztion.

koppor · 2023-10-24T11:03:35Z

src/main/java/org/jabref/cli/ArgumentProcessor.java

@@ -773,6 +777,18 @@ private Optional<ParserResult> fetch(String fetchCommand) {
        }
    }

+    private void jumpToEntryKey(List<ParserResult> loaded, String citationKey) {
+        // search for this key in imported files


Remove this line, because the for each loop makes it clear somehow.

koppor · 2023-10-24T11:04:33Z

src/main/java/org/jabref/cli/JabRefCLI.java

@@ -288,6 +296,14 @@ private static Options getOptions() {
                .argName("CITEKEY1[,CITEKEY2][,CITEKEYn] | PDF1[,PDF2][,PDFn] | all")
                .build());

+        options.addOption(Option
+                .builder("j")
+                .longOpt("jumpToEntryKey")


Rename to jumpToKey. (We use CitationKey throughout JabRef. Sometimes also BibtexKey. Never EntryKey. With key you are on the safe side ^^)

koppor · 2023-10-24T11:04:48Z

src/main/java/org/jabref/cli/JabRefCLI.java

+        options.addOption(Option
+                .builder("j")
+                .longOpt("jumpToEntryKey")
+                .desc(String.format("%s: '%s'", Localization.lang("Jump to the BibEntry of the given key."), "-j key"))


Suggested change

.desc(String.format("%s: '%s'", Localization.lang("Jump to the BibEntry of the given key."), "-j key"))

.desc(String.format("%s: '%s'", Localization.lang("Jump to the entry of the given citation key."), "-j key"))

koppor · 2023-10-24T11:05:19Z

src/main/java/org/jabref/gui/JabRefGUI.java

+        boolean focusDifferent = false;
+        Optional<BibEntry> focusedEntry = Optional.empty();
+        for (ParserResult parserResult : parserResults) {
+            // Make sure this parser result is its own library instead of imported BibTex entries


Write "BibTeX" always with capital X

koppor · 2023-10-24T11:06:11Z

src/main/java/org/jabref/gui/JabRefGUI.java

            }
+            if (parserResult.getEntryToFocus().isPresent() && focusDifferent) {


Should that be } else if (...?

koppor · 2023-10-24T11:11:32Z

I also request some assistance as to how I can search the previously opened/edited databases as well for the entrykey.

I found org.jabref.gui.JabRefGUI#openLastEditedDatabases, which opens the libraries. Maybe this helps to understand the control flow of opening.

I think, the place could be https://github.com/JabRef/jabref/blob/31f137bcf22c15314f9bc951b694286b34ab2f2f/src/main/java/org/jabref/gui/importer/actions/OpenDatabaseAction.java#L178-L178.

The above LOC also answers the following, doesn't it?

The last database within the previously opened databases seems to always be the library focused on start up as they seem to run on a different thread or something.

…d line arguments

CHANGELOG.md

src/main/java/org/jabref/cli/JabRefCLI.java

src/main/java/org/jabref/gui/LibraryTab.java

Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>

koppor · 2023-11-15T16:33:59Z

Follow-up at JabRef#10578. Closing this one. The other PR is the same branch, but more committers can see it!

u7282852 added 3 commits October 22, 2023 17:40

Add command line skeleton for jump to entry key option

2862c6d

Add basic logic linking new command line option with gui

ec85052

Remove small bug that opens the wrong library with multiple entries

1c14b13

koppor requested changes Oct 24, 2023

View reviewed changes

u7282852 added 4 commits October 25, 2023 18:26

Add small feedback changes

69563fc

Fixed cli by renaming all method to jumpToEntry

c7b62dc

Fixed bug that focused libraries of recently opened files over comman…

7b8c1f5

…d line arguments

Add CHANGELOG.md entry and localization entries

e6a6a9e

koppor force-pushed the main branch 2 times, most recently from 9799dc4 to d6a0e59 Compare October 27, 2023 01:32

koppor requested changes Oct 28, 2023

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

src/main/java/org/jabref/cli/JabRefCLI.java Outdated Show resolved Hide resolved

src/main/java/org/jabref/gui/LibraryTab.java Outdated Show resolved Hide resolved

u7282852 and others added 5 commits October 29, 2023 11:45

Update CHANGELOG.md

6b76bbc

Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>

Update CITEKEY arg name to CITATIONKEY

0179274

Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>

Add comment explaining a previous change

d6d17e8

Introduced UiCommands to replace clumsy gui interface

6907f80

Merge branch 'main' into issue541-jump-to-entry-cli

07ea22d

koppor closed this Nov 15, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Jump to entry key cli (WIP) #659

Jump to entry key cli (WIP) #659

u7282852 commented Oct 24, 2023

koppor left a comment

koppor Oct 24, 2023

koppor Oct 24, 2023

koppor Oct 24, 2023

koppor Oct 24, 2023

koppor Oct 24, 2023

koppor Oct 24, 2023

koppor commented Oct 24, 2023 •

edited

Loading

koppor commented Nov 15, 2023

	LOGGER.error("Could not find given citation key to jump to");
	LOGGER.error("Could not find citation key {} to jump to", citationKey);

	.desc(String.format("%s: '%s'", Localization.lang("Jump to the BibEntry of the given key."), "-j key"))
	.desc(String.format("%s: '%s'", Localization.lang("Jump to the entry of the given citation key."), "-j key"))

		}
		if (parserResult.getEntryToFocus().isPresent() && focusDifferent) {

Jump to entry key cli (WIP) #659

Jump to entry key cli (WIP) #659

Conversation

u7282852 commented Oct 24, 2023

Mandatory checks

koppor left a comment

Choose a reason for hiding this comment

koppor Oct 24, 2023

Choose a reason for hiding this comment

koppor Oct 24, 2023

Choose a reason for hiding this comment

koppor Oct 24, 2023

Choose a reason for hiding this comment

koppor Oct 24, 2023

Choose a reason for hiding this comment

koppor Oct 24, 2023

Choose a reason for hiding this comment

koppor Oct 24, 2023

Choose a reason for hiding this comment

koppor commented Oct 24, 2023 • edited Loading

koppor commented Nov 15, 2023

koppor commented Oct 24, 2023 •

edited

Loading