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

  • 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.0.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.0.0.tar.gz (2.9 MB view hashes)

Uploaded source

Built Distribution

robotframework_lsp-1.0.0-py2.py3-none-any.whl (3.4 MB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page