Skip to content

generated-sources/java is not picked up as a source path #1639

Open

Description

@gayanper

When importing a maven multi module which has modules which contains generated-sources/java the generated-sources/java folder is not added into the source paths. Only the generated-sources/annotations is added.

Activity

  1. snjeza commented on Sep 29, 2020

    @snjeza
    Collaborator

    @gayanper could you attach a project example?

  2. testforstephen commented on Sep 30, 2020

    @testforstephen
    Collaborator

    Could you share which maven plugin is generating the generated-sources/java folder?

    Usually you need to configure the lifecycle-mapping-metadata for the source generation maven plugins you used in your project's pom.xml additionally.

    #177 (comment) shared several workarounds to handle the extra classpath from generated source.

  3. gayanper commented on Sep 30, 2020

    @gayanper
    ContributorAuthor

    @gayanper could you attach a project example?

    Unfortunately i cannot share the project since its a proprietary codebase.

  4. gayanper commented on Sep 30, 2020

    @gayanper
    ContributorAuthor

    Could you share which maven plugin is generating the generated-sources/java folder?

    Usually you need to configure the lifecycle-mapping-metadata for the source generation maven plugins you used in your project's pom.xml additionally.

    #177 (comment) shared several workarounds to handle the extra classpath from generated source.

    The plugin is a proprietary plugin. The generation and source compilation happens without issues in maven build. The source folders are not detected in vscode. This was a problem in eclipse as well. For eclipse i wrote a m2e extension to handle the source folders.

  5. gayanper commented on Sep 30, 2020

    @gayanper
    ContributorAuthor

    Is there a way i can add my eclipse plugins into vscode java ls plugins folder and make it detect my source folders.

  6. gayanper commented on Sep 30, 2020

    @gayanper
    ContributorAuthor

    Got my plugin to work with hacking the config.ini adding my plugins into bundles. May be it would be nice if can add support for non ui plugins when we need to extend ls with private plugins which cannot be bundled by default

  7. fbricon commented on Sep 30, 2020

    @fbricon
    Collaborator

    you can create a small vscode extension hosting your plugins (provided it doesn't have any Eclipse UI dependencies): https://github.com/redhat-developer/vscode-java/wiki/Contribute-a-Java-Extension#modify-packagejson

  8. DerekBennett commented on Aug 6, 2021

    @DerekBennett

    I am having the exact same problem. I have a custom maven plugin that is generating source code to target/generated-sources/some-proprietary-directory for several modules in a multi-module Maven project. The Maven build succeeds. The VS Code "vscjava.vscode-java-pack" extension does not see these generated sources, thus making my development experience broken and unpleasant. I do not understand the above suggested solutions. Could you please detail how I should change my project to make VS Code comprehend it properly?

  9. rgrunber commented on Aug 13, 2021

    @rgrunber
    Member

    I would look at #177 (comment) as that issue has a pretty comprehensive guide on the options.

    Generally build-helper-maven-plugin seems to be what is working for most people.

    I just tried a basic Maven project with a a folder target/generated-sources/my-extra-dir/ containing a source file in VS Code. I confirmed the sources were not on the classpath/accessible from the source files that were. I then added the code below to my build lifecycle.

    <plugin>
        <!-- a hint for IDE's to add the java sources to the classpath -->
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>build-helper-maven-plugin</artifactId>
        <version>3.0.0</version>
        <executions>
            <execution>
                <id>01-add-test-sources</id>
                <phase>generate-sources</phase>
                <goals>
                    <goal>add-source</goal>
                </goals>
                <configuration>
                    <sources>
                        <source>${project.build.directory}/generated-sources/my-extra-dir/</source>
                    </sources>
                </configuration>
            </execution>
        </executions>
    </plugin>
    

    Just a simple save in VS Code, and once the project rebuilt, I could confirm the my-extra-dir sources ended up in the .classpath and were accessible from the other source files.

  10. HerrDerb commented on Sep 3, 2021

    @HerrDerb

    Sadly it does not even work with the build-helper-maven-plugin plugin. VSC refuses to see the generated sources and won't compile.
    In my case I have a nested Project
    pom
    |
    |--pom <-- not adding the generated sources
    |
    |--pom

  11. jackwener commented on Apr 10, 2022

    @jackwener

    Sadly it does not even work with the build-helper-maven-plugin plugin. VSC refuses to see the generated sources and won't compile. In my case I have a nested Project pom | |--pom <-- not adding the generated sources | |--pom

    I also meet this problem.

  12. csirvents commented on Aug 22, 2022

    @csirvents

    Add the following line <?m2e execute onConfiguration,onIncremental?> inside the build plugin.

    Example:

    <plugin>
                        <groupId>org.openapitools</groupId>
                        <artifactId>openapi-generator-maven-plugin</artifactId>
                        <version>${openapi-generator-maven-plugin.version}</version>
                        <?m2e execute onConfiguration,onIncremental?>
    
  13. manuelserradev commented on Feb 4, 2023

    @manuelserradev

    I'd like to point out to a simple repro project with jpa-streamer as a sources generator here.

    Triggering a full compilation results in target/generated-sources/annotations/<entity>$ to be correctly generated but the sources cannot be referenced in user code (needed in this example for type safe queries, see src/main/java/com/speedment/jpastreamer/demo/quarkus/hibernate/panache/repository/FilmRepository.java).

    Compiling and running the application with the maven CLI results in no problems nor warnings.

  14. 6 remaining items

  15. snjeza commented on May 18, 2023

    @snjeza
    Collaborator

    @getaceres Could you show your .classpath file?

  16. getaceres commented on May 18, 2023

    @getaceres

    I can't find a .classpath file in my project but I've found a Classpath Configuration screen and this is the part of the source folders:

    image
  17. snjeza commented on May 18, 2023

    @snjeza
    Collaborator

    I can't find a .classpath file in my project

    @getaceres You can add

    "java.import.generatesMetadataFilesAtProjectRoot": true,
    
  18. getaceres commented on May 18, 2023

    @getaceres

    I've added that but I still don't get a .classpath file. Instead now I have a bin folder in which the whole project is copied and the project doesn't finish loading.

  19. snjeza commented on May 18, 2023

    @snjeza
    Collaborator

    Could you try to clean the workspace?

    • Open the command palette (F1)
    • select Java: Clean the Java Language Server Workspace
    • select Restart and delete from the confirmation prompt
  20. getaceres commented on May 18, 2023

    @getaceres

    I tried that. Still the same. I don't get a .classpath file but I get a bin folder that gets filled with the same files I have in my project and it never finishes loading until I get this error:

    image
  21. snjeza commented on May 18, 2023

    @snjeza
    Collaborator

    Could you try to set

    "java.jdt.ls.vmargs": "-Daether.dependencyCollector.impl=df -Dlog.level=ALL -Djdt.ls.debug=true  -XX:+UseParallelGC -XX:GCTimeRatio=4 -XX:AdaptiveSizePolicyWeight=90 -Dsun.zip.disableMemoryMapping=true -Xmx6G -Xms512m -Xlog:disable",
    
  22. getaceres commented on May 25, 2023

    @getaceres

    Sorry for the delay. I tried adding that. Still the same. The moment I add the build-helper-maven-plugin it starts generating the /bin folder and when I add "java.import.generatesMetadataFilesAtProjectRoot": true, it never finishes loading the project and I still don't get a .classpath file. What's more, even after deleting this line, the project doesn't load anymore.

  23. dnhuan commented on Jun 14, 2023

    @dnhuan

    I have several projects using the code generator from swagger plugin:

    <groupId>io.swagger.codegen.v3</groupId>
    <artifactId>swagger-codegen-maven-plugin</artifactId>
    

    It generates code into target/generated-sources/swagger/src/gen/java/main

    The projects compile in Maven without any problem and I don't have to add any build-helper-maven-plugin. IntelliJ also recognizes this source folders and I don't have to add anything to the POM file. However, VS Code does not recognize it as a source folder. I've added the configuration

    <plugin>
            <!-- a hint for IDE's to add the java sources to the classpath -->
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>build-helper-maven-plugin</artifactId>
            <version>3.3.0</version>
            <executions>
              <execution>
                <id>01-add-test-sources</id>
                <phase>generate-sources</phase>
                <goals>
                  <goal>add-source</goal>
                </goals>
                <configuration>
                  <sources>
                    <source>${project.build.directory}/generated-sources/swagger/src/gen/java/main</source>
                  </sources>
                </configuration>
              </execution>
            </executions>
          </plugin>
    

    to the POM file as suggested here but still I can't get this folder added to the classpath when I look into the Java Projects panel and any file using classes from this folder is still marked as having compilation errors.

    Instead of specifying the <source/> directory, adding <?m2e execute onConfiguration?> right under <execution> in pom.xml will trigger the language server to recognize the generated source files.

    image
  24. getaceres commented on Jun 16, 2023

    @getaceres
    <plugin>
            <!-- a hint for IDE's to add the java sources to the classpath -->
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>build-helper-maven-plugin</artifactId>
            <version>3.3.0</version>
            <executions>
              <execution>
                <?m2e execute onConfiguration?>
                <id>01-add-test-sources</id>
                <phase>generate-sources</phase>
                <goals>
                  <goal>add-source</goal>
                </goals>
              </execution>
            </executions>
          </plugin>
    

    Like this?

  25. nnikolay commented on May 13, 2024

    @nnikolay

    Hi, I have the same issue the moment I am building SAP CAP Java project with VS code. To not copy the whole post I am linking to stackoverflow.

    https://stackoverflow.com/questions/78467461/cap-java-application-in-vs-code-generated-import-not-found

    Someone has idea?

    Many thanks!

  26. iookpareke commented on Nov 27, 2024

    @iookpareke

    Add the following line <?m2e execute onConfiguration,onIncremental?> inside the build plugin.

    Example:

    <plugin>
                        <groupId>org.openapitools</groupId>
                        <artifactId>openapi-generator-maven-plugin</artifactId>
                        <version>${openapi-generator-maven-plugin.version}</version>
                        <?m2e execute onConfiguration,onIncremental?>
    

    Thanks a lot, This is the fix that worked for me. However it only worked for me in VS code by breaking up onConfiguration and onIncremental, like so...

     <plugin>
       		 <groupId>io.swagger.codegen.v3</groupId>
        		<artifactId>swagger-codegen-maven-plugin</artifactId>
       		<version>3.0.64</version>
    		<?m2e execute onConfiguration?>
    		<?m2e execute onIncremental?>
    ...
     <\plugin>
    
  27. quanle4489 commented on Jun 19, 2025

    @quanle4489

    The issue still exists on version 1.101, June 2025

  28. khalld commented on Sep 22, 2025

    @khalld

    We also had a similar problem, where generated sources by buf.build were not visible in VS Code, but it was fine when running mvn compile. Turns out we had pointed build-helper-maven-plugin one folder too shallow. Maven probably looks in the subdirectories as well, but VS Code does not. This has fixed it:

      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>build-helper-maven-plugin</artifactId>
        <version>3.3.0</version>
        <executions>
          <execution>
            <id>add-source-generated</id>
            <phase>generate-sources</phase>
            <goals>
              <goal>add-source</goal>
             </goals>
             <configuration>
               <sources>
    
    •            <source>${basedir}/target/generated-sources</source>
      
    •            <source>${basedir}/target/generated-sources/protobuf</source>
               </sources>
             </configuration>
           </execution>
      

    Worked also for me, many thanks

  29. SylvainAssemat commented on Oct 7, 2025

    @SylvainAssemat

    Hi

    I think i am in a same issue in my vscode 1.104.3 using Redis Om Spring library (1.0.4)

    VS Code show me a red underline on my import com.model.RDBadge$ cannot be resolved Java(268435846)

    If i click on this class, i move on the visible RDBadge$ class in target/generated-sources/annotations/com/model/RDBadge$

    Image Image

    Even if i use :

    <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>build-helper-maven-plugin</artifactId>
        <version>3.6.1</version>
        <executions>
            <execution>
                <id>add-generated-sources</id>
                <phase>generate-sources</phase> 
                <goals>
                    <goal>add-source</goal>
                </goals>
                <configuration>
                    <sources>
                        <source>${project.build.directory}/generated-sources/annotations</source>
                    </sources>
                </configuration>
            </execution>
        </executions>
    </plugin>
    
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions