Rename packages in jabkit to start with org.jabref.toolkit to avoid split packages between jabkit and jabgui (#14052).

.jbang/JabKitLauncher.java

@@ -5,20 +5,20 @@
 //JAVA 24
 //RUNTIME_OPTIONS --enable-native-access=ALL-UNNAMED
 
-//SOURCES ../jabkit/src/main/java/org/jabref/cli/converter/CygWinPathConverter.java
-//SOURCES ../jabkit/src/main/java/org/jabref/cli/ArgumentProcessor.java
-//SOURCES ../jabkit/src/main/java/org/jabref/cli/CheckConsistency.java
-//SOURCES ../jabkit/src/main/java/org/jabref/cli/CheckIntegrity.java
-//SOURCES ../jabkit/src/main/java/org/jabref/cli/Convert.java
-//SOURCES ../jabkit/src/main/java/org/jabref/cli/Fetch.java
-//SOURCES ../jabkit/src/main/java/org/jabref/cli/GenerateBibFromAux.java
-//SOURCES ../jabkit/src/main/java/org/jabref/cli/GenerateCitationKeys.java
-//SOURCES ../jabkit/src/main/java/org/jabref/cli/Pdf.java
-//SOURCES ../jabkit/src/main/java/org/jabref/cli/PdfUpdate.java
-//SOURCES ../jabkit/src/main/java/org/jabref/cli/Preferences.java
-//SOURCES ../jabkit/src/main/java/org/jabref/cli/Pseudonymize.java
-//SOURCES ../jabkit/src/main/java/org/jabref/cli/Search.java
-//SOURCES ../jabkit/src/main/java/org/jabref/JabKit.java
+//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/converter/CygWinPathConverter.java
+//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/ArgumentProcessor.java
+//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/CheckConsistency.java
+//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/CheckIntegrity.java
+//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/Convert.java
+//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/Fetch.java
+//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/GenerateBibFromAux.java
+//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/GenerateCitationKeys.java
+//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/Pdf.java
+//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/PdfUpdate.java
+//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/Preferences.java
+//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/Pseudonymize.java
+//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/cli/Search.java
+//SOURCES ../jabkit/src/main/java/org/jabref/toolkit/JabKit.java
 //FILES tinylog.properties=../jabkit/src/main/resources/tinylog.properties
 
 // REPOS mavencentral,snapshots=https://central.sonatype.com/repository/maven-snapshots/
@@ -38,11 +38,9 @@
 //DEPS info.picocli:picocli:4.7.7
 //DEPS com.github.ben-manes.caffeine:caffeine:3.2.3
 
-import org.jabref.JabKit;
-
 /// This class is required for [jbang](https://www.jbang.dev/)
 public class JabKitLauncher {
     public static void main(String[] args) {
-        org.jabref.JabKit.main(args);
+        org.jabref.toolkit.JabKit.main(args);
     }
 }

jabkit/build.gradle.kts

@@ -63,7 +63,7 @@ javaModuleTesting.whitebox(testing.suites["test"]) {
 }
 
 application {
-    mainClass.set("org.jabref.JabKit")
+    mainClass.set("org.jabref.toolkit.JabKit")
     mainModule.set("org.jabref.jabkit")
 
     // Also passed to launcher by java-module-packaging plugin

jabkit/src/main/java/module-info.java

@@ -2,8 +2,8 @@
     requires org.jabref.jablib;
 
     requires info.picocli;
-    opens org.jabref.cli;
-    opens org.jabref.cli.converter;
+    opens org.jabref.toolkit.cli;
+    opens org.jabref.toolkit.cli.converter;
 
     requires transitive org.jspecify;
     requires java.prefs;

jabkit/src/main/java/org/jabref/JabKit.java → jabkit/src/main/java/org/jabref/toolkit/JabKit.java

@@ -1,4 +1,4 @@
-package org.jabref;
+package org.jabref.toolkit;
 
 import java.io.File;
 import java.io.IOException;
@@ -12,7 +12,6 @@
 
 import javafx.util.Pair;
 
-import org.jabref.cli.ArgumentProcessor;
 import org.jabref.logic.importer.SearchBasedFetcher;
 import org.jabref.logic.importer.WebFetcher;
 import org.jabref.logic.importer.WebFetchers;
@@ -33,6 +32,7 @@
 import org.jabref.model.entry.BibEntryTypesManager;
 import org.jabref.model.util.DummyFileUpdateMonitor;
 import org.jabref.model.util.FileUpdateMonitor;
+import org.jabref.toolkit.cli.ArgumentProcessor;
 
 import com.airhacks.afterburner.injection.Injector;
 import org.slf4j.Logger;

jabkit/src/main/java/org/jabref/cli/ArgumentProcessor.java → jabkit/src/main/java/org/jabref/toolkit/cli/ArgumentProcessor.java

@@ -1,4 +1,4 @@
-package org.jabref.cli;
+package org.jabref.toolkit.cli;
 
 import java.io.IOException;
 import java.net.MalformedURLException;

jabkit/src/main/java/org/jabref/cli/CheckConsistency.java → jabkit/src/main/java/org/jabref/toolkit/cli/CheckConsistency.java

@@ -1,4 +1,4 @@
-package org.jabref.cli;
+package org.jabref.toolkit.cli;
 
 import java.io.IOException;
 import java.io.OutputStreamWriter;
@@ -7,14 +7,14 @@
 import java.util.Optional;
 import java.util.concurrent.Callable;
 
-import org.jabref.cli.converter.CygWinPathConverter;
 import org.jabref.logic.importer.ParserResult;
 import org.jabref.logic.l10n.Localization;
 import org.jabref.logic.quality.consistency.BibliographyConsistencyCheck;
 import org.jabref.logic.quality.consistency.BibliographyConsistencyCheckResultCsvWriter;
 import org.jabref.logic.quality.consistency.BibliographyConsistencyCheckResultTxtWriter;
 import org.jabref.logic.quality.consistency.BibliographyConsistencyCheckResultWriter;
 import org.jabref.model.database.BibDatabaseContext;
+import org.jabref.toolkit.cli.converter.CygWinPathConverter;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

jabkit/src/main/java/org/jabref/cli/CheckIntegrity.java → jabkit/src/main/java/org/jabref/toolkit/cli/CheckIntegrity.java

@@ -1,4 +1,4 @@
-package org.jabref.cli;
+package org.jabref.toolkit.cli;
 
 import java.io.IOException;
 import java.io.OutputStreamWriter;
@@ -10,7 +10,6 @@
 import java.util.concurrent.Callable;
 import java.util.stream.Collectors;
 
-import org.jabref.cli.converter.CygWinPathConverter;
 import org.jabref.logic.importer.ParserResult;
 import org.jabref.logic.integrity.IntegrityCheck;
 import org.jabref.logic.integrity.IntegrityCheckResultCsvWriter;
@@ -21,6 +20,7 @@
 import org.jabref.logic.journals.JournalAbbreviationLoader;
 import org.jabref.logic.l10n.Localization;
 import org.jabref.model.database.BibDatabaseContext;
+import org.jabref.toolkit.cli.converter.CygWinPathConverter;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

jabkit/src/main/java/org/jabref/cli/Convert.java → jabkit/src/main/java/org/jabref/toolkit/cli/Convert.java

@@ -1,4 +1,4 @@
-package org.jabref.cli;
+package org.jabref.toolkit.cli;
 
 import java.io.IOException;
 import java.nio.file.Path;
@@ -8,14 +8,14 @@
 import javax.xml.parsers.ParserConfigurationException;
 import javax.xml.transform.TransformerException;
 
-import org.jabref.cli.converter.CygWinPathConverter;
 import org.jabref.logic.exporter.Exporter;
 import org.jabref.logic.exporter.ExporterFactory;
 import org.jabref.logic.exporter.SaveException;
 import org.jabref.logic.importer.ParserResult;
 import org.jabref.logic.journals.JournalAbbreviationRepository;
 import org.jabref.logic.l10n.Localization;
 import org.jabref.model.database.BibDatabaseContext;
+import org.jabref.toolkit.cli.converter.CygWinPathConverter;
 
 import com.airhacks.afterburner.injection.Injector;
 import org.jspecify.annotations.NonNull;

jabkit/src/main/java/org/jabref/cli/DoiToBibtex.java → jabkit/src/main/java/org/jabref/toolkit/cli/DoiToBibtex.java

@@ -1,4 +1,4 @@
-package org.jabref.cli;
+package org.jabref.toolkit.cli;
 
 import java.io.IOException;
 import java.io.OutputStreamWriter;

jabkit/src/main/java/org/jabref/cli/Fetch.java → jabkit/src/main/java/org/jabref/toolkit/cli/Fetch.java

@@ -1,4 +1,4 @@
-package org.jabref.cli;
+package org.jabref.toolkit.cli;
 
 import java.nio.file.Path;
 import java.util.List;

jabkit/src/main/java/org/jabref/cli/GenerateBibFromAux.java → jabkit/src/main/java/org/jabref/toolkit/cli/GenerateBibFromAux.java

@@ -1,11 +1,10 @@
-package org.jabref.cli;
+package org.jabref.toolkit.cli;
 
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.Optional;
 import java.util.stream.Collectors;
 
-import org.jabref.cli.converter.CygWinPathConverter;
 import org.jabref.logic.auxparser.AuxParser;
 import org.jabref.logic.auxparser.AuxParserResult;
 import org.jabref.logic.auxparser.AuxParserStatisticsProvider;
@@ -14,6 +13,7 @@
 import org.jabref.logic.l10n.Localization;
 import org.jabref.model.database.BibDatabase;
 import org.jabref.model.entry.BibEntry;
+import org.jabref.toolkit.cli.converter.CygWinPathConverter;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

jabkit/src/main/java/org/jabref/cli/GenerateCitationKeys.java → jabkit/src/main/java/org/jabref/toolkit/cli/GenerateCitationKeys.java

@@ -1,15 +1,15 @@
-package org.jabref.cli;
+package org.jabref.toolkit.cli;
 
 import java.nio.file.Path;
 import java.util.Optional;
 import java.util.stream.Collectors;
 
-import org.jabref.cli.converter.CygWinPathConverter;
 import org.jabref.logic.citationkeypattern.CitationKeyGenerator;
 import org.jabref.logic.importer.ParserResult;
 import org.jabref.logic.l10n.Localization;
 import org.jabref.model.database.BibDatabaseContext;
 import org.jabref.model.entry.BibEntry;
+import org.jabref.toolkit.cli.converter.CygWinPathConverter;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

jabkit/src/main/java/org/jabref/cli/Pdf.java → jabkit/src/main/java/org/jabref/toolkit/cli/Pdf.java

@@ -1,4 +1,4 @@
-package org.jabref.cli;
+package org.jabref.toolkit.cli;
 
 import static picocli.CommandLine.Command;
 import static picocli.CommandLine.Mixin;

jabkit/src/main/java/org/jabref/cli/PdfUpdate.java → jabkit/src/main/java/org/jabref/toolkit/cli/PdfUpdate.java

@@ -1,4 +1,4 @@
-package org.jabref.cli;
+package org.jabref.toolkit.cli;
 
 import java.io.IOException;
 import java.nio.file.Files;
@@ -9,7 +9,6 @@
 import javax.xml.parsers.ParserConfigurationException;
 import javax.xml.transform.TransformerException;
 
-import org.jabref.cli.converter.CygWinPathConverter;
 import org.jabref.logic.FilePreferences;
 import org.jabref.logic.bibtex.FieldPreferences;
 import org.jabref.logic.exporter.EmbeddedBibFilePdfExporter;
@@ -24,6 +23,7 @@
 import org.jabref.model.database.BibDatabaseMode;
 import org.jabref.model.entry.BibEntry;
 import org.jabref.model.entry.BibEntryTypesManager;
+import org.jabref.toolkit.cli.converter.CygWinPathConverter;
 
 import com.airhacks.afterburner.injection.Injector;
 import org.slf4j.Logger;

jabkit/src/main/java/org/jabref/cli/Preferences.java → jabkit/src/main/java/org/jabref/toolkit/cli/Preferences.java

@@ -1,4 +1,4 @@
-package org.jabref.cli;
+package org.jabref.toolkit.cli;
 
 import java.nio.file.Path;
 import java.util.concurrent.Callable;

jabkit/src/main/java/org/jabref/cli/Pseudonymize.java → jabkit/src/main/java/org/jabref/toolkit/cli/Pseudonymize.java

@@ -1,17 +1,17 @@
-package org.jabref.cli;
+package org.jabref.toolkit.cli;
 
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.Optional;
 
-import org.jabref.cli.converter.CygWinPathConverter;
 import org.jabref.logic.importer.ParserResult;
 import org.jabref.logic.l10n.Localization;
 import org.jabref.logic.pseudonymization.Pseudonymization;
 import org.jabref.logic.pseudonymization.PseudonymizationResultCsvWriter;
 import org.jabref.logic.util.io.FileUtil;
 import org.jabref.model.database.BibDatabaseContext;
+import org.jabref.toolkit.cli.converter.CygWinPathConverter;
 
 import io.github.adr.linked.ADR;
 import org.slf4j.Logger;

jabkit/src/main/java/org/jabref/cli/Search.java → jabkit/src/main/java/org/jabref/toolkit/cli/Search.java

@@ -1,4 +1,4 @@
-package org.jabref.cli;
+package org.jabref.toolkit.cli;
 
 import java.io.IOException;
 import java.nio.file.Path;
@@ -8,7 +8,6 @@
 import javax.xml.parsers.ParserConfigurationException;
 import javax.xml.transform.TransformerException;
 
-import org.jabref.cli.converter.CygWinPathConverter;
 import org.jabref.logic.exporter.Exporter;
 import org.jabref.logic.exporter.ExporterFactory;
 import org.jabref.logic.exporter.SaveException;
@@ -24,6 +23,7 @@
 import org.jabref.model.database.BibDatabaseContext;
 import org.jabref.model.entry.BibEntry;
 import org.jabref.model.search.query.SearchQuery;
+import org.jabref.toolkit.cli.converter.CygWinPathConverter;
 
 import com.airhacks.afterburner.injection.Injector;
 import org.slf4j.Logger;

jabkit/src/main/java/org/jabref/cli/converter/CygWinPathConverter.java → jabkit/src/main/java/org/jabref/toolkit/cli/converter/CygWinPathConverter.java

@@ -1,4 +1,4 @@
-package org.jabref.cli.converter;
+package org.jabref.toolkit.cli.converter;
 
 import java.nio.file.Path;
 

jabkit/src/test/java/org/jabref/cli/AbstractJabKitTest.java → jabkit/src/test/java/org/jabref/toolkit/cli/AbstractJabKitTest.java

@@ -1,4 +1,4 @@
-package org.jabref.cli;
+package org.jabref.toolkit.cli;
 
 import java.io.ByteArrayOutputStream;
 import java.io.PrintStream;

jabkit/src/test/java/org/jabref/cli/ArgumentProcessorTest.java → jabkit/src/test/java/org/jabref/toolkit/cli/ArgumentProcessorTest.java

@@ -1,4 +1,4 @@
-package org.jabref.cli;
+package org.jabref.toolkit.cli;
 
 import java.io.IOException;
 import java.net.URISyntaxException;

jabkit/src/test/java/org/jabref/cli/ConvertTest.java → jabkit/src/test/java/org/jabref/toolkit/cli/ConvertTest.java

@@ -1,4 +1,4 @@
-package org.jabref.cli;
+package org.jabref.toolkit.cli;
 
 import java.io.IOException;
 import java.nio.file.Files;

jabkit/src/test/java/org/jabref/cli/PseudonymizeTest.java → jabkit/src/test/java/org/jabref/toolkit/cli/PseudonymizeTest.java

@@ -1,4 +1,4 @@
-package org.jabref.cli;
+package org.jabref.toolkit.cli;
 
 import java.io.IOException;
 import java.nio.charset.Charset;

jabkit/src/test/java/org/jabref/cli/SearchTest.java → jabkit/src/test/java/org/jabref/toolkit/cli/SearchTest.java

@@ -1,4 +1,4 @@
-package org.jabref.cli;
+package org.jabref.toolkit.cli;
 
 import java.io.IOException;
 import java.nio.file.Files;

test-support/src/main/java/org/jabref/support/CommonArchitectureTest.java

@@ -31,6 +31,7 @@ public class CommonArchitectureTest {
     private static final String PACKAGE_ORG_JABREF_LOGIC = "org.jabref.logic..";
     private static final String PACKAGE_ORG_JABREF_MODEL = "org.jabref.model..";
     private static final String PACKAGE_ORG_JABREF_CLI = "org.jabref.cli..";
+    private static final String PACKAGE_ORG_JABREF_TOOLKIT_CLI = "org.jabref.toolkit.cli..";
 
     @ArchTest
     public void doNotUseApacheCommonsLang3(JavaClasses classes) {
@@ -149,7 +150,9 @@ public void restrictToSlf4jLogger(JavaClasses classes) {
 
     @ArchTest
     public void restrictStandardStreams(JavaClasses classes) {
-        ArchRuleDefinition.noClasses().that().resideOutsideOfPackages(PACKAGE_ORG_JABREF_CLI)
+        ArchRuleDefinition.noClasses().that().resideOutsideOfPackages(
+                                  PACKAGE_ORG_JABREF_CLI,
+                                  PACKAGE_ORG_JABREF_TOOLKIT_CLI)
                           .and().resideOutsideOfPackages("org.jabref.gui.openoffice..") // Uses LibreOffice SDK
                           .and().areNotAnnotatedWith(AllowedToUseStandardStreams.class)
                           .should(GeneralCodingRules.ACCESS_STANDARD_STREAMS)