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

  • Robot Output View (shows output details for the current 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

This version

1.5.0

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

Uploaded Source

Built Distribution

robotframework_lsp-1.5.0-py2.py3-none-any.whl (3.5 MB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for robotframework-lsp-1.5.0.tar.gz
Algorithm Hash digest
SHA256 99f2e91ce1788b6acfe15e8b51654e409af032f907db23458737207e3751a11e
MD5 4c94640a7a9928ab2edda6e1c039112c
BLAKE2b-256 f095a98ad71ad602d9dc2756ce8a5304b7f37d41f6bafba479daccc357443d78

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for robotframework_lsp-1.5.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7b17e861de0fcfac72575d728c618cd315ca19b4f6646ada2ffcb8c73a2bca17
MD5 7c05d8f72d2779bb70e82e45ac00754d
BLAKE2b-256 fa3bc1d72ed23e8ce086a690b5c49c87e0366f5d00e6a47286655acf7a959e2d

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