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

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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: robotframework-lsp-1.10.1.tar.gz
  • Upload date:
  • Size: 3.0 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.10.1.tar.gz
Algorithm Hash digest
SHA256 7932f1ae0edd30ea037a09e7c18590270a6a97a820caee00c32da21dc7ecee28
MD5 3afd7a3c873b1fd8fddda6e5c8a5cf84
BLAKE2b-256 81d3981cff4a9a661b6e067d3937145328f350fc40945d5addcca33dcecd4cab

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for robotframework_lsp-1.10.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cfbee0488588a1f9884e4ed6b1cfcce405399edc114281f30c26e95e1302efa2
MD5 54d4bb946eb5748f89a94471d1255228
BLAKE2b-256 135cc5d54df4b9821ca4f8b02e7480ab60d55c71d514820c50989d5b3ccb839e

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