Skip to content

develop.md

Latest commit

 

History

History
111 lines (76 loc) · 4.38 KB

develop.md

File metadata and controls

111 lines (76 loc) · 4.38 KB

Developing

Install NodeJs (https://nodejs.org/en/) -- make sure that node and npm are in the PATH.

Install Yarn (https://yarnpkg.com/) -- make sure that yarn is in the PATH.

Download the sources, head to the root directory (where package.json is located) and run: yarn install.

After this step, it should be possible to open the robocorp_code folder in VSCode and launch Extension: Robocorp Code to have a new instance of VSCode with the loaded extension.

Building a VSIX locally

To build a VSIX, follow the steps in https://code.visualstudio.com/api/working-with-extensions/publishing-extension (if everything is setup, vsce package from the root directory should do it).

Adding a new command

To add a new command, add it at the COMMANDS in /robocorp-code/codegen/commands.py and then execute (in a shell in the /robocorp-code directory) python -m dev codegen.

This should add the command to the package.json as well as the files related to the constants.

Then, you may handle the command either in /robocorp-code/vscode-client/src/extension.ts if the command requires some VSCode-only API or in the language server (which is ideal as less work would be required when porting the extension to a different client).

Note: that it's also possible to have one command call another command, so, if needed the command could start on the client and then call parts of it on the server.

Note: the code in the extension side (in TypeScript) should be kept to a minimum (as it needs to be redone if porting to a different client).

Note: at least one integration test for each action must be added in /robocorp-code/tests/robocorp_code_tests/test_vscode_integration.py

Adding a new setting

To add a new setting, add it at the SETTINGS in /robocorp-code/codegen/settings.py and then execute (in a shell in the /robocorp-code directory) python -m dev codegen.

Creating a local environment for python development

For local development, it's interesting to run the Python code/tests directly. It's suggested that a virtual environment is created with the proper libraries and the PYTHONPATH is set accordingly.

To do that, in the command line, make sure you're at the root folder of this project: (say, something as: X:\vscode-robot\robotframework-lsp)

Then run the commands below (considering that you have a Python 3.8 in your path):

In Windows:

python -m venv .venv
.venv/Scripts/activate.bat
python -m pip install -r robocorp-code/tests/test_requirements.txt
python -m pip install -r robocorp-code/dev_requirements.txt
python -m pip install robotframework
python -m pip install robotremoteserver
echo %cd%\robotframework-ls\src > .venv\Lib\site-packages\rf_src.pth
echo %cd%\robocorp-code\src >> .venv\Lib\site-packages\rf_src.pth
echo %cd%\robocorp-python-ls-core\src >> .venv\Lib\site-packages\rf_src.pth
echo %cd%\robotframework-ls\tests >> .venv\Lib\site-packages\rf_src.pth
echo %cd%\robocorp-code\tests >> .venv\Lib\site-packages\rf_src.pth
echo %cd%\robocorp-python-ls-core\tests >> .venv\Lib\site-packages\rf_src.pth

In Linux:

python -m venv .venv
source ./.venv/bin/activate
python -m pip install -r robocorp-code/tests/test_requirements.txt
python -m pip install -r robocorp-code/dev_requirements.txt
python -m pip install robotframework
python -m pip install robotremoteserver
echo $PWD/robotframework-ls/src > .venv/lib/python3.8/site-packages/rf_src.pth
echo $PWD/robocorp-code/src >> .venv/lib/python3.8/site-packages/rf_src.pth
echo $PWD/robocorp-python-ls-core/src >> .venv/lib/python3.8/site-packages/rf_src.pth
echo $PWD/robotframework-ls/tests >> .venv/lib/python3.8/site-packages/rf_src.pth
echo $PWD/robocorp-code/tests >> .venv/lib/python3.8/site-packages/rf_src.pth
echo $PWD/robocorp-python-ls-core/tests >> .venv/lib/python3.8/site-packages/rf_src.pth

If everything went well, just pointing your IDE to use the python executable at .venv/Scripts/python should suffice.

-- in VSCode that'd be using the Python: Select Interpreter command.

Updating RCC

  • Open a shell at the proper place (something as X:\vscode-robot\robotframework-lsp\robocorp-code)

  • Update version (python -m dev set-rcc-version v11.14.5).

  • Remove the rcc executable from the bin folder to redownload the next time the extension is executed.