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

  • Robot Output View:
    • View current task/test being executed.
    • Shows Keyword being executed in real time.
  • Robot Documentation View:
    • Select a library import for the full library documentation.
    • Select another element for its docstring.
  • Test Explorer support in VSCode.
  • Interactive Console: a REPL for interactively experimenting with Robot Framework (for VSCode).
  • Code analysis:
    • Keywords/variables.
    • Keyword arguments.
  • Linting with Robocop.
  • Code completion:
    • Keywords, variables, sections and snippets.
    • Auto imports from keywords in the workspace.
  • Go to definition:
    • Keywords, variables and imports.
  • Find references for keywords and variables.
  • Refactoring:
    • Rename keywords.
    • Rename variables.
    • Extract local variable.
    • Extract variable to variables section.
  • Quick fixes (VSCode: Ctrl + .):
    • Add import for unresolved keyword.
    • Create local variable for unresolved variable.
    • Create argument for unresolved variable.
    • Creat variable in variables section for unresolved variable.
    • Assign keyword to variable.
    • Surround with Try..Except.
  • Symbols browser for keywords in workspace (VSCode: Ctrl + T).
  • Document symbols (VSCode: Ctrl + Shift + O).
  • Highlight of keywords and variables.
  • Syntax highlighting (using semanticTokens).
  • Syntax validation.
  • Signature Help (VSCode: 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.11.0.tar.gz (2.9 MB view details)

Uploaded Source

Built Distribution

robotframework_lsp-1.11.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.11.0.tar.gz.

File metadata

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

File hashes

Hashes for robotframework-lsp-1.11.0.tar.gz
Algorithm Hash digest
SHA256 fc63766cdd92d92015f45b1f376f10932fddacc6acd01d0c5df559908561c153
MD5 577f67e0d350e788b27d15ccad103794
BLAKE2b-256 3077d0767f5e847055de8a472b92f3c57f5d3de25c1152b2218e38913f24de5d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for robotframework_lsp-1.11.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6fb073e565aa5e0c0ea17724915afc8866a2a70563e8b5239284bd615bd9a17f
MD5 01fc49fd9635b0f2a0a87f4f95cfdd5e
BLAKE2b-256 66f799b111efafd209834b82073d54019086fd999198abdfc39ebd7d64cea837

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