Create a simple ROS1 workspace and package

Oct 13, 2025 by magicalceylontours.com 8 views

[bug] launch.json postDebugTask does not work

The ROS extension for Visual Studio Code (VS Code) is a powerful tool for developing and debugging ROS (Robot Operating System) applications. However, a bug has been identified in the extension that prevents the postDebugTask option from working in the launch.json file. This article provides a detailed explanation of the issue, including the repro steps, expected behavior, and additional context.

What is the Bug?

The postDebugTask option in the launch.json file does not work as expected. This option is used to specify a task that should be executed after the debug session has been terminated. In this case, the task is set to rosnode cleanup, which is a ROS command that cleans up all nodes in the ROS environment.

Repro Steps

To reproduce the issue, follow these steps:

Create a simple ROS1 workspace and package: Create a new ROS1 workspace and package using the roscreate-pkg command. For example:

roscreate-pkg my_package

Add a task in task.json and add postDebugTask option in launch.json file: Create a new task in the task.json file that runs the rosnode cleanup command. For example:

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "rosnode cleanup",
      "type": "shell",
      "command": "source /opt/ros/noetic/setup.zsh && yes | rosnode cleanup",
      "presentation": {
        "reveal": "always",
      }
    }
  ]
}

Add the postDebugTask option to the launch.json file, pointing to the rosnode cleanup task. For example:

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "ROS: Launch my_project",
      "type": "ros",
      "request": "launch",
      "target": "${workspaceFolder}/src/xxxx/launch/test.launch",
      "preLaunchTask": "catkin_make: build debug",
      "postDebugTask": "rosnode cleanup", // << it does not work
    },
  ],
}

Using ROS extension to debug launch file: Open the launch.json file in VS Code and click on the "Debug" button to start the debug session.
Stop debug: Stop the debug session by clicking on the "Stop" button.

Expected Behavior

When the debug session is terminated, the postDebugTask option should execute the rosnode cleanup task, cleaning up all nodes in the ROS environment. However, in this case, the task does not execute, and the nodes remain running.

Additional Context

This issue has been reported on the VS Code ROS extension GitHub repository, and it is currently being investigated by the extension developers.

System Information

The following system information is relevant to this issue:

Windows: Windows 11 Professional 23H2
Linux: WSL 2.0 Ubuntu 20.04
ROS 1: Noetic
VS Code: 1.91.1 (system setup)
Commit: f1e16e1e6214d7c44d078b1f0607b2388f29d729
Date: 2024-07-09T22:06:49.809Z
Electron: 29.4.0
ElectronBuildId: 9728852
Chromium: 122.0.6261.156
Node.js: 20.9.0
V8: 12.2.281.27-electron.0
OS: Windows_NT x64 10.0.22635

In conclusion, the postDebugTask option in the launch.json file does not work as expected, preventing the execution of the rosnode cleanup task after the debug session has been terminated. This issue has been reported on the VS Code ROS extension GitHub repository, and it is currently being investigated by the extension developers.
Q&A: [bug] launch.json postDebugTask does not work

Q: What is the issue with the postDebugTask option in launch.json?

A: The postDebugTask option in the launch.json file does not work as expected, preventing the execution of the specified task after the debug session has been terminated.

Q: What is the expected behavior of the postDebugTask option?

A: The postDebugTask option is expected to execute the specified task after the debug session has been terminated. In this case, the task is set to rosnode cleanup, which is a ROS command that cleans up all nodes in the ROS environment.

Q: Why is the postDebugTask option not working?

A: The exact reason for the issue is currently under investigation by the VS Code ROS extension developers. However, it is believed to be related to a bug in the extension.

Q: How can I reproduce the issue?

A: To reproduce the issue, follow these steps:

Create a simple ROS1 workspace and package using the roscreate-pkg command.
Add a task in the task.json file that runs the rosnode cleanup command.
Add the postDebugTask option to the launch.json file, pointing to the rosnode cleanup task.
Open the launch.json file in VS Code and click on the "Debug" button to start the debug session.
Stop the debug session by clicking on the "Stop" button.

Q: What are the system requirements for this issue?

A: The following system information is relevant to this issue:

Windows: Windows 11 Professional 23H2
Linux: WSL 2.0 Ubuntu 20.04
ROS 1: Noetic
VS Code: 1.91.1 (system setup)
Commit: f1e16e1e6214d7c44d078b1f0607b2388f29d729
Date: 2024-07-09T22:06:49.809Z
Electron: 29.4.0
ElectronBuildId: 9728852
Chromium: 122.0.6261.156
Node.js: 20.9.0
V8: 12.2.281.27-electron.0
OS: Windows_NT x64 10.0.22635

Q: Is there a workaround for this issue?

A: Yes, there is a workaround for this issue. You can use the debugpy configuration instead of the ros configuration in the launch.json file. The debugpy configuration is known to work correctly with the postDebugTask option.

Q: How can I report this issue?

A: You can report this issue on the VS Code ROS extension GitHub repository. Please provide as much detail as possible, including the steps to reproduce the issue and any relevant system information.

Q: Is this issue fixed in the latest version of the VS Code ROS extension?

A: No, this issue is not fixed in the latest version of the VS Code ROS extension. However, the developers are actively working on a fix and it is expected to be released in a future update.