ms-iot/vscode-ros

Visual Studio Code extension for Robot Operating System (ROS) development

vscode-ros's Issues

[feature] add catkin_make_isolated task provider

Is this feature request related to a problem?
there is currently no support for workspaces built with (or needs to be built with) catkin_make_isolated

What kind of solution would be helpful?
add task provider for catkin_make_isolated build and test tasks

[feature] add yaml language support for .rosinstall and .repos files

Is this feature request related to a problem?
.rosinstall files are very specific to the ROS build system yet get very minimal YAML language support since .rosinstall is not a recognized extension for YAML.

What kind of solution would be helpful?
this extension could create association between the .rosinstall extension and the YAML language to utilize VS Code's built-in language support for YAML

[feature] Debugging and breakpoints support

Is this feature request related to a problem?
One of the most important features of an IDE is the debugging tools. A breakpoint and a stack trace would save few hours of writing print statements.

What kind of solution would be helpful?
Similar debugging functionality to any IDE. Clion is a good example, just press the bug button and it simply stops on breakpoints. Sometimes you have to do manual setup of input arguments to the node though!
It would be great to have support for roslaunch debugging too, however support for rosrun or directly invoking the node with the right arguments and environment variables should be good.

Incompatible Python environment could be auto-activated in ROS terminal

I have ms-python.python extension installed and it by default will automatically launch a Python environment for every terminal open in VSCode, and which results in unexpected behaviors. Any thought?

[bug] relative links in README.md does not work for VS market place page

what is the bug
relative links in https://marketplace.visualstudio.com/items?itemName=ms-iot.vscode-ros does not work, need to use absolute links

[feature] Add 'Catkin Ignore' and 'Colcon Ignore' menu options

Sometimes it is useful to ignore a folder during catkin build.

Add a menu option to say 'ignore in catkin build'.

[bug] roslaunch does not source devel\setup.bat on Windows

general information
Windows

describe the bug (actual behavior)
The roslaunch command is not looking at the devel environment when discovering launch files.

Fix in this branch
ooeygui@d0f3903

[feature] C++ Launch debug with the node process name

It would be nice to see the drop down with the process name, but not a generic c++: launch, so I know clearer which process I am debugging with now.

[build-pipeline] add tslint to CI

It would be nice to have tslint integrated with CI so contributors know what style issues to fix for their pull requests.

[bug] URDF preview sometimes doesn't load up the model

Repro Steps:

1. Active the vscode-ros extension.
2. Open a workspace which are built before by catkin_make\catkin_make_isolated.
3. Open up an xacro file in the editor.
4. Run URDF preview command.
5. Wait for URDF window open.

Expected:
I can see the robot model loaded and rendered in the preview window.

Actual:
Only the window and the grid shows up but no robot model is rendered there.

Workaround:
Close the window and run URDF preview command again.

[feature] When clicking on ROS status icon on the taskbar, it should bring the focus to any existing ROS status tab.

I think it is a nice-to-have enhancement to bring the focus to any existing ROS Status tab, instead of keeping creating the new ones.

[bug] cpp intellisense not working

general information
Windows
0.4.5

describe the bug (actual behavior)
intellisense not working due to import error

additional context
path like c:\opt\rosdeps\include needs to be added so that dependencies can be looked up

[feature] support language-specific debug options for launch-debug

VS Code's Python and C++ debugging extensions use different flags. Since vscode-ros propagates its debug request to these extensions, it'd be a good idea to allow adding language-specific flags in ros-type debug configurations.

[bug] Handle case when a xacro has a .urdf extension

describe the bug (actual behavior)
I have a standard xacro file to create an URDF (that unfortunately cannot be shared here).
It contains meshes on the .stl format for visuals, and some gazebo tags.

Running ROS: Preview URDF show a partial model.
Running xacro manually, and previewing the resulting URDF displays correctly.

expected behavior
The full model should be rendered.

screenshots
Rendering the xacro file :

Rendering the resulting URDF after manual conversion :

ROS status seems not to be updated when a roslaunch is running

I tried to roslaunch a project and after it is running, I saw ROS stauts stop updating. What to check?

[bug] Could not source the workspace space setup file.

