Guides for SE student projects »

VS Code - Importing a Gradle project

This guide will help you import and work with existing Gradle projects in VS Code.

If you are new to working with Gradle in VS Code, we recommend watching the video below for an introduction to the features of VS Code Gradle extension.

To recall how to use a specific feature, you can refer to the sections below.

Prerequisites

The Extension Pack for Java includes the Gradle for Java extension, which provides Gradle support in VS Code.

Importing an existing Gradle project

Step 1: Open the project folder

1. Open VS Code
2. Select File → Open Folder...
3. Navigate to your existing Gradle project folder
4. Click "Select Folder" to open it as a workspace

Step 2: Let VS Code detect the project

1. VS Code will automatically detect the Java and Gradle files and set up the workspace
2. Wait for the Java Language Server and Gradle Build Server to initialize (progress shown in status bar)
3. Check the status bar at the bottom for any initialization messages

Step 3: Configure your JDK

You may also need to verify and configure the Gradle Build Server to use the correct JVM.

1. Open the project's .vscode/settings.json file. Create the file if it does not exists yet.
   • To configure the following settings globally, open VS Code's settings.json file instead. You can find it by opening the Command Palette (/ Ctrl+Shift+P | Cmd+Shift+P), then typing Preferences: Open User Settings (JSON).
2. Add or modify the following settings to configure the JVM for Gradle. Here's an example for Mac (Replace the JDK name and path as necessary):
   settings.json

   {
     "java.configuration.runtimes": [
       {
         "name": "JavaSE-17",
         "path": "/Library/Java/JavaVirtualMachines/zulu-17.jdk/Contents/Home"
       }
     ],
     "java.import.gradle.java.home": "/Library/Java/JavaVirtualMachines/zulu-11.jdk/Contents/Home"
   }
   
       
   
       Copy
       
   
       
   
   
       
       
       

Step 4: Verify project configuration

Confirm you can access the Gradle tool window. After the importing of the project is complete (which could take a few minutes), you will see the Gradle Tab in the VS Code interface (Look for the elephant icon on the left and click it).

Gradle Tasks

You can access useful Gradle views from the Gradle side bar. The Gradle Projects view lists all detected Gradle projects in your workspace, allowing you to view, run, or debug any Gradle task.

If your workspace contains many Gradle tasks, you can pin tasks to easily find your frequently used tasks. You can also check the Recent Tasks view to quickly find and rerun tasks you've recently executed.

Testing

You can run your tests using Gradle directly from VS Code. In the Testing Explorer, you can select which test profile to use and configure tests to be executed through Gradle.

Editing build files

The Gradle extension provides useful features for editing your Gradle build files in VS Code.

Syntax Highlighting

The Gradle extension analyzes the opened Gradle file and provides enhanced syntax highlighting.

Outline view

The Outline view displays document symbols for the opened Gradle file, making it easy to navigate to different sections.

Problems view

The Problems view shows any syntax errors in the opened Gradle file for quick troubleshooting.

Autocompletion

The Gradle extension supports basic autocompletion.

As you type Gradle closures or properties, the extension will suggest available options.

When adding a new dependency, the Gradle extension provides a list of suggested dependencies to choose from.

---

Contributors: Rui Shan (@ruishanteo), John Wong (@Johnwz123)