Unable to use Intellij with a generated sources folder

java

build-helper-plugin

maven-structure

gradle-configuration

byAnton Shumikhin·Oct 8, 2024

Quickly integrate generated sources in IntelliJ by marking them as Generated Sources Root. Right-click the folder under Project View and select Mark Directory as > Generated Sources Root. Ensure your build tool configuration (pom.xml for Maven, build.gradle for Gradle) outputs to the right place.

For Maven:

<plugin>
    <!-- build-helper-maven-plugin: like a Swiss army knife -->
    <artifactId>build-helper-maven-plugin</artifactId>
    <executions>
        <execution>
            <!-- gotta get'em all (sources, that is!) -->
            <goals><goal>add-source</goal></goals>
            <configuration>
                <!-- M.O.D. – Mother of Directories -->
                <sources><source>${project.build.directory}/generated-sources</source></sources>
            </configuration>
        </execution>
    </executions>
</plugin>

For Gradle:

// Lock and load all sources
sourceSets.main.java.srcDir 'src/main/generated'

After modifications, resync your project so IntelliJ can compile the generated sources.

Leveling Up with build-helper plugin

The build-helper-maven-plugin is more than just a one-hit wonder. It also attaches additional resource directories, separating API, SPI, or test resources, sharpening your project's modularity and readability.

Maven structure alignment

Structure consistency is key. Make sure your Maven project's structure in IntelliJ matches pom.xml to avoid conflicts and subtle issues.

Handling Gradle like a Pro

Beyond sourceSets in Gradle builds, you might need to configure buildDir.absolutePath or add a package prefix for hassle-free project handling. Remember, "All well-configured projects lead to flawless coding".

When all else fails

If problems persist, remember: "Google is your friend!" Use IntelliJ's official documentation, community threads, or explore alternative tools. Tech-support is often a button's click away. Also, compatibility check can save a lot of time and frustration.

Tips to navigate the maze

While exploring the generated sources, there are a few pointers that can make your journey easy:

Source paths for custom plugins

If you’re using custom plugins, ensure the source path matches the one in your pom.xml or build.gradle files. As Mom always says, "Matches are important, be it work or source paths".

No more Source folder misses

In case IntelliJ decides to play hide and seek with source folders, use Project Structure for manual configurations. It's like playing detective, only more rewarding!

Coding in Kotlin or other JVM languages

Living the non-java life? Worry not, just leverage Kotlin-specific build scripts syntax to define source sets and voila, your setup hiccups are gone!

Gradle Dynamism

While dealing with srcDir and buildDir.absolutePath in build.gradle, remember to maintain adaptive referencing for your source directories. It's like having a GPS, for a smoother code journey.

Vigilance is the key

Review your build process resources regularly - you'll be surprised how many potential hitches can be saved by judicious lookout. Remember, "Prevention is better than a bug hunt!"

explain-codes / Java / Unable to use Intellij with a generated sources folder

Linked

Intellij - Convert a Java project/module into a Maven project/module



Maven plugins cannot be found in IntelliJ



Maven package works but IntelliJ's build fails



Intellij IDEA 13 uses Java 1.5 despite setting to 1.7



Best way to add Gradle support to IntelliJ Project