general information
<Ubuntu 16.04, ROS Kinetic>
<Version of the VS Code 1.34.0>
<Version of the plugin: 0.4.2>

describe the bug (actual behavior)
When I start VS Code I get message: Could not source the workspace space setup file. Not sure if this is a bug, but I have no idea how to solve it.

steps to reproduce

1. source system and local ros enviroment in bash
2. run code in the same bash window

expected behavior
No warning/error should be seen.

screenshots

additional context
<any additional information could go here>

No Issues template for ms-iot/vscode-ros

could copy from the issue template from the ROSOnWindows project

[bug] undefined is propagated to rosrun when you cancel the operation.

general information
0.4.4 from CI build.

steps to reproduce

1. Ctrl+P to open the command menu.
2. Type >ROS: and select the entry for rosrun
3. Select a package.
4. Select a executable.
5. Press ESC multiple times until the operation is canceled.

expected behavior
Don't run anything, but it runs the rosrun with undefined in the arguments instead.

Email notifications not turned on for iot-robotics team

[bug] ROS Core monitor has illegible UI

general information
Windows 10
0.4.5

describe the bug (actual behavior)

1. hard to read the title bar
2. and when there are multiple nodes for 1 topic, hard to read other nodes than the first one

steps to reproduce
open ROS Core monitor with ROS: Show Core Status

additional context
the info in the monitor might be better formatted

[feature] Support 'skipping files' C++ debugging feature

what is needed
Allow debugger skipping certain header files

why is it needed
"skipFiles" is not support under ros: launch configuration. I tried to put "skipFiles" in a ros: launch configuration in launch.json file, however I was told it is not supported.

I want to skip boost, and c++ bits, so something like below
"/usr/include/boost/*.hpp", "/usr/include/gtest/*.h", "/usr/include/eigen3/Eigen/*.h", "/usr/include/c++/5/bits/*.h", "/usr/include/c++/5.4.0/bits/*.h"

[bug] 'esc' out of a ROS: roslaunch attempts to launch ros with undefined

Repro
In a workspace with a launch file, execute ros: roslaunch.
Select a package
Press esc

Result
RLException: [undefined] is neither a launch file in package [undefined] nor is [undefined] a launch file name The traceback for the exception was written to the log file

[feature] More concise error messages for ROS launch debug when node doesn't exist

If I try to launch debug but the node doesn't exist, it throws the below error message:

Can it be more readable and concise?

Enhancement: Add documentation about debugging ROS Nodes

It would be good if we created documentation about building nodes in a way that allows a debugger to be attached, as well as documentation about how to attach a debugger.

Some things to consider:

• Documentation about adding a wait for debugger to the node source. quick summary is:
  • add #include "windows.h" to the node source code
  • add the following lines right at the start of the main() routine:

    while (!IsDebuggerPresent())
    Sleep(100);
    

• Documentation about starting the node, and then how to Attach VS to it:
  • rebuilding node with catkin_make
  • info on setting breakpoints in VS
  • info and screenshots of attaching VS to a running process (such as ensuring native debugging is selected)

[bug] ROS command fails to run when you use them before the extension is ready.

If you run the command too soon right after vscode starts up, you will see errors, but it goes away after the extension is fully loaded.

No GitHub Pages for ms-iot/vscode-ros

[bug] F5 for rosrun and roslaunch not working on Windows

general information
Windows

describe the bug (actual behavior)
rosrun and roslaunch defined in launch.json does not work on Windows

additional context
update README.md when this issue is resolved

[feature] ROS Launch Debugger & substituteVariables Support

In vscode, there is a AbstractVariableResolverService to help dynamically generate launch\attach request at runtime by using abstract variables. For example, ${file} is replaced by the active open file path. This ability enables that developers can define a generic ROS launch task and simply go to the editor to open roslaunch file and press F5 to debug.

BTW, currently we hooked our logic on the resolveDebugConfiguration and the code path didn't get a chance to run AbstractVariableResolverService for the variables resolving.

https://github.com/microsoft/vscode/blob/4c45266943228286126e1ad9f840851a0cde594d/src/vs/workbench/contrib/debug/browser/debugService.ts#L369

