|
1 |
| -# About |
| 1 | +# About RobotCode |
2 | 2 |
|
3 |
| -[](https://marketplace.visualstudio.com/items?itemName=d-biehl.robotcode) |
| 3 | +[](https://marketplace.visualstudio.com/items?itemName=d-biehl.robotcode) |
4 | 4 | [](https://marketplace.visualstudio.com/items?itemName=d-biehl.robotcode)
|
5 | 5 | [](https://github.com/robotcodedev/robotcode/actions?query=workflow:build_test_package_publish)
|
6 | 6 | [](https://github.com/robotcodedev/robotcode/blob/master/LICENSE)
|
7 | 7 | [](https://pypi.org/project/robotcode)
|
8 | 8 | [](https://pypi.org/project/robotcode)
|
9 | 9 | [](https://pypi.org/project/robotcode/)
|
10 | 10 |
|
11 |
| ----- |
| 11 | +--- |
12 | 12 |
|
13 |
| -*RobotCode* is an [extension](https://marketplace.visualstudio.com/VSCode) that provides comprehensive support for [RobotFramework](https://robotframework.org/) in [Visual Studio Code](https://code.visualstudio.com/). It offers a wide range of features, including code completion, debugging, test explorer, refactoring, and more! |
| 13 | +**RobotCode** is your all-in-one extension for working with the [Robot Framework](https://robotframework.org/) in [Visual Studio Code](https://code.visualstudio.com/). Whether you're writing, testing, or debugging, RobotCode provides a comprehensive toolkit that makes every aspect of your development process smoother and more efficient. |
14 | 14 |
|
15 |
| -## Features |
16 |
| - |
17 |
| -With RobotCode you can edit your code with auto-completion, code navigation, syntax checking and many more. |
18 |
| -Here is a list of Features: |
19 |
| - |
20 |
| -- [About](#about) |
21 |
| - - [Features](#features) |
22 |
| - - [Autocomplete and IntelliSense](#autocomplete-and-intellisense) |
23 |
| - - [Code Navigation](#code-navigation) |
24 |
| - - [Diagnostics and Linting](#diagnostics-and-linting) |
25 |
| - - [Code Formatting](#code-formatting) |
26 |
| - - [Running and Debugging](#running-and-debugging) |
27 |
| - - [Multi-root Workspace folders](#multi-root-workspace-folders) |
| 15 | +## Key Features |
28 | 16 |
|
29 | 17 | ### Autocomplete and IntelliSense
|
30 | 18 |
|
31 |
| -Autocompletion for: |
32 |
| -- Libraries with parameters |
33 |
| -- Resources, |
34 |
| -- Variables |
35 |
| -- Keywords with parameters |
36 |
| -- Namespaces |
| 19 | +- **Comprehensive Autocompletion:** Say goodbye to tedious typing! RobotCode provides autocompletion for libraries, resources, variables, and keywords, ensuring you always have the right tools at your fingertips. This includes support for local variables, resources, file-based variables (like Python and YAML), and command line variables, both static and dynamic. |
| 20 | +- **Context-Aware Suggestions:** IntelliSense offers context-sensitive suggestions, helping you code faster with fewer errors. It’s perfect for those moments when you can’t quite remember the exact syntax. |
37 | 21 |
|
38 | 22 | 
|
39 | 23 |
|
40 |
| -Autocompletion supports all supported variables types |
41 |
| - - local variables |
42 |
| - - variables from resource files |
43 |
| - - variables from variables file (.py and .yaml) |
44 |
| - - static and dynamic |
45 |
| - - command line variables |
46 |
| - - builtin variables |
47 |
| - |
48 |
| - |
49 |
| - |
50 | 24 | ### Code Navigation
|
51 | 25 |
|
52 |
| -- Symbols |
53 |
| -- Goto definitions and implementations |
54 |
| - - Keywords |
55 |
| - - Variables |
56 |
| - - Libraries |
57 |
| - - Resources |
58 |
| -- Find references |
59 |
| - - Keywords |
60 |
| - - Variables |
61 |
| - - Imports |
62 |
| - - Libraries |
63 |
| - - Resources |
64 |
| - - Variables |
65 |
| - - Tags |
66 |
| -- Errors and Warnings |
| 26 | +- **Quick Symbol Navigation:** Easily move through your code with RobotCode’s symbol navigation, allowing you to jump straight to definitions, implementations, or references for keywords, variables, libraries, and resources. |
| 27 | +- **Error and Warning Diagnostics:** Stay on top of your code quality with real-time diagnostics that highlight errors and warnings as you code, so you can fix issues before they escalate. |
67 | 28 |
|
68 | 29 | ### Diagnostics and Linting
|
69 | 30 |
|
70 |
| -RobotCode analyse your code and show diagnostics for: |
71 |
| - |
72 |
| -- Syntax Errors |
73 |
| -- Unknown keywords |
74 |
| -- Duplicate keywords |
75 |
| -- Missing libraries, resource and variable imports |
76 |
| -- Duplicate libraries, resource and variable imports |
77 |
| -- ... and many more |
78 |
| - |
79 |
| -For most things RobotCode uses the installed RobotFramework version to parse and analyse the code, so you get the same errors as when you run it. |
80 |
| - |
81 |
| - |
82 |
| -Get additional code analysis with [Robocop](https://robocop.readthedocs.io/). Just install it in your python environment. |
| 31 | +- **Real-Time Code Analysis:** RobotCode continuously monitors your code for syntax errors, unknown keywords, and issues with library or resource imports. This proactive approach helps you catch and resolve problems early in the development process. |
| 32 | +- **Seamless Integration with Robot Framework:** RobotCode uses the version of Robot Framework installed in your environment for diagnostics, ensuring accuracy and consistency with your actual test runs. |
| 33 | +- **Enhanced Linting with Robocop:** For developers who want to go further, RobotCode integrates with [Robocop](https://robocop.readthedocs.io/) to provide even more detailed analysis and linting, giving you insights into how to optimize your code. |
83 | 34 |
|
84 | 35 | ### Code Formatting
|
85 | 36 |
|
86 |
| -RobotCode can format your code with the internal RobotFramework robot.tidy tool (deprecated), but also with [Robotidy](https://robotidy.readthedocs.io/). Just install it. |
| 37 | +- **Automatic Code Formatting:** Keep your code clean and consistent with RobotCode’s formatting tools. You can choose to use the built-in `robot.tidy` tool (now deprecated) or the more powerful [Robotidy](https://robotidy.readthedocs.io/). With just a few clicks, your code is neatly organized and ready for review. |
| 38 | +- **Customizable Formatting Options:** Tailor the formatting rules to suit your project’s needs, ensuring that your codebase remains consistent and easy to read. |
87 | 39 |
|
88 | 40 | ### Running and Debugging
|
89 | 41 |
|
90 |
| -RobotCode supports running and debugging of RobotFramework testcases and tasks out of the box, directly from the definition of the test or suite. |
| 42 | +- **Integrated Testing and Debugging:** RobotCode allows you to run and debug your Robot Framework test cases directly from within Visual Studio Code. This tight integration means you can execute tests, set breakpoints, and step through code without leaving the editor. |
| 43 | +- **Real-Time Log Navigation:** While debugging, RobotCode provides a live view of log messages in the debug console, allowing you to quickly identify and navigate to the source of any issues. |
91 | 44 |
|
92 | 45 | 
|
93 | 46 |
|
94 |
| -In the debug console you can see all log messages of the current run and navigate to the keyword the message was written by. |
| 47 | +### Multi-root Workspace Support |
| 48 | + |
| 49 | +- **Manage Multiple Projects Seamlessly:** With support for [Multi-root Workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces), RobotCode allows you to work on multiple Robot Framework projects simultaneously, each with its own settings and Python environments. Whether you prefer to have separate environments or share the same one across projects, RobotCode offers the flexibility to match your workflow. |
| 50 | +- **Smooth Workflow Transitions:** Easily switch between different projects and configurations without losing your place or context, making it easier to manage complex development environments and large codebases. |
95 | 51 |
|
96 |
| -### Multi-root Workspace folders |
| 52 | +--- |
97 | 53 |
|
98 |
| -RobotCodes support for [Multi-root Workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces), enables loading and editing different Robotframework projects/folders with different RobotFramework/Python environments and settings at the same time or you can share the same RobotFramework/Python environment and settings for all folders in the workspace. |
| 54 | +**RobotCode** isn’t just a tool—it’s your coding partner. With its powerful features and seamless integration, RobotCode helps you be more productive and enjoy your coding experience. Whether you’re a seasoned Robot Framework user or just getting started, RobotCode is here to help you build, test, and deploy with confidence. Let's create something amazing together! |
0 commit comments