What's the best way to remove extraneous outputs from a task? Context: • I'm passing a task to

srcDir()

; the sources root should be, e.g.,

generated/sources/openApiClient/java/main

. • However, the actual sources root is `generated/sources/openApiClient`; this is because the task generates other (unneeded) files in this directory. • Having an incorrect sources root causes weird behavior in IntelliJ (and possibly other IDEs). Here's the relevant excerpt:

sourceSets {
    main {
        java {
            srcDir(tasks.named("openApiJavaGenerateServer"))
            srcDir(tasks.named("openApiJavaGenerateClient"))
        }
    }
}

Let's start with the BAD way to do it. First, we rewire the tasks:

tasks.withType<JavaCompile> {
    dependsOn("openApiJavaGenerateServer", "openApiJavaGenerateClient")
}

sourceSets {
    main {
        java {
            srcDir(layout.buildDirectory.dir("generated/sources/openApiServer/java/main"))
            srcDir(layout.buildDirectory.dir("generated/sources/openApiClient/java/main"))
        }
    }
}

While not strictly necessary, you can also add a

doLast

block to the original task that deletes unneeded files:

doLast {
        val outputDir = layout.buildDirectory.dir("generated/sources/openApiClient").get().asFile
        for (file in outputDir.listFiles()) {
            if (file.name != "java") {
                file.deleteRecursively()
            }
        }
    }

I've confirmed that this works and the strange behavior in IntelliJ goes away. So now that we have the bad way of doing this, here's my question: what's the good way?

You can disable almost all files and make the code generated in the root output directory. That is how I used the open API generation plugin. I think I detailed it here or on the forums some while ago, so search in the forums and linen. To do it without that, you would probably need something like

srcDir(openApiGenerate.map { it.targetDirectory.dir("java/main") }

or something similar, depending on the properties available.

Do you by chance know what you put in

.openapi-generator-ignore

? For one of my tasks, I need all the Java sources that are generated as part of the supporting files, but all other supporting files should be suppressed. At that point, it should be a simple as tweaking

outputDir

and

sourceFolder

Have to remember what project that was and then check

ACK. Also, in a

buildSrc

plugin, what's the correct way to reference a file in

buildSrc/src/main/resources

(as opposed to

src/main/resources

for the project that consumes the plugin)?

Get it as resource from a

Class

or

Classloader

like in any other Java project.

It ends up being a little trickier than that, because it's a file in a JAR. It may be best to add a

doFirst

to the task that creates the file.

doFirst {
        val ignorePath = "generated/sources/openApiClient/java/main/.openapi-generator-ignore"
        val ignoreFile = layout.buildDirectory.file(ignorePath).get().asFile
        ignoreFile.parentFile.mkdirs()
        val contents = "" // TODO
        ignoreFile.writeText(contents)
    }

Do you by chance know what you put in

.openapi-generator-ignore

?

/build/generated/sources/openapi/main/java/**
!build/generated/sources/openapi/main/java/org/**

With

layout.buildDirectory.dir("generated/sources/openapi/main/java")

as output dir, the three packages set to

org....

and the

sourceFolder

set to an empty string. The ignore file is directly in the project root and configured via

ignoreFileOverride

which is additionally added as input file due to #10214.