[feature] bootstrap an empty workspace from .rosinstall file

It would be great to enable the follow workflow:

1. Open command prompt.
2. Source toolchain & ROS environment when needed.
3. Create a directory for our workspace to bootstrap & change directory there.
4. Run vscode.
5. Add an abc.rosinstall with repositories to checkout.
6. Magic happens!
7. Now you have everything clone locally and you can do ctrl+shift+b to build this workspace.

[bug] Unable to automatically create launch.json when add ROS debug configurations

When no launch.json under .vscode for the active workspace and developers try to add a ROS debug configuration, the vscode shows a error message:

Unable to create 'launch.json' file inside the '.vscode' folder (nothing returned from DebugConfigurationProvider.provideDebugConfigurations).

Other debug configurations (for example, cpptools) will generate launch.json silently instead.

[bug] ROS environment does not get updated after setup.bat gets changed

general information
Windows 10
0.5.0

describe the bug (actual behavior)
after workspace gets rebuild, the ROS environment sourced in the extension does not get updated

steps to reproduce
open workspace
build a new project

expected behavior
ROS environment should get updated whenever setup.bat is changed

additional context
listener should be added to file handler for setup file

[feature] A method to provision what build tool to use for the first time

In current ROS extension user manual, it states this requirement:

You must build the catkin workspace at least once before the extension will recognise it.

We should have a way to manually provision what build tool to use for a empty (or not yet compiled) project, which I believe a better first-time user experience.

[bug] Catkin build tasks not working

general information
Ubuntu 18.04; using catkin tools, vscode 1.37.1.

what is the bug
When running Configure Default Build Task and then selecting catkin: make, a new entry is added to tasks.json:

{
    "type": "catkin",
    "problemMatcher": [
        "$catkin-gcc"
    ],
    "group": {
        "kind": "build",
        "isDefault": true
    }
}

For the type, vscode complains about "Value is not accepted". For "problemMatcher: "Incorrect type. Expected object".

expected behavior
The creation of a valid and working catkin build task

Roslaunch files not found when build with catkin_make

Setup a catkin workspace
Create a package test_package which contains a launch file in a launch directory.

From the terminal, build:

catkin_make
devel\setup.bat

attempt to use a roslaunch file with vscode

Result:

Command failed: where /r "C:\ws\test_ws\devel\share\test_package" *.launch
INFO: Could not find files for the given pattern(s).

add documentation for commands

add markdown for commands with screenshot/gif

[bug] ros:roslaunch then press escape, shows bad error

Repro
Open the command pallet - Ctrl/Shift P
select ROS: roslaunch
Press escape

Result

error message

[feature] if there's only one distro installed, select it

It isn't necessary to ask the user to configure a distro if only one is installed.

Ros python debugger gives timeout

general information
Ubuntu: 18.04
Plugin v: 0.6.0

what is the bug
The python ROS debugger keeps giving me the following timeout error after 1 min of inactivity while debugging:

Exception in thread ptvsd.Server:
Traceback (most recent call last):
  File "/home/ricks/miniconda3/envs/py2_auto_grasp/lib/python2.7/threading.py", line 801, in __bootstrap_inner
    self.run()
  File "/home/ricks/miniconda3/envs/py2_auto_grasp/lib/python2.7/threading.py", line 754, in run
    self.__target(*self.__args, **self.__kwargs)
  File "/home/ricks/miniconda3/envs/py2_auto_grasp/lib/python2.7/site-packages/ptvsd/wrapper.py", line 536, in process_messages
    raise exc
timeout: timed out

expected behavior
No timeout.

Geeting invalid macro error after generating cmake cache in visual studio

Describe the bug
E0992 command-line error: invalid macro definition: =

To Reproduce
Steps to reproduce the behavior:
Open the workspace and generate cmake cache

Expected behavior
Getting intellisense and works fine

Environment information:

• OS version: win10 1903
• Chocolatey Versions: choco list --local-only

[feature] add 'previewURDF' context menu option

What kind of solution would be helpful?
enable right click on a .urdf/.xacro file and bring up the option to load preview for the file

[bug] ros.updateCppProperties not working on Windows

general information
Windows
0.4.3

describe the bug (actual behavior)
ros.updateCppProperties does not add any local include path

expected behavior
local include paths get added to includeDir

additional context
packagePath for local packages and extension.baseDir had different path separator (/ and \), causing string comparison mismatch.

    // Get all packages within the workspace that have an include directory
    const filteredPackages = await utils.getPackages().then((packages: { [name: string]: string }) => {
        return Object.values(packages).filter((packagePath: string) => {
            return packagePath.startsWith(extension.baseDir);
        });
    });

possible fix:

1. standardize packages' paths before comparison
2. source packages' paths while processing local workspace (this might be better)

[bug] Cannot find launch files in a devel environment

general information
Windows

describe the bug (actual behavior)
When sourcing a development environment, the roslaunch handler cannot find launch files.

Fixed in this fork
ooeygui@762fd9e

master.showMasterStatus does not work with the latest vscode

master.showMasterStatus depends on vscode.previewHtml which is deprecated (completely removed) in the latest vscode, this needs to be reimplemented with the webview APIs

[feature] add docs how to install this addon from source?

I am new in VS Code and trying to set up the ROS plugin. As far as I see there are multiple ways.

First, I can install an old extension through Extension Marketplace from ajshort, but this project is not actively developed any more. I am not managing to build my packages...

Second, apperantly I could install from VSIX - link. I searched for *.vsix here, but I did not found any suitable file. Is this repository and *.vsix have some intersection or there is another way how I could install this extension?

Best, Andrej

[bug] not able to identify telemetry data sent from source build and production release

describe the bug (actual behavior)
The one and only aiKey is defined in package.json, so all GitHub source builds and production releases in marketplace will use the same one.

This could lead to unexpected extra data sent out from development scenarios.

[feature] Support zsh and zsh support wanted

ros.cerateTerminal auto source environment functions not properly in zsh shell. I think its still not supported to tell using the devel/setup.bash or devel/setup.zsh.
As I like both zsh and vscode-ros very much, I am pleased to hear that vscode-ros supports zsh ~~ I think there are many people agreeing with me.

[feature] vscode-ros should use vscode-cpptools api for C++ language configuration

Is this feature request related to a problem?
by using apis from vscode-cpptools, instead of hard-coding c_cpp_properties.json, this reduces possible mistakes during C++ language environment configuration

[feature] vscode-ros not sourcing workspace

General information
OS version, Ubuntu? Windows: Ubuntu 18.04
Visual studio code version: 1.38.0-insider
Version of the plugin: 0.5.0
python environment: miniconda3 (py2.7)

what is the bug

When I try to use the rosrun debug function (F5 after roscore is started) nothing happens. Further when trying to debug the workspace devel/setup.bash is not sourced before debugging the python node. As a result, I can not import modules from other rospackages.

expected behaviour

Having the ability to debug the rosnode on ubuntu 18.04. Further I also expected the Plugin to source the devel/setup.bash file before starting the debugger.

Aditional info

I think this might be caused by the fact that I'm working in a conda environment since also when trying to run a rosnode using the ROS: Run a ROS executable (rosrun) I get the [rospack] Error: package 'panda_autograsp' not found error.

What I already tried
I tried setting "python.terminal.activateEnvironment": false in the settings.json. But now although the conda environment is not sourced the ROS application opens a new terminal every time when I try the ROS: Run a ROS executable (rosrun) command. As a result the sourced $PYTHONPATH is removed. This setting did, fortunately, enable me to debug my ROS nodes but not through the vs-code-ros extension.

[bug] The task [catkin_make, build] uses an undefined task type

When using build tasks, I will see the following errors from debug output:

The task [catkin_make, build] uses an undefined task type. The task will be ignored in the future.
extensionHostProcess.js:712
The task [catkin_make, run_tests] uses an undefined task type. The task will be ignored in the future.
extensionHostProcess.js:712
The task [catkin_make_isolated, build] uses an undefined task type. The task will be ignored in the future.
extensionHostProcess.js:712
The task [catkin_make_isolated, run_tests] uses an undefined task type. The task will be ignored in the future.

roslaunch needs to recall last successful command

When using roslaunch from vscode, you typically are launching the same file over and over. It should remember that and offer it as the first option.