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

  • 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.
  • 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

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

Uploaded Source

Built Distribution

robotframework_lsp-0.23.1-py2.py3-none-any.whl (2.8 MB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: robotframework-lsp-0.23.1.tar.gz
  • Upload date:
  • Size: 2.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.12

File hashes

Hashes for robotframework-lsp-0.23.1.tar.gz
Algorithm Hash digest
SHA256 9bd01162c1a20ff42b348017d770fabf41c7b7b9fbff95e78537790279c163e7
MD5 8599660825f81333a762bad5ee25a5ac
BLAKE2b-256 8ade56db4bb91c07192a3646ac8b394f34b89131f31dde763258f6a749a910db

See more details on using hashes here.

File details

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

File metadata

  • Download URL: robotframework_lsp-0.23.1-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.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.12

File hashes

Hashes for robotframework_lsp-0.23.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6b33899e37fc83e09fd335b0fbf8dfc79af23f70d311895ea807a1ad6b708a11
MD5 bccb26fbd4b8355b29cf051fef47c39a
BLAKE2b-256 caf94f7faddfa44bf239d94ccdf39f44487d87068dea7263be7b9f6d8bedc60c

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