redhat-developer / redhat-developer/vscode-java

[Question] What does actually happen when a project (with a pom.xml) is built?

Open
#1,354 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Maven question
Dominant language
TypeScript
Stars
2.3k
Forks
546
Avg merge
20h 1m
Merged PRs (30d)
11

Description

I have some difficulties understanding what really happens when the Java Language Server starts upon opening my project on VS Code and when I save a modified .java file afterward.

My question concerns specifically the building of the project, and I'm asking it because I've witnessed behavior that I couldn't quite explain.

My project is a Maven project and thus, has a pom.xml file. In this file, I use some plugins in the <build> node that do some heavy work (in my case, installing npm dependencies for my frontend and building it).

<!-- An excerpt of my pom.xml file -->
<?xml version="1.0" encoding="UTF-8" ?>
<project /* ... */>
  <build>
    /* ... */
    <plugins>
      <plugin>
        <groupId>com.github.eirslett</groupId>
        <artifactId>frontend-maven-plugin</artifactId>
        <version>1.9.1</version>
        <executions>
          <execution>
            /* install nodejs and npm */
          </execution>
          <execution>
            /* npm ci */
          </execution>
          <execution>
            /* npm run build */
          </execution>
        </executions>
      </plugin>
      /* other plugins */
    </plugins>
  /* ... */
  </build>
</project>

When I open the project with VS Code, the Java Language Server starts and eventually builds the project. This build phase takes a hefty amount of time to complete but envetually does so. After that, each time I save a .java file, the Java Language Server hops in and starts building the project again (as it is somewhat expected). This build also takes a huge amount of time before completing.

When commenting the <plugin> node in my `pom.xml that do the heavy work, the building of the project runs incredibly faster.

Of this, I've come to the conclusion that the Java Language Server detects that I'm using a Maven project thanks to the presence of the pom.xml file and delegates the building of the project to M2Eclipse which, in turn, does something like mvn compile, meaning that each build will execute all the goals registered on the <build> node.

Am I right in this assertion? And if so, would there be any way to compile the project as a "simple" Java Application (something like IntelliJ's Application configuration)?

I know that I could use Maven profiles to scope the execution of those plugins' goals, and prevent their execution when developping but I'd like to be sure to understand what is happening under the hood.

Environment
  • Operating System: WSL
  • JDK version: 11
  • Visual Studio Code version: 1.43.2
  • Java extension version: 0.59.0

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Trace how the Java Language Server handles a Maven project with a pom.xml, including whether M2Eclipse invokes the configured plugin executions during startup and Java-file saves. Document the observed build flow and whether a simple Java compilation mode is supported, using the issue's Maven plugin example as the expected scenario.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, vscode
Domain
build-system, developer-experience
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.