Gradle for Java installs statistics

Gradle for Java

This VS Code extension provides a visual interface for your Gradle build. You can use this interface to view Gradle Tasks and Project dependencies, or run Gradle Tasks as VS Code Task. The extension also offers better Gradle file (e.g. build.gradle) authoring experience including syntax highlighting, error reporting and auto completion. The extension works nicely alongside other Java extensions in the Extension Pack for Java.

Requirements

• VS Code >= 1.76.0
• Java from 8 to 21

Project Discovery

This extension supports both root and nested Gradle projects. A Gradle project is identified by having Gradle Wrapper scripts (gradlew or gradlew.bat) or Gradle build files (build.gradle or settings.gradle and their Kotlin versions) at the root of a directory. (Nested Gradle project discovery is not enabled by default, set "gradle.nestedProjects": true to enable it.)

Feature Overview

Once the extension is activated you will see a new Gradle icon in the activity bar. Clicking on this icon will reveal some tree views in the sidebar.

Protip: you can move drag & drop any of these tree views into the main explorer view for easier access. This is especially useful for pinned tasks.

You can also run any Gradle task as a VS Code task. Access the Gradle VS Code tasks by running Run Task from the command palette.

<details><summary>List projects and tasks</summary>

A Gradle build can have one or more projects. Projects are listed in a flat list with the root project listed first, and sub-projects listed alphabetically thereafter.

When you expand a project, tasks are listed in a tree, grouped by the task group. You can toggle the display of the tasks by clicking on the Show Flat List/Show Tree button in the tree view header.

<img src="https://github.com/microsoft/vscode-gradle/raw/HEAD/images/gradle-tasks-view.png" width="350" alt="Gradle Tasks View" /> </details> <details><summary>List project dependencies</summary>

The project's dependencies are included in the Dependencies item under the project. The dependencies are grouped by Gradle configurations and you can expand each configuration to find the corresponding ones. For omitted dependency (marked with a (*)), you can use the inline button Go to Omitted Dependency to go to the previously listed dependency.

<img src="https://github.com/microsoft/vscode-gradle/raw/HEAD/images/dependencies.png" width="650" alt="Gradle Dependencies" /> </details> <details><summary>Run tasks</summary>

Tasks can be run via:

• Gradle Projects or Recent Tasks tree views
• Run Task command
• Run a Gradle Build command

A running task will be shown with an animated "spinner" icon in the tree views, along with Cancel Task & Restart Task buttons. The Cancel Task button will gracefully cancel the task. The Restart Task button will first cancel the task, then restart it.

<img src="https://github.com/microsoft/vscode-gradle/raw/HEAD/images/task-run.png" width="350" alt="Gradle Tasks Running" />

A task will be run in a vscode terminal where you can view the task output.

Send a SIGINT signal (ctrl/cmd + c) in the terminal to gracefully cancel it.

<img src="https://github.com/microsoft/vscode-gradle/raw/HEAD/images/task-output.png" width="650" alt="Gradle Tasks Output" />

Tasks run via the Run a Gradle Build command are not reflected in any of the tree views. Use this command to specify your own Gradle build arguments, for example to run multiple tasks or to exclude tasks.

<img src="https://github.com/microsoft/vscode-gradle/raw/HEAD/images/run-build.png" width="650" alt="Run Gradle Build" /> </details> <details><summary>Control task terminal behaviour</summary>

---

Use one terminal for each task type (default):

"gradle.reuseTerminals": "task"

<img src="https://github.com/microsoft/vscode-gradle/raw/HEAD/images/reuse-terminals-task.gif" />

---

Use one terminal for all tasks:

"gradle.reuseTerminals": "all"

<img src="https://github.com/microsoft/vscode-gradle/raw/HEAD/images/reuse-terminals-all.gif" />

---

Don't re-use terminals for any tasks. A new terminal will be created for each task run:

"gradle.reuseTerminals": "off"

<img src="https://github.com/microsoft/vscode-gradle/raw/HEAD/images/reuse-terminals-off.gif" /> </details> <details><summary>Debug tasks</summary>

This extension provides an experimental feature to debug JavaExec and Test tasks. Before using this feature you need to install the Debugger for Java and Language Support for Java extensions.

You might need to specify whether you want to clean output cache before debugging, to ensure Gradle doesn't skip any tasks due to output caching (this is most useful when debugging tests).…