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.

Contributing

See: Contributing for how to help in the development of Robot Framework Language Server.

Reporting Issues

See: Reporting Issue for details on how to report some issue in the Robot Framework Language Server.

Features (1.7.0)

  • Robot Output View (shows output details for the current test run and output.xml -- note: currently in beta).
  • Robot Documentation View (shows documentation for the current editor selection).
  • Test Explorer support in VSCode.
  • Interactive Console: a REPL for interactively experimenting with Robot Framework (for VSCode).
  • Code analysis: checks if keywords/variables 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.
  • Find references for keywords and variables.
  • Rename keywords and variables.
  • Symbols browser for keywords in workspace (activated through Ctrl + T).
  • Document symbols.
  • Highlight of keywords and 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.

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-1.7.0.tar.gz (3.0 MB view details)

Uploaded Source

Built Distribution

robotframework_lsp-1.7.0-py2.py3-none-any.whl (3.6 MB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: robotframework-lsp-1.7.0.tar.gz
  • Upload date:
  • Size: 3.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.15

File hashes

Hashes for robotframework-lsp-1.7.0.tar.gz
Algorithm Hash digest
SHA256 bc51b3fed684b6837e5881650ffe0d014dd816d8eaa3d06daa0b206ac0f1c868
MD5 b73903dac20981c5f8d349f98b755f0f
BLAKE2b-256 1c0a93cea8a391b39b4e2cb20324f99ef2b7294053e185aa5e911e9dfc035502

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for robotframework_lsp-1.7.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 475520f1f64d0abe7a0735f54d39a97d8f55e34bcf988c3a144f2881a784cb5d
MD5 fbf3b487697ea28f90b00d495de72dce
BLAKE2b-256 c845aa2b649842ad1bff6ade62508a49bb985e959fbc9a021893180f46b40499

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