-
-
Notifications
You must be signed in to change notification settings - Fork 3k
Update IntelliJ setup instructions with Gradle workaround #14234
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
5815cbc
a725bd4
e0a619f
0fca4b6
39e6d2d
3b0e0b1
94b84e3
31b947e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,7 +16,7 @@ jablib/src/main/resources/csl-locales | |
|
|
||
| javafx/ | ||
|
|
||
| # genreated by gg.cmd | ||
| # generated by gg.cmd | ||
| m2 | ||
| gg.cmd | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -6,6 +6,39 @@ 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 <https://github.com/eirikb/gg/releases/latest/download/gg.cmd> | ||||||||||
| 2. Move the file into your JabRef code | ||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
| 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. | ||||||||||
|
Comment on lines
+26
to
+27
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
|
|
||||||||||
| When the command line hangs at `:jablib:processResources`, you need to keep waiting there. | ||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
| 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: | ||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
| > | ||||||||||
| > ```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. | ||||||||||
|
|
@@ -59,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. | ||||||||||
|
|
||||||||||
|
|
@@ -71,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 | ||||||||||
|
|
||||||||||
|
|
||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are we sure the community edition doesn't have this issue?