robotcodedev / robotcode

RobotFramework support for Visual Studio Code
https://robotcode.io
Apache License 2.0
182 stars 15 forks source link

[ENHANCEMENT] Add documentation describing that/why the extension opens a port #156

Open knaapjvd opened 1 year ago

knaapjvd commented 1 year ago

Is your enhancement request related to a problem? Please describe. Vscode notifies the user at startup that an extension has opened a port. In the absence of a description of which extension that was and why, the user is left puzzled at what is going on and what it implies in a high security environment.

This is not much of puzzle if only one extension was just installed. However, when multiple extensions are added, the user does not know which extension has opened the port. The documentation of this extension does not mention a port being opened.

Describe the solution you'd like Documentation could mention that the extension opens a port (default: 3100) and why.

Additional context The extension's author has offered ample descriptive text on Slack, reading (paraphrased):

This port is for the documentation server. It supports a feature of RobotCode: right mouse click on a keyword or the name of a library or resource import, then Source Action..., then Open Documentation, then the standard Robot Framework documentation opens, for this library/resource/keyword as generated by the libdoc tool. The result files (log.html, report.html) are also displayed via this port. The internal small web server is necessary, because otherwise it is not possible to display these files/documentation reasonably in VSCode, furthermore it also works when VSCode is running over a remote connection or in CodeSpace. The server runs only on localhost(127.0.01) and cannot be accessed from outside the machine it is running on.