Skip to content
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.

Sign up for GitHub

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

Switch from src-gen to src/main/generated #8044

Closed
wants to merge 1 commit into from
Closed

Switch from src-gen to src/main/generated #8044

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 10 additions & 12 deletions build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,7 @@ modularity.disableEffectiveArgumentsAdjustment()
sourceSets {
main {
java {
// src-gen reasoning: https://stackoverflow.com/a/64612308/873282
srcDirs = ["src/main/java", "src-gen/main/java"]
srcDirs = ["src/main/java", "src/main/generated"]
}
resources {
srcDirs = ["src/main/java", "src/main/resources"]
Expand Down Expand Up @@ -270,7 +269,6 @@ task checkOutdatedDependencies(dependsOn: dependencyUpdates) {

clean {
delete "src/main/generated"
delete "src-gen"
}

processResources {
Expand Down Expand Up @@ -319,8 +317,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-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" ]
outputs.dir("src/main/generated/org/jabref/logic/bst/")
args = ["-o", "src/main/generated/org/jabref/logic/bst/" , "$projectDir/src/main/antlr3/org/jabref/bst/Bst.g" ]
}

tasks.register("generateSearchGrammarSource", JavaExec) {
Expand All @@ -330,16 +328,16 @@ tasks.register("generateSearchGrammarSource", JavaExec) {
description = "Generates java files for Search.g antlr4."

inputs.dir("src/main/antlr4/org/jabref/search/")
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"]
outputs.dir("src/main/generated/org/jabref/search/")
args = ["-o","src/main/generated/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-gen/main/java"
outputDirectory = "src/main/generated"
javaPackage = "org.jabref.logic.importer.fileformat.medline"
}

Expand All @@ -348,7 +346,7 @@ task generateBibtexmlSource(type: XjcTask) {
description = "Generates java files for the bibtexml importer."

schemaFile = "src/main/resources/xjc/bibtexml/bibtexml.xsd"
outputDirectory = "src-gen/main/java/"
outputDirectory = "src/main/generated/"
javaPackage = "org.jabref.logic.importer.fileformat.bibtexml"
}

Expand All @@ -357,7 +355,7 @@ task generateEndnoteSource(type: XjcTask) {
description = "Generates java files for the endnote importer."

schemaFile = "src/main/resources/xjc/endnote/endnote.xsd"
outputDirectory = "src-gen/main/java/"
outputDirectory = "src/main/generated/"
javaPackage = "org.jabref.logic.importer.fileformat.endnote"
}

Expand All @@ -367,7 +365,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-gen/main/java"
outputDirectory = "src/main/generated"
javaPackage = "org.jabref.logic.importer.fileformat.mods"
arguments = '-npa'
}
Expand All @@ -391,7 +389,7 @@ compileJava {
options.compilerArgs << "-Xlint:none"
dependsOn "generateSource"

options.annotationProcessorGeneratedSourcesDirectory = file("src-gen/main/java")
options.annotationProcessorGeneratedSourcesDirectory = file("src/main/generated")

moduleOptions {
// TODO: Remove access to internal api
Expand Down
13 changes: 1 addition & 12 deletions docs/getting-into-the-code/guidelines-for-setting-up-a-local-workspace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,18 +153,7 @@ To use IntelliJ IDEA's internal build system when you build JabRef through **Bui

![Ignore the Gradle project &quot;buildSrc&quot;](../.gitbook/assets/intellij-gradle-config-ignore-buildSrc%20%282%29%20%282%29%20%282%29%20%283%29%20%283%29%20%286%29%20%284%29.png)

* Add `src-gen` as root:
1. Right click on the project "jabref".
2. Select "Open Module Settings"
3. Expand "JabRef"
4. Select "main"
5. Select tab "Sources"
6. Click "+ Add Content Root"
7. Select the `src-gen` directory
8. Click "OK". When expanding "main", "java" should have been selected as source
9. Click "OK" to save the changes
* In case the above step does not work, run with gradle, import gradle project again, and try again.
* Delete `org.jabref.gui.logging.plugins.Log4jPlugins` \(location: `src-gen/main/java/org/jabref/gui/logging/plugins/Log4jPlugins.java`\). Otherwise, you will see following error:
* Delete `org.jabref.gui.logging.plugins.Log4jPlugins` \(location: `src/main/generated/org/jabref/gui/logging/plugins/Log4jPlugins.java`\). Otherwise, you will see following error:

```text
Error:java: Unable to create Plugin Service Class org.jabref.gui.logging.plugins.Log4jPlugins
Expand Down