Maven projects

Navigate to POM

1. In the Maven tool window, right-click a linked project.

2. From the context menu, select Jump to Source .

   IntelliJ IDEA navigates to the appropriate Maven configuration file, and the related POM opens in the editor.

Ignore a Maven project

You can deactivate a Maven project using the Ignore Projects option. In this case, IntelliJ IDEA keeps the ignored Maven projects and subprojects in the Maven tool window, but stops their import (modules, content roots, goals, and so on) to the project. However, IntelliJ IDEA synchronizes the ignored projects with the current one. It might be helpful when you work with a project that has multiple subprojects and need to skip irrelevant ones.

note

If you ignore a project on which the other subproject depends on, then the ignored project changes to a library. If such library is not found in the Maven repository, it will be colored in red. To add this library to a repository, in the Maven tool window, open the ignored project node and in the Lifecycle, run the install command.

1. In the Maven tool window, right-click the project that you want to ignore.

2. From the context menu, select Ignore Project.

   note

   Alternatively, you can use the Project tool window or the Project Structure dialog to remove a subproject to make it ignored.

3. In the window that opens, click Yes if you want to remove the project from the Projects tool window.

If you want to activate your Maven projects or subprojects, select Unignore Projects from the context menu.

Ignore POM of a linked project from the Maven settings

You can ignore a POM file using the Ignored Files settings.

1. In the Settings dialog () , go to Build, Execution, Deployment | Build Tools | Maven | Ignored Files.

2. On the Ignored Files page, select a POM you want to ignore and click OK to save the changes.

   

3. IntelliJ IDEA displays a dialog where you can either remove or leave the selected POM file in the Project tool window.

   

   If you keep the ignored file in the Project tool window, the POM will be displayed as ignored however you can still work with the file and modify it in the editor.

   

Reload a Maven project

Every time you manually change the pom.xml file in the editor, you need to load the changes. IntelliJ IDEA displays a notification icon in the right part of the editor suggesting to Load Maven Changes made to the project ().

If you want to control the importing process of your project, you can manually trigger the action.

note

IntelliJ IDEA does not resolve dependencies for the excluded POM files during the reload process.

1. In the Maven tool window, right-click a linked project.

2. From the context menu, select Reload project .

   On invoking this action, IntelliJ IDEA parses the project structure in the Maven tool window.

   IntelliJ IDEA cannot reload just a part of your project, it reloads the whole project including subprojects and dependencies.

   If you configure a dependency through the Project Structure dialog (), the dependency will only appear in the IntelliJ IDEA Project tool window, not in the Maven tool window. Note that the next time you reload your project, IntelliJ IDEA will remove the added dependency since IntelliJ IDEA considers the Maven configuration as a single source of truth.

tip

To reload all Maven projects, click on the toolbar, in the Maven tool window.

Configure the auto-reload

1. In the Settings dialog () , go to Build, Execution, Deployment | Build Tools.

   Alternatively, In the Maven tool window, click and select the Auto-Reload Settings option.

   

2. In the Build tools settings, specify the following options:

   

   • Reload changes in the build scripts: this option is selected by default. If you want to disable the auto-reload and manually control the reloading process, unselect this checkbox.

   • Any changes: select this option if you want to automatically reload the project after any changes you make to pom.xml or external changes.

     Every time you manually change the Maven build script in the editor, you need to load the changes. IntelliJ IDEA displays a notification icon in the right part of the editor suggesting to Load Maven Changes made to the project (). With the Any changes option, IntelliJ IDEA reloads all the changes automatically.

   • External changes: when you select this option, IntelliJ IDEA automatically reloads the project only after the VCS changes and changes made to the build files outside the IDE.

Add a Maven config file to a Maven project

If you want to add files such as maven.config or jvm.config, you can do so by creating an empty file in the project.

1. In the Project tool window, right-click a directory where you want to create a file.

2. In the context menu, select New | File.

3. In the dialog that opens, enter a name of the file (maven.config or jvm.config) and click OK.

   When you import your project, IntelliJ IDEA reads a content located in the maven.config file, but keep in mind that the content of the jvm.config is ignored.

   For more information about the Maven config files, refer to https://maven.apache.org/configure.html.