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

Author: Stewori

.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);
     }
 }

CHANGELOG.md

@@ -16,6 +16,7 @@ Note that this project **does not** adhere to [Semantic Versioning](https://semv
 
 ### Changed
 
+- We renamed packages in `jabkit` to start with `org.jabref.toolkit` to avoid having split packages between `jabkit` and `jabgui`. [#14052](https://github.com/JabRef/jabref/issues/14052)
 - Changed: <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>L</kbd> now opens the terminal in the active library directory (#14130)
 
 ### Fixed

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;

…kit/src/main/java/org/jabref/JabKit.java …main/java/org/jabref/toolkit/JabKit.javajabkit/src/main/java/org/jabref/JabKit.java renamed to jabkit/src/main/java/org/jabref/toolkit/JabKit.java jabkit/src/main/java/org/jabref/JabKit.java renamed to 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;

…va/org/jabref/cli/ArgumentProcessor.java …abref/toolkit/cli/ArgumentProcessor.javajabkit/src/main/java/org/jabref/cli/ArgumentProcessor.java renamed to jabkit/src/main/java/org/jabref/toolkit/cli/ArgumentProcessor.java jabkit/src/main/java/org/jabref/cli/ArgumentProcessor.java renamed to 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;

…ava/org/jabref/cli/CheckConsistency.java …jabref/toolkit/cli/CheckConsistency.javajabkit/src/main/java/org/jabref/cli/CheckConsistency.java renamed to jabkit/src/main/java/org/jabref/toolkit/cli/CheckConsistency.java jabkit/src/main/java/org/jabref/cli/CheckConsistency.java renamed to 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,7 +7,7 @@
 import java.util.Optional;
 import java.util.concurrent.Callable;
 
-import org.jabref.cli.converter.CygWinPathConverter;
+import org.jabref.toolkit.cli.converter.CygWinPathConverter;
 import org.jabref.logic.importer.ParserResult;
 import org.jabref.logic.l10n.Localization;
 import org.jabref.logic.quality.consistency.BibliographyConsistencyCheck;

…/java/org/jabref/cli/CheckIntegrity.java …g/jabref/toolkit/cli/CheckIntegrity.javajabkit/src/main/java/org/jabref/cli/CheckIntegrity.java renamed to jabkit/src/main/java/org/jabref/toolkit/cli/CheckIntegrity.java jabkit/src/main/java/org/jabref/cli/CheckIntegrity.java renamed to 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,7 @@
 import java.util.concurrent.Callable;
 import java.util.stream.Collectors;
 
-import org.jabref.cli.converter.CygWinPathConverter;
+import org.jabref.toolkit.cli.converter.CygWinPathConverter;
 import org.jabref.logic.importer.ParserResult;
 import org.jabref.logic.integrity.IntegrityCheck;
 import org.jabref.logic.integrity.IntegrityCheckResultCsvWriter;

…rc/main/java/org/jabref/cli/Convert.java …java/org/jabref/toolkit/cli/Convert.javajabkit/src/main/java/org/jabref/cli/Convert.java renamed to jabkit/src/main/java/org/jabref/toolkit/cli/Convert.java jabkit/src/main/java/org/jabref/cli/Convert.java renamed to 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,7 +8,7 @@
 import javax.xml.parsers.ParserConfigurationException;
 import javax.xml.transform.TransformerException;
 
-import org.jabref.cli.converter.CygWinPathConverter;
+import org.jabref.toolkit.cli.converter.CygWinPathConverter;
 import org.jabref.logic.exporter.Exporter;
 import org.jabref.logic.exporter.ExporterFactory;
 import org.jabref.logic.exporter.SaveException;

…/src/main/java/org/jabref/cli/Fetch.java …n/java/org/jabref/toolkit/cli/Fetch.javajabkit/src/main/java/org/jabref/cli/Fetch.java renamed to jabkit/src/main/java/org/jabref/toolkit/cli/Fetch.java jabkit/src/main/java/org/jabref/cli/Fetch.java renamed to 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;