From 5815cbc4dc53fede445d07c43c5571ce2d331d94 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Wed, 5 Nov 2025 09:39:56 +0100 Subject: [PATCH 01/12] Update IntelliJ setup instructions with Gradle workaround --- .../intellij-11-code-into-ide.md | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md b/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md index 93a540b8b82..afbc5d396bf 100644 --- a/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md +++ b/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md @@ -6,6 +6,29 @@ nav_order: 11 # Step 1: Get the code into IntelliJ +## Pre-condition: Gradle caches filled + +On Linux, with IntelliJ IDEA 2025.2.4 (Ultimate Edition), there are issues with importing. +The workaround is to run JabRef once from the command line. + +- Linux: Execute `./gradlew :jabgui:run` +- Windows (Powershell): Execute `.\gradlew :jabgui:run` + +In case gradle does not find a JDK, use [`gg.cmd`](https://github.com/eirikb/gg) as follows: + +1. Download +2. Move the file into your JabRef code +3. Run the GUI + - Windows: `.\gg.cmd run-gui` + - Linux: `sh -x ./gg.cmd run-gui` + +Background: This is a workaround for following error: + +``` +Could not apply requested plugin [id: 'org.jabref.gradle.module'] as it does not provide a plugin with id 'org.jabref.gradle.module'. This is caused by an incorrect plugin implementation. Please contact the plugin author(s). +> Plugin with id 'org.jabref.gradle.module' not found. +``` + ## IntelliJ Startup Start IntelliJ IDEA. From a725bd4cd5ecaad92e193736e2295e50c4fd1b53 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Wed, 5 Nov 2025 09:44:04 +0100 Subject: [PATCH 02/12] Fix typo --- .gitignore | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index d3fb40a59db..b1185748fca 100644 --- a/.gitignore +++ b/.gitignore @@ -16,7 +16,7 @@ jablib/src/main/resources/csl-locales javafx/ -# genreated by gg.cmd +# generated by gg.cmd m2 gg.cmd From e0a619fd2d14bdf93cd2b483864170b5c65d64cb Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Wed, 5 Nov 2025 09:44:19 +0100 Subject: [PATCH 03/12] Syntaxfix for background --- .../intellij-11-code-into-ide.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md b/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md index afbc5d396bf..8578be12f92 100644 --- a/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md +++ b/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md @@ -22,12 +22,15 @@ In case gradle does not find a JDK, use [`gg.cmd`](https://github.com/eirikb/gg) - Windows: `.\gg.cmd run-gui` - Linux: `sh -x ./gg.cmd run-gui` -Background: This is a workaround for following error: - -``` -Could not apply requested plugin [id: 'org.jabref.gradle.module'] as it does not provide a plugin with id 'org.jabref.gradle.module'. This is caused by an incorrect plugin implementation. Please contact the plugin author(s). -> Plugin with id 'org.jabref.gradle.module' not found. -``` +{: .note } +> Background +> +> This is a workaround for following error: +> +> ``` +> Could not apply requested plugin [id: 'org.jabref.gradle.module'] as it does not provide a plugin with id 'org.jabref.gradle.module'. This is caused by an incorrect plugin implementation. Please contact the plugin author(s). +> > Plugin with id 'org.jabref.gradle.module' not found. +> ``` ## IntelliJ Startup From 0fca4b6347d03d67517327e513c2bd1982d87ea9 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Wed, 5 Nov 2025 09:46:17 +0100 Subject: [PATCH 04/12] Refine text --- .../intellij-11-code-into-ide.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md b/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md index 8578be12f92..aaf431c55f1 100644 --- a/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md +++ b/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md @@ -21,6 +21,8 @@ In case gradle does not find a JDK, use [`gg.cmd`](https://github.com/eirikb/gg) 3. Run the GUI - Windows: `.\gg.cmd run-gui` - Linux: `sh -x ./gg.cmd run-gui` +4. Wait several minutes until JabRef comes up. On an Intel(R) Core(TM) i5-1350, it took more than 15 minutes. +5. Close JabRef. {: .note } > Background From 39e6d2d99ec1ebb5d72d659068701be677127310 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Wed, 5 Nov 2025 09:51:15 +0100 Subject: [PATCH 05/12] Refine steps --- .../intellij-11-code-into-ide.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md b/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md index aaf431c55f1..44e61241abf 100644 --- a/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md +++ b/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md @@ -24,6 +24,9 @@ In case gradle does not find a JDK, use [`gg.cmd`](https://github.com/eirikb/gg) 4. Wait several minutes until JabRef comes up. On an Intel(R) Core(TM) i5-1350, it took more than 15 minutes. 5. Close JabRef. +When the command line hangs at `:jablib:processResources`, you need to keep waiting there. +However, in parallel, you can continue setting up IntelliJ below, because the initial Gradle setup succeeded. + {: .note } > Background > From 3b0e0b1eac563c78e0f4403aa4dfc3a546f399dc Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Wed, 5 Nov 2025 10:41:09 +0100 Subject: [PATCH 06/12] Refine gg.cmd command --- .../org.jabref.gradle.feature.compile.gradle.kts | 1 + .../intellij-11-code-into-ide.md | 14 ++++++++------ 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/build-logic/src/main/kotlin/org.jabref.gradle.feature.compile.gradle.kts b/build-logic/src/main/kotlin/org.jabref.gradle.feature.compile.gradle.kts index 12bf831596e..5e399bffdc9 100644 --- a/build-logic/src/main/kotlin/org.jabref.gradle.feature.compile.gradle.kts +++ b/build-logic/src/main/kotlin/org.jabref.gradle.feature.compile.gradle.kts @@ -6,6 +6,7 @@ java { toolchain { // If this is updated, also update // - build.gradle -> jacoco -> toolVersion (because JaCoCo does not support newest JDK out of the box. Check versions at https://www.jacoco.org/jacoco/trunk/doc/changes.html) + // - docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md -> java version provided to `gg.cmd` // - jitpack.yml // - .devcontainer/devcontainer.json#L34 - there, also check if the gradleVersion matches the one of gradle/wrapper/gradle-wrapper.properties // - .moderne/moderne.yml diff --git a/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md b/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md index 44e61241abf..be27b4c6e3b 100644 --- a/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md +++ b/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md @@ -19,10 +19,12 @@ In case gradle does not find a JDK, use [`gg.cmd`](https://github.com/eirikb/gg) 1. Download 2. Move the file into your JabRef code 3. Run the GUI - - Windows: `.\gg.cmd run-gui` - - Linux: `sh -x ./gg.cmd run-gui` -4. Wait several minutes until JabRef comes up. On an Intel(R) Core(TM) i5-1350, it took more than 15 minutes. -5. Close JabRef. + + - Windows: `.\gg.cmd gradle:java@24 jabgui:compileJava` + - Linux: `sh -x ./gg.cmd gradle:java@24 jabgui:compileJava` + +4. Wait several minutes until command completes. + On an Intel(R) Core(TM) i5-1350 (16 GB RAM), it took more than 15 minutes. When the command line hangs at `:jablib:processResources`, you need to keep waiting there. However, in parallel, you can continue setting up IntelliJ below, because the initial Gradle setup succeeded. @@ -32,7 +34,7 @@ However, in parallel, you can continue setting up IntelliJ below, because the in > > This is a workaround for following error: > -> ``` +> ```text > Could not apply requested plugin [id: 'org.jabref.gradle.module'] as it does not provide a plugin with id 'org.jabref.gradle.module'. This is caused by an incorrect plugin implementation. Please contact the plugin author(s). > > Plugin with id 'org.jabref.gradle.module' not found. > ``` @@ -90,7 +92,7 @@ Allow also access for both cases and click "Allow access". ## Wait for IntelliJ IDEA to import the gradle project -IntelliJ shows "Importing 'jabref' Gradle Project" at the lower right corner. +IntelliJ shows "Importing 'jabref' Gradle Project" in the lower right corner. This will take several minutes. Wait until this disappears. From 94b84e30300e9282b64b58dc59c1bf615fc8728d Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Wed, 5 Nov 2025 10:42:17 +0100 Subject: [PATCH 07/12] Fix casing --- .../intellij-11-code-into-ide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md b/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md index be27b4c6e3b..e91b732bba9 100644 --- a/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md +++ b/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md @@ -14,7 +14,7 @@ The workaround is to run JabRef once from the command line. - Linux: Execute `./gradlew :jabgui:run` - Windows (Powershell): Execute `.\gradlew :jabgui:run` -In case gradle does not find a JDK, use [`gg.cmd`](https://github.com/eirikb/gg) as follows: +In case Gradle does not find a JDK, use [`gg.cmd`](https://github.com/eirikb/gg) as follows: 1. Download 2. Move the file into your JabRef code From 31b947ebf06632f332237c732ac51e4141c669dd Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Wed, 5 Nov 2025 10:43:54 +0100 Subject: [PATCH 08/12] Fix linting errors --- .../intellij-11-code-into-ide.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md b/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md index e91b732bba9..d4e30b094f2 100644 --- a/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md +++ b/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md @@ -104,9 +104,9 @@ Wait until this disappears. You can disregard notifications -* offering to reopen the project in a container -* announcing the project JDK -* suggesting that you install the plugin WireMock +- offering to reopen the project in a container +- announcing the project JDK +- suggesting that you install the plugin WireMock ## IntelliJ IDEA may report low memory From 3d175994420a74da721ae4f2226e7f502ad41438 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Thu, 6 Nov 2025 09:47:26 +0100 Subject: [PATCH 09/12] Apply suggestions from code review Co-authored-by: Subhramit Basu --- .../intellij-11-code-into-ide.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md b/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md index d4e30b094f2..6668f367e84 100644 --- a/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md +++ b/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md @@ -17,22 +17,22 @@ The workaround is to run JabRef once from the command line. In case Gradle does not find a JDK, use [`gg.cmd`](https://github.com/eirikb/gg) as follows: 1. Download -2. Move the file into your JabRef code +2. Move the file to your JabRef project directory 3. Run the GUI - Windows: `.\gg.cmd gradle:java@24 jabgui:compileJava` - Linux: `sh -x ./gg.cmd gradle:java@24 jabgui:compileJava` -4. Wait several minutes until command completes. - On an Intel(R) Core(TM) i5-1350 (16 GB RAM), it took more than 15 minutes. +4. Wait until the command execution completes. + On an Intel(R) Core(TM) i5-1350 (16 GB RAM), it takes more than 15 minutes. -When the command line hangs at `:jablib:processResources`, you need to keep waiting there. +The command line may appear to hang at `:jablib:processResources`, you still need to keep waiting. However, in parallel, you can continue setting up IntelliJ below, because the initial Gradle setup succeeded. {: .note } > Background > -> This is a workaround for following error: +> The above is a workaround for following error: > > ```text > Could not apply requested plugin [id: 'org.jabref.gradle.module'] as it does not provide a plugin with id 'org.jabref.gradle.module'. This is caused by an incorrect plugin implementation. Please contact the plugin author(s). From 9ba05d7d9ded6202ceb72a977b2bc5a945b90afe Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Thu, 20 Nov 2025 12:16:03 +0100 Subject: [PATCH 10/12] Discard changes to build-logic/src/main/kotlin/org.jabref.gradle.feature.compile.gradle.kts --- .../src/main/kotlin/org.jabref.gradle.feature.compile.gradle.kts | 1 - 1 file changed, 1 deletion(-) diff --git a/build-logic/src/main/kotlin/org.jabref.gradle.feature.compile.gradle.kts b/build-logic/src/main/kotlin/org.jabref.gradle.feature.compile.gradle.kts index 5e399bffdc9..12bf831596e 100644 --- a/build-logic/src/main/kotlin/org.jabref.gradle.feature.compile.gradle.kts +++ b/build-logic/src/main/kotlin/org.jabref.gradle.feature.compile.gradle.kts @@ -6,7 +6,6 @@ java { toolchain { // If this is updated, also update // - build.gradle -> jacoco -> toolVersion (because JaCoCo does not support newest JDK out of the box. Check versions at https://www.jacoco.org/jacoco/trunk/doc/changes.html) - // - docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md -> java version provided to `gg.cmd` // - jitpack.yml // - .devcontainer/devcontainer.json#L34 - there, also check if the gradleVersion matches the one of gradle/wrapper/gradle-wrapper.properties // - .moderne/moderne.yml From 3165698cee31d30ae59c688c4eac6f944fae8ee2 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Thu, 20 Nov 2025 12:19:37 +0100 Subject: [PATCH 11/12] Move to FAQ --- docs/code-howtos/faq.md | 28 ++++++++++++++++ .../intellij-11-code-into-ide.md | 33 ------------------- 2 files changed, 28 insertions(+), 33 deletions(-) diff --git a/docs/code-howtos/faq.md b/docs/code-howtos/faq.md index b8764be33fd..a4e19033356 100644 --- a/docs/code-howtos/faq.md +++ b/docs/code-howtos/faq.md @@ -172,3 +172,31 @@ A: You have to ignore `buildSrc/src/main` as source directory in IntelliJ as ind Also filed as IntelliJ issue [IDEA-240250](https://youtrack.jetbrains.com/issue/IDEA-240250). + +## IDE import issues + +One might see following error: + +```text +Could not apply requested plugin [id: 'org.jabref.gradle.module'] as it does not provide a plugin with id 'org.jabref.gradle.module'. This is caused by an incorrect plugin implementation. Please contact the plugin author(s). +> Plugin with id 'org.jabref.gradle.module' not found. +``` + +This happened on Debian 12, with IntelliJ IDEA 2025.2.4 (Ultimate Edition). +The workaround is to compile JabRef once from the command line. + +* Linux: Execute `./gradlew :jabgui:compileJava` +* Windows (Powershell): Execute `.\gradlew :jabgui:compileJava` + +In case Gradle does not find a JDK, use [`gg.cmd`](https://github.com/eirikb/gg) as follows: + +1. Download +2. Move the file to your JabRef project directory +3. Compile JabRef + + * Windows: `.\gg.cmd gradle:java@24 jabgui:compileJava` + * Linux: `sh -x ./gg.cmd gradle:java@24 jabgui:compileJava` + +4. Wait until the command execution completes. + +After about one minute, however, you can continue setting up IntelliJ, because the initial Gradle setup succeeded. diff --git a/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md b/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md index 6668f367e84..d0b975c422c 100644 --- a/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md +++ b/docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-11-code-into-ide.md @@ -6,39 +6,6 @@ nav_order: 11 # Step 1: Get the code into IntelliJ -## Pre-condition: Gradle caches filled - -On Linux, with IntelliJ IDEA 2025.2.4 (Ultimate Edition), there are issues with importing. -The workaround is to run JabRef once from the command line. - -- Linux: Execute `./gradlew :jabgui:run` -- Windows (Powershell): Execute `.\gradlew :jabgui:run` - -In case Gradle does not find a JDK, use [`gg.cmd`](https://github.com/eirikb/gg) as follows: - -1. Download -2. Move the file to your JabRef project directory -3. Run the GUI - - - Windows: `.\gg.cmd gradle:java@24 jabgui:compileJava` - - Linux: `sh -x ./gg.cmd gradle:java@24 jabgui:compileJava` - -4. Wait until the command execution completes. - On an Intel(R) Core(TM) i5-1350 (16 GB RAM), it takes more than 15 minutes. - -The command line may appear to hang at `:jablib:processResources`, you still need to keep waiting. -However, in parallel, you can continue setting up IntelliJ below, because the initial Gradle setup succeeded. - -{: .note } -> Background -> -> The above is a workaround for following error: -> -> ```text -> Could not apply requested plugin [id: 'org.jabref.gradle.module'] as it does not provide a plugin with id 'org.jabref.gradle.module'. This is caused by an incorrect plugin implementation. Please contact the plugin author(s). -> > Plugin with id 'org.jabref.gradle.module' not found. -> ``` - ## IntelliJ Startup Start IntelliJ IDEA. From 17c1d6c494967c0271d386c35f192212db26df92 Mon Sep 17 00:00:00 2001 From: Oliver Kopp Date: Thu, 20 Nov 2025 12:20:08 +0100 Subject: [PATCH 12/12] Fix position of magic comment --- docs/code-howtos/faq.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/code-howtos/faq.md b/docs/code-howtos/faq.md index a4e19033356..cef52fceb42 100644 --- a/docs/code-howtos/faq.md +++ b/docs/code-howtos/faq.md @@ -171,8 +171,6 @@ A: You have to ignore `buildSrc/src/main` as source directory in IntelliJ as ind Also filed as IntelliJ issue [IDEA-240250](https://youtrack.jetbrains.com/issue/IDEA-240250). - - ## IDE import issues One might see following error: @@ -200,3 +198,5 @@ In case Gradle does not find a JDK, use [`gg.cmd`](https://github.com/eirikb/gg) 4. Wait until the command execution completes. After about one minute, however, you can continue setting up IntelliJ, because the initial Gradle setup succeeded. + +