How To

How To Use Robot Framework Assistant plugin

Table of Contents

1. Project specific settings
2. Enable command_log API
3. Keyword and variable completion
4. Robot Framework Assistant context menu

Project specific settings

It is possible to configure Robot Framework Assistant settings separately for each Sublime project. The Robot Framework Assistant project specific settings must be always placed inside of the json object, which string is: robot_framework_assistant. The robot_framework_assistant object must contain other json objects, which are defined in the Robot.sublime-settings file.

Example defining project specific settings for robot_framework_workspace and robot_framework_database_path could look like this:

"robot_framework_assistant":
    {
        "robot_framework_workspace": "/path/to/workspace",
        "robot_framework_database_path": "/database/path/for/workspace"
    }

Please note that, if you want define project specific robot_framework_database_path, then the folder should be unique for each project. If it's not unique, then the database must be re-created from scratch, example by Robot Framework: Create Database command, each time when project is changed.

Enable command_log API

If a problem is encountered, example that command does not work, it might be useful to enable the Sublime Text log_commands API. The log_commands API can be enabled by setting the robot_framework_log_commands setting to true and running the Robot Framework: Command Logging from the command palette or be menu: | Preferences | Package Settings | Robot Framework Assistant | Command Logging |

When enabled all commands run from key bindings and the menu will be logged to the console.

When enough information is gathered, set the robot_framework_log_commands setting to false and running the Robot Framework: Command Logging again.

Keyword and variable completion

The animation in below demonstrates an example for the keyword completion works when in the internal database is properly updated. Keyword completion is triggered automatically by the plugin. Also at the end keyword selected by pressing the Enterkey.

The animation in below demonstrates an example for the variable completion. The only difference in the keyword completion animation is that the variable completion is triggered after the $ character, by pressing the Ctrl+Space

Robot Framework Assistant context menu

It is possible to access Robot Framework Assistant commands, snippets, configuration and other feature by using the Robot Framework context menu. Context menu can be accessed from any Robot Framework data file. See an example from picture in below.