Update Gradle from 6.8.3 to 7.0

.gitignore

@@ -1,6 +1,7 @@
 # no generated files in version control
 src/main/gen/
 src/main/generated/
+src-gen/
 
 # private data
 /buildres/jabref-cert-2016.p12

build.gradle

@@ -33,6 +33,8 @@ plugins {
     id 'checkstyle'
 
     id 'project-report'
+
+    id 'idea'
 }
 
 // Enable following for debugging
@@ -72,9 +74,9 @@ modularity.disableEffectiveArgumentsAdjustment()
 sourceSets {
     main {
         java {
-            srcDirs = ["src/main/java", "src/main/generated"]
+            // src-gen reasoning: https://stackoverflow.com/a/64612308/873282
+            srcDirs = ["src/main/java", "src-gen/main/java"]
         }
-
         resources {
             srcDirs = ["src/main/java", "src/main/resources"]
         }
@@ -274,6 +276,7 @@ task checkOutdatedDependencies(dependsOn: dependencyUpdates) {
 
 clean {
     delete "src/main/generated"
+    delete "src-gen"
 }
 
 processResources {
@@ -322,8 +325,8 @@ tasks.register("generateBstGrammarSource", JavaExec) {
     description = 'Generates BstLexer.java and BstParser.java from the Bst.g grammar file using antlr3.'
 
     inputs.dir('src/main/antlr3/org/jabref/bst/')
-    outputs.dir("src/main/generated/org/jabref/logic/bst/")
-    args = ["-o", "$projectDir/src/main/generated/org/jabref/logic/bst/" , "$projectDir/src/main/antlr3/org/jabref/bst/Bst.g" ]
+    outputs.dir("src-gen/main/java/org/jabref/logic/bst/")
+    args = ["-o", "src-gen/main/java/org/jabref/logic/bst/" , "$projectDir/src/main/antlr3/org/jabref/bst/Bst.g" ]
 }
 
 tasks.register("generateSearchGrammarSource", JavaExec) {
@@ -333,16 +336,16 @@ tasks.register("generateSearchGrammarSource", JavaExec) {
     description = "Generates java files for Search.g antlr4."
 
     inputs.dir("src/main/antlr4/org/jabref/search/")
-    outputs.dir("src/main/generated/org/jabref/search/")
-    args  = ["-o","$projectDir/src/main/generated/org/jabref/search" , "-visitor", "-no-listener", "-package", "org.jabref.search", "$projectDir/src/main/antlr4/org/jabref/search/Search.g4"]
+    outputs.dir("src-gen/main/java/org/jabref/search/")
+    args  = ["-o","src-gen/main/java/org/jabref/search" , "-visitor", "-no-listener", "-package", "org.jabref.search", "$projectDir/src/main/antlr4/org/jabref/search/Search.g4"]
 }
 
 task generateMedlineSource(type: XjcTask) {
     group = 'JabRef'
     description = "Generates java files for the medline importer."
 
     schemaFile = "src/main/resources/xjc/medline/medline.xsd"
-    outputDirectory = "src/main/generated"
+    outputDirectory = "src-gen/main/java"
     javaPackage = "org.jabref.logic.importer.fileformat.medline"
 }
 
@@ -351,7 +354,7 @@ task generateBibtexmlSource(type: XjcTask) {
     description = "Generates java files for the bibtexml importer."
 
     schemaFile = "src/main/resources/xjc/bibtexml/bibtexml.xsd"
-    outputDirectory = "src/main/generated/"
+    outputDirectory = "src-gen/main/java/"
     javaPackage = "org.jabref.logic.importer.fileformat.bibtexml"
 }
 
@@ -360,7 +363,7 @@ task generateEndnoteSource(type: XjcTask) {
     description = "Generates java files for the endnote importer."
 
     schemaFile = "src/main/resources/xjc/endnote/endnote.xsd"
-    outputDirectory = "src/main/generated/"
+    outputDirectory = "src-gen/main/java/"
     javaPackage = "org.jabref.logic.importer.fileformat.endnote"
 }
 
@@ -370,7 +373,7 @@ task generateModsSource(type: XjcTask) {
 
     schemaFile = "src/main/resources/xjc/mods/mods-3-7.xsd"
     bindingFile = "src/main/resources/xjc/mods/mods-binding.xjb"
-    outputDirectory = "src/main/generated/"
+    outputDirectory = "src-gen/main/java"
     javaPackage = "org.jabref.logic.importer.fileformat.mods"
     arguments = '-npa'
 }
@@ -394,7 +397,7 @@ compileJava {
     options.compilerArgs << "-Xlint:none"
     dependsOn "generateSource"
 
-    options.annotationProcessorGeneratedSourcesDirectory = file("${projectDir}/src/main/generated")
+    options.annotationProcessorGeneratedSourcesDirectory = file("src-gen/main/java")
 
     moduleOptions {
         // TODO: Remove access to internal api
@@ -776,3 +779,11 @@ task downloadDependencies {
         }
     }
 }
+
+idea {
+    module {
+        // documentation: https://docs.gradle.org/current/dsl/org.gradle.plugins.ide.idea.model.IdeaModule.html
+        generatedSourceDirs += file("src-gen/main/java")
+        downloadJavadoc = true
+    }
+}

docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace.md

@@ -114,7 +114,7 @@ Navigate to **File \| Settings \| Build, Execution, Deployment \| Build Tools \|
 
 To prepare IntelliJ's build system two additional steps are required:
 
-* Navigate to **File \| Settings \| Build, Execution, Deployment \| Compiler \| Java Compiler**, and under "Override compiler parameters per-module" add \(\[+\]\) the following compiler arguments for the `JabRef.main` module:
+* Navigate to **File \| Settings \| Build, Execution, Deployment \| Compiler \| Java Compiler**, and under "Override compiler parameters per-module" add \(\[+\]\) the following compiler arguments for the `JabRef.main` module. Otherwise, you will get: `java: package com.sun.javafx.scene.control is not visible (package com.sun.javafx.scene.control is declared in module javafx.controls, which does not export it to module org.jabref)`
 
   ```text
    --add-exports=javafx.controls/com.sun.javafx.scene.control=org.jabref
@@ -171,7 +171,7 @@ To use IntelliJ IDEA's internal build system when you build JabRef through **Bui
 
 Essentially, you now have the best of both worlds: You can run Gradle tasks using the Gradle Tool Window and unless you haven't made changes to input files that generate sources, you can compile and run with IntelliJ's faster internal build system.
 
-In case all steps are followed, and there are still issues with `SearchBaseVisitor` \(e.g., `Error:(16, 25) java: package org.jabref.search does not exist`\), you have to delete `generated\org\jabref\gui\logging\plugins\Log4jPlugins.java`. This is independent of having enabled or disabled Annotation Processing \(see above at "Enable Annotation Processing"\).
+In case all steps are followed, and there are still issues with `SearchBaseVisitor` \(e.g., `Error:(16, 25) java: package org.jabref.search does not exist`\), you have to delete `src\main\generated\org\jabref\gui\logging\plugins\Log4jPlugins.java`. This is independent of having enabled or disabled Annotation Processing \(see above at "Enable Annotation Processing"\).
 
 #### Using JabRef's code style
 
@@ -271,11 +271,17 @@ Another indication is following output
 java.lang.UnsupportedClassVersionError: org/javamodularity/moduleplugin/ModuleSystemPlugin has been compiled by a more recent version of the Java Runtime (class file version 55.0), this version of the Java Runtime only recognizes class file versions up to 52.0
 ```
 
-### Problems with generated source files
+### Issues with generated source files
 
 In rare cases you might encounter problems due to out-dated automatically generated source files. Running `./gradlew clean` deletes these old copies. Do not forget to run at least `./gradlew eclipse` or `./gradlew build` afterwards to regenerate the source files.
+``
+### Issues with `buildSrc`
 
-### Problems with openjfx libraries in local maven repository
+1. Open the context menu of `buildSrc`.
+1. Select "Load/Unload modules".
+1. Unload `jabRef.buildSrc`.
+
+### Issues with openjfx libraries in local maven repository
 
 There might be problems with building if you have openjfx libraries in local maven repository, resulting in errors like this: