Skip to main content

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.40.0)

  • Test Explorer support in VSCode.
  • Interactive Console: 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.
  • Highlight of keywords/variables.
  • 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
    • Break on log error/failure
    • 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

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

robotframework-lsp-0.40.0.tar.gz (2.6 MB view details)

Uploaded Source

Built Distribution

robotframework_lsp-0.40.0-py2.py3-none-any.whl (3.1 MB view details)

Uploaded Python 2 Python 3

File details

Details for the file robotframework-lsp-0.40.0.tar.gz.

File metadata

  • Download URL: robotframework-lsp-0.40.0.tar.gz
  • Upload date:
  • Size: 2.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.0 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.7.12

File hashes

Hashes for robotframework-lsp-0.40.0.tar.gz
Algorithm Hash digest
SHA256 959eb2a00796e28dadbeb532d3a5ef9c0a3a34a26012857e08353486ce993161
MD5 9ce453898f1ffdef1926271c42336e53
BLAKE2b-256 583cf5e85f36c2b534653103b590193a4a0700c3bb5ae91599a3a4b72a3c96a9

See more details on using hashes here.

File details

Details for the file robotframework_lsp-0.40.0-py2.py3-none-any.whl.

File metadata

  • Download URL: robotframework_lsp-0.40.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 3.1 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.0 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.7.12

File hashes

Hashes for robotframework_lsp-0.40.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0c8a40ccc9c5618b948ac6ca34d8c5e5fa4495aa493e07fd24c7ac8bcf8cb7cd
MD5 8109fbd19e1ff0e3d7f45ff5dcb0bf5a
BLAKE2b-256 a65adbfd7947481ed8e4601a5d957611528002b8c66f2963b66e8fa88c97b323

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page