Gradle projects

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

2. From the context menu, select Open Gradle config F4.

   IntelliJ IDEA navigates to the appropriate Gradle configuration file and the related build.gradle file opens in the editor.

1. Open build.gradle of the parent project.

2. Use the CtrlClick shortcut to navigate to a subproject.

   

   Gif

   You can also see the usages of a subprojects with AltF7 and check the results in the Find tool window.

   

When you unlink a Gradle project, IntelliJ IDEA removes all relevant modules and content roots, removes the Gradle project from the Gradle tool window and stops its synchronization. It might be helpful if you need to fully remove the previously linked Gradle project from the current IntelliJ IDEA project.

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

2. From the context menu, select Unlink Gradle project (Delete). Alternatively, you can select the linked project and click on the tool window's toolbar.

3. In the Import Gradle Projects popup, clear the checkbox against the modules if you don't want to delete the project from the IntelliJ IDEA Project tool window.

4. Click OK.

   If you need to link back the project, in the Project tool window, right-click the project's build.gradle file or build.gradle.kts if it is a Kotlin project, and select Import Gradle Project.

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

2. From the context menu, select Ignore Gradle Project.

3. In the window that opens, select projects and modules that you want to deactivate and click OK.

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

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

2. From the context menu, select Sync Gradle Project .

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

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

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

3. Click on the status bar to view the results of the sync in the Build tool window.

   tip

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

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

   Alternatively, In the Gradle tool window, click and select the Auto-Sync Settings option.

   

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

   

   • Sync project after changes in the build scripts: this option is selected by default. If you want to disable the auto-sync and manually control the synchronization process, unselect this checkbox.

   • Any changes: select this option if you want to automatically synchronize the project after any changes you make to build.gradle or external changes.

     Every time you manually change the Gradle build script in the editor, you need to sync the changes. IntelliJ IDEA displays a notification icon in the right part of the editor suggesting to Sync Gradle Changes made to the project (CtrlShift0O).

     With the Any changes option, IntelliJ IDEA synchronizes all the changes automatically.

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

1. Open the settings.gradle file in the editor.

2. Using the includeBuild command, specify the location of the builds you want to add as dependencies to your project.

1. Open a Gradle project.

2. Link other Gradle projects that you want to use for the composite build.

3. In the Gradle tool window, right-click your main project and from the context menu select Composite Build Configuration.

4. In the Gradle Project Build Composite dialog, select projects that you want to include in your Gradle composite build.

5. Re-import your main Gradle project.

   IntelliJ IDEA finds the included Gradle projects and treats them as IntelliJ IDEA modules.

1. Open the build.gradle file.

2. Add the following plugin to support package prefixes:

   plugins {
       id "org.jetbrains.gradle.plugin.idea-ext" version "0.5"
   }

3. Add the package prefixes. For example, you have the following set of source sets:

   sourceSets {
       main.java.srcDirs = []
       main.java.srcDirs += "src"
       main.java.srcDirs += "src/main/java"
       main.java.srcDirs += "../other-root/src/main/java"
   }

   Add the package prefixes (in our case it is "org.example") to them with the following code:

   idea {
       module {
           settings {
               packagePrefix["src"] = "org.example"
               packagePrefix["src/main/java"] = "org.example"
               packagePrefix["../other-root/src/main/java"] = "org.example"
           }
       }
   }

4. Reimport your changes or use the auto-import.

1. Open the build.gradle file.

2. Add the following plugin to support the encodings configuration:

   plugins {
       id "org.jetbrains.gradle.plugin.idea-ext" version "0.5"
   }

3. Describe the project encodings with the following code:

   import org.jetbrains.gradle.ext.EncodingConfiguration.BomPolicy
   
   idea {
       project {
           settings {
               encodings {
                   encoding = 'windows-1251'
                   bomPolicy = BomPolicy.WITH_NO_BOM
                   properties {
                       encoding = '<System Default>'
                       transparentNativeToAsciiConversion = false
                   }
                   mapping['../sample-gradle-free/module'] = 'windows-1251'
                   mapping['module'] = 'windows-1251'
                   mapping['module2/src/main/java'] = 'windows-1251'
               }
           }
       }
   }

   note

   <System Default> is a string constant indicating that system default encoding settings will be used.

4. Reimport your changes or use the auto-import.

1. If you don't have and existing buildSrc, add it as a Gradle module to your main project.

   

2. Open your main build.gradle file in the editor and move the classes you need to the main subdirectory of the buildSrc directory.

   

3. Run your task from your project's build.gradle file.

   

tip

You can use the Rename ShiftF6 refactoring if you need to change the name of a class to which you refer in the Gradle script. IntelliJ IDEA applies changes to all the references.

note

If you use the annotationProcessors in your project, we recommend that you delegate run and build actions to Gradle, so the annotation processor will be correctly enabled in your project.

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

2. On the Gradle settings page, in the Gradle Projects section, select a Gradle project you need.

3. In the Build and run using list, select the appropriate option and click OK to save the changes.