[![Build Status](https://travis-ci.org/andriyko/sublime-robot-framework-assistant.svg?branch=master)](https://travis-ci.org/andriyko/sublime-robot-framework-assistant)
# Robot Framework Assistant
Robot Framework Assistant provides IDE features to edit
[Robot Framework](http://robotframework.org/) test data in the
[Sublime Text 3](https://www.sublimetext.com/3).
From release 3.0.0 onwards plugin is not anymore compatible with
Sublime Text 2. The releases made before the 3.0.0 will serve
the Sublime Text 2 users. The documentation for Sublime Text 2 user
can be found from st2-maintenance branch
[README](https://github.com/andriyko/sublime-robot-framework-assistant/blob/st2-maintenance/README.md)
This project is currently looking for a maintainer.
# Installation
The easiest way to install is to use
[Package Control](https://packagecontrol.io/) and search for:
`Robot Framework Assistant`.
## Alternative installation methods
Download the plugin as a zip. Open Sublime Text and click
**| Preferences | Browse Packages |** to open the packages directory.
Then create a directory named `Robot Framework Assistant` and
unzip the plugin to the directory.
# Configuration
Before yo can start using the Robot Framework Assistant, you must
at least configure the settings in the
[User package](http://docs.sublimetext.info/en/latest/customization/settings.html)
`Robot.sublime-settings` file. To Open the file
navigate to: **Preferences | Package settings**
**| Robot Framework Assistant | Settings - User |**
The default settings can be found from the **Preferences | Package settings**
**| Robot Framework Assistant | Settings - Default |**
The only mandatory settings which user needs to define are the
[robot_framework_workspace](https://github.com/andriyko/sublime-robot-framework-assistant#robot_framework_workspace)
and the
[path_to_python](https://github.com/andriyko/sublime-robot-framework-assistant#path_to_python).
The rest of the parameters can be safely left in their default values,
when trying out the plugin.
## robot_framework_workspace
Before the Robot Framework Assistant can provide the keyword and
variable completion features, it needs to create a database from the test
suite and resource files. The argument defines the root folder where
scanning of robot data is performed.
Must point to a folder and pointing to a file is not allowed. When
the command `Robot Framework: Create database` is executed,
the scanning of Robot Framework test data is performed based
on this setting.
In windows ow write double backslash to write literal backslash.
## robot_framework_keyword_argument_format
Defines how keyword argument are formatted when keyword
completion is used. When set to false, each argument is
formatted to individual lines. If set to true keyword
and arguments are returned in single line.
## robot_framework_extension
File extension defines which types of files the Robot Framework
Assistant plugin will search from the folder defined
in the robot_framework_workspace option.
This setting affects the plugin commands and features but the theme
definition in this plugin is not affected by this option.
If there library or variable file imports in the Robot Framework data,
those imports are automatically parser and included in the scanning.
## path_to_python
In order the creating the database of keywords and variables to
work, path to Python binary must be defined. It must be the same
Python binary where the Robot Framework is installed.
In Linux like environments this could be like: /usr/bin/python
and in Windows this could be like: C:\\Python27\\python.exe
## robot_framework_module_search_path
Module search path defines a list of paths where the Robot Framework
libraries are searched. Example if you have imported
a library with the library name, then module search path must
contain the folder where the library can be located.
The Robot Framework Assistant uses the Robot Framework API to parse
the test data and libraries. All changes, which are not system
wide, to locate the libraries, must also be added in the
module search path in the Robot Framework Assistant
More details how libraries is searched in Robot Framework can be
found from be the
[Robot Framework User guide](http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#module-search-path)
## robot_framework_automatic_database_table
The robot_framework_automatic_database_table setting controls the
internal database updating. If the set to true, the internal
database tables are created after a Robot Framework test data
file is saved. If set to false, the internal database tables are
only updated when the `Create Database`, `Create Database Tables` or
`Update Internal Database For Active Tab` commands are run.
The setting only controls the Robot Framework test data. If a
libraries or a variable files are updated, then `Create Database`
or `Create Database Tables` commands must be run to update the
internal database.
## robot_framework_library_in_xml
When a library is not available during parsing time,
example if library is imported with Remote library interface or
it is not written in Python like the
[SwingLibrary](https://github.com/robotframework/SwingLibrary)
Then this setting can be used to import libraries in
[libdoc](http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#library-documentation-tool-libdoc)
XML format.
Libraries found from the this path are globally available, like the
BuiltIn library. Example the keyword completion will work although
the library may not imported for that particular resource or test suite.
## robot_framework_builtin_variables
Robot Framework comes by default some predefined and builtin variables.
These variables names may change between different Robot Framework
versions. Use this setting to define a list of the Robot Framework BuiltIn
variables. The easiest way to see the list of the variables is to run
Robot Framework with following test case:
| *** Test Cases *** | |
| --- |--- |
| Log All BuiltIn Vars |
| | Log Variables |
Note: At least on Robot Framework 2.9.2 version, the following command
did not list the empty variables, like ${EMPTY}.
## robot_framework_database_path
By default internal database is created in plugin installation
directory, in database folder. Sometimes it could be useful to
change the default database location.
Example if the robot_framework_workspace is defined in the
Sublime workspace file and user wants to change between
different projects. Then it is useful to define
robot_framework_database_path setting also be project specific.
When the internal database is project specific, user does not
recreate the database when the project is changed.
The robot_framework_database_path must be a path to a folder.
If the setting is not path to a folder, then the database
is created in the plugin installation directory.
## robot_framework_log_commands
Setting controls will the `Robot Framework: Command Logging`
command enable or disable the Sublime Text log_commands API call.
If the robot_framework_log_commands setting evaluates as Python
True, then log_commands API call is enabled. If setting
evaluates as Python False, log_commands API call is disabled.
If log_commands API call is enabled. all commands run from key
bindings and the menu will be logged to the console.
To enabled the logging, set the `robot_framework_log_commands` to value
`true`. Then run the `Robot Framework: Command Logging` command
from command palette.
## robot_framework_keyword_prefixes
Prefixes that are ignored in `jump to keyword` command.
When writing testcases in Gherkin keywords have prefixes like `given`, `when` and `then`.
Such prefixes are testcase specific and must be ignored when looking up a keyword.
Configuration for typical Gherkin stories:
"robot_framework_keyword_prefixes" : ["Given","When","Then","And","But"]
# Syntax definitions
By default this plugin will be used with files which extension is
没有合适的资源?快使用搜索试试~ 我知道了~
用于SublimeText3的机器人框架插件_Python_RobotFramework_下载.zip
共173个文件
py:72个
sublime-snippet:28个
txt:27个
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
0 下载量 71 浏览量
2023-04-25
11:27:29
上传
评论
收藏 173KB ZIP 举报
温馨提示
用于SublimeText3的机器人框架插件_Python_RobotFramework_下载.zip
资源推荐
资源详情
资源评论
收起资源包目录
用于SublimeText3的机器人框架插件_Python_RobotFramework_下载.zip (173个子文件)
.gitignore 26B
BuiltIn-ca8f2e8d70641ce17b9b304086c19657.json 113KB
index-test_a.robot-c6b0faa0427a2cf861a1acad630765ea.json 45KB
index-test_b.robot-28dc4d6e222a03bbc3db1fe62743ce94.json 16KB
messages.json 1KB
LICENSE 1KB
README.md 15KB
CONTRIBUTING.md 9KB
.no-sublime-package 0B
test_indexkw.py 25KB
test_completions.py 14KB
data_parser.py 13KB
index.py 11KB
test_scanner.py 11KB
test_get_documentation.py 9KB
completions.py 7KB
test_get_keyword_from_resource.py 7KB
get_keyword.py 7KB
scanner.py 6KB
test_get_keyword_from_library.py 6KB
test_noralize_cell.py 6KB
test_queue.py 6KB
test_jump_to_file.py 5KB
library_vars.py 5KB
noralize_cell.py 5KB
get_documentation.py 4KB
setting.py 4KB
suite_parser_vars.py 4KB
workspace_objects.py 4KB
jump_to_keyword.py 3KB
test_runner_for_index.py 3KB
run_scanner.py 3KB
scan_and_index.py 3KB
query_completions.py 3KB
index_open_tab.py 3KB
run_index.py 3KB
test_runner_for_scanner.py 3KB
setting_import_helper.py 2KB
scan.py 2KB
scan_open_tab.py 2KB
run_test.py 2KB
queue.py 2KB
jump_to_file.py 2KB
show_documentation.py 1KB
test_get_text.py 1KB
test_util.py 1KB
util.py 1KB
get_text.py 1006B
db_json_settings.py 963B
__init__.py 948B
Robot.py 917B
command_logging.py 794B
LibraryWithReallyTooLongName.py 627B
env.py 613B
on_save_create_table.py 464B
index_runner.py 458B
LibraryNameWhichIsLongerThan100CharactersButItSeemsThatItRequiresQuiteAlotLettersInTheFileNameAndIsNotGoodRealLifeExample.py 426B
file_formatter.py 424B
finder.py 351B
get_metadata.py 335B
OtherMyLibrary.py 321B
util.py 316B
library.py 306B
open_log_file.py 237B
MyLibrary.py 219B
scan_index_open_tab.py 215B
__init__.py 190B
LibNoClass.py 174B
SuiteLib.py 161B
common_variables.py 99B
simple_variable_file.py 88B
other_simple_variable_file.py 86B
variables.py 65B
__init__.py 0B
__init__.py 0B
__init__.py 0B
__init__.py 0B
__init__.py 0B
__init__.py 0B
__init__.py 0B
__init__.py 0B
library_parser.robot 6KB
data_parser.robot 1KB
test_a.robot 990B
simple_test.robot 902B
simple_resource.robot 813B
resource_b.robot 772B
common.robot 648B
real_suite_resource.robot 450B
real_suite_resource.robot 385B
resource_a.robot 384B
real_suite.robot 361B
test_b.robot 350B
test_with_libs.robot 299B
really_long_folder_name_to_test_windows_problem_with_too_and_really_long_names_I_hope_windows_could_really_fix_their_apis.robot 154B
__init__.robot 55B
simple_resrouce2.robot 50B
resource.robot 38B
Robot.sublime-build 419B
Default.sublime-commands 883B
共 173 条
- 1
- 2
资源评论
快撑死的鱼
- 粉丝: 1w+
- 资源: 9156
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功