Language Server Protocol implementation for Robot Framework
Project description
Language Server Protocol implementation for Robot Framework
Requirements
Python 3.7+ and Robot Framework 3.2+.
Note: if using the Robot Framework Selenium Library, version 4.4+ is required.
Installing
Robot Framework Language Server
can be installed from the VisualStudio Marketplace or as a .vsix
.
To get a .vsix
, download the latest Deploy - RobotFramework Language Server Extension
in Robotframework-lsp Github Actions.
See: Install from a vsix for details installing a .vsix
into VSCode.
See: Getting Started for a tutorial with some screenshots.
Configuration
After having Robot Framework Language Server
installed, some configurations (such as specifying
the python executable used for launching the Language Server or Robot Framework)
may be needed.
See: Config for details. See: FAQ for common issues encountered while configuring the language server.
Features (0.21.0)
- Scratchpad: a REPL for interactively experimenting with Robot Framework (for VSCode).
- Code analysis: checks if keywords are properly imported/defined.
- Linting with Robocop.
- Code completion for keywords, keyword parameters, section headers, section settings, variables, resource imports and library imports.
- Code completion for all keywords in the workspace with auto-import of Library or Resource.
- Casing of keywords from libraries used in code-completion can be configured.
- Go to definition for keywords, variables, resource imports and library imports.
- Symbols browser for keywords in workspace (activated through
Ctrl + T
). - Document symbols.
- Syntax highlighting (using
semanticTokens
). - Syntax validation.
- Signature Help (activated through
Ctrl + Shift + Space
). - Code Formatting (see: Editor Settings for details on how to toggle code formatting just for
robotframework
). - Hover.
- Code folding.
- Launch
.robot
files. - Debugger:
- Add line breakpoints in
.robot
or.py
files. - Evaluate keywords in debug console/hover/watch
- Pause at breakpoints to inspect the stack and see variables
- Breakpoint condition/hitCondition/logMessage
- Step in
- Step over
- Step return
- Continue
- Add line breakpoints in
See: Changelog for details.
Developing
See: Developing for details on how to develop Robot Framework Language Server
.
Reporting Issues
See: Reporting Issue for details on how to report some issue in the Robot Framework Language Server
.
License: Apache 2.0
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file robotframework-lsp-0.21.0.tar.gz
.
File metadata
- Download URL: robotframework-lsp-0.21.0.tar.gz
- Upload date:
- Size: 2.4 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.7.11
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0968578bebefd1e04b5f0e72784f39679102f8ed0e20610d77cd98507eb78b41 |
|
MD5 | c3453c579170b53a4e38da752dcf81f7 |
|
BLAKE2b-256 | 7d5615dc2bb6bbbc8cf597c9aa991ad89c5a5dbb8573774e81dc5ebfa0dbf6a4 |
File details
Details for the file robotframework_lsp-0.21.0-py2.py3-none-any.whl
.
File metadata
- Download URL: robotframework_lsp-0.21.0-py2.py3-none-any.whl
- Upload date:
- Size: 2.8 MB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.7.11
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 01f920284c68dcf26067b58ad4aad35ac711e71e3cc24c5f08017f41ca9ecf59 |
|
MD5 | 6ba73c27de88032a80bee98b0b2e87ef |
|
BLAKE2b-256 | 9c2624af1fc11fcb6a2122efa978b5fa8ec9470a833d710c82a027567e907bab |