|
1 | 1 | # robotcode4ij |
2 | 2 |
|
3 | | - |
4 | | -[](https://plugins.jetbrains.com/plugin/MARKETPLACE_ID) |
5 | | -[](https://plugins.jetbrains.com/plugin/MARKETPLACE_ID) |
6 | | - |
7 | | -## Template ToDo list |
8 | | -- [x] Create a new [IntelliJ Platform Plugin Template][template] project. |
9 | | -- [ ] Get familiar with the [template documentation][template]. |
10 | | -- [ ] Adjust the [pluginGroup](./gradle.properties) and [pluginName](./gradle.properties), as well as the [id](./src/main/resources/META-INF/plugin.xml) and [sources package](./src/main/kotlin). |
11 | | -- [ ] Adjust the plugin description in `README` (see [Tips][docs:plugin-description]) |
12 | | -- [ ] Review the [Legal Agreements](https://plugins.jetbrains.com/docs/marketplace/legal-agreements.html?from=IJPluginTemplate). |
13 | | -- [ ] [Publish a plugin manually](https://plugins.jetbrains.com/docs/intellij/publishing-plugin.html?from=IJPluginTemplate) for the first time. |
14 | | -- [ ] Set the `MARKETPLACE_ID` in the above README badges. You can obtain it once the plugin is published to JetBrains Marketplace. |
15 | | -- [ ] Set the [Plugin Signing](https://plugins.jetbrains.com/docs/intellij/plugin-signing.html?from=IJPluginTemplate) related [secrets](https://github.com/JetBrains/intellij-platform-plugin-template#environment-variables). |
16 | | -- [ ] Set the [Deployment Token](https://plugins.jetbrains.com/docs/marketplace/plugin-upload.html?from=IJPluginTemplate). |
17 | | -- [ ] Click the <kbd>Watch</kbd> button on the top of the [IntelliJ Platform Plugin Template][template] to be notified about releases containing new features and fixes. |
| 3 | +[](https://plugins.jetbrains.com/plugin/26216) |
| 4 | +[](https://plugins.jetbrains.com/plugin/26216) |
| 5 | + |
18 | 6 |
|
19 | 7 | <!-- Plugin description --> |
20 | | -Robot Framework IntelliSense, linting, test execution and debugging, code formatting, refactoring, and many more. |
| 8 | + |
| 9 | +⚠️ **Important Notice** ⚠️ |
| 10 | +This plugin is currently under active development and is not yet ready for production use. Please note that it may contain bugs or lack certain features. |
| 11 | + |
| 12 | +We invite you to join the Robot Framework and RobotCode community by reporting issues, suggesting features, and helping us improve the plugin. |
| 13 | + |
| 14 | +Your feedback is greatly appreciated! 🙂 |
| 15 | + |
| 16 | + |
| 17 | +**RobotCode** is a PyCharm/IntelliJ Plugin that enhances your workflow with [Robot Framework](https://robotframework.org/). |
| 18 | +It provides a rich set of features to help you write, run, and debug your Robot Framework tests directly within your IDE. |
| 19 | + |
| 20 | +## Why RobotCode? |
| 21 | + |
| 22 | +**Built on Robot Framework Core** |
| 23 | +RobotCode is based on the Robot Framework Core and uses its parser, ensuring complete compatibility and consistency. This means you get the same syntax validation, error messages, and behavior as if you were running Robot Framework directly. |
| 24 | + |
| 25 | +**Powered by the Language Server Protocol** |
| 26 | +RobotCode is built on the Language Server Protocol (LSP), a modern standard for implementing language support across multiple editors and IDEs. This ensures a seamless and responsive user experience, while making it easier to maintain compatibility with evolving IDE features. |
| 27 | + |
| 28 | +**Powerful Command Line Tools** |
| 29 | +RobotCode extends the Robot Framework CLI with enhanced tools for test execution, analysis, and debugging. It supports [`robot.toml`](https://robotcode.io/03_reference/) configurations, integrates a Debug Adapter Protocol (DAP) compatible debugger, and provides an interactive REPL environment for experimenting with Robot Framework commands. Modular and flexible, these tools streamline your workflow for both development and production. |
| 30 | + |
| 31 | +## Key Features |
| 32 | + |
| 33 | +- **Smart Code Editing**: Auto-completion, syntax highlighting, and seamless navigation. |
| 34 | +- **Refactoring**: Easily rename variables, keywords, and arguments across your project. |
| 35 | +- **Integrated Debugging**: Debug Robot Framework tests directly within the IDE. |
| 36 | +- **Test Management**: Discover, run, and monitor Robot Framework tests without leaving your IDE. |
| 37 | +- **Rich Test Reports**: View detailed test results and logs directly in the IDE. |
| 38 | +- **Code Analysis**: Leverage tools like [Robocop](https://robocop.readthedocs.io/) for linting and static code analysis. |
| 39 | +- **Formatting Made Easy**: Use [Robotidy](https://robotidy.readthedocs.io/) for consistent code formatting. |
| 40 | +- **Support for `robot.toml`**: Manage your Robot Framework projects with ease. |
| 41 | +- **More Features Coming Soon!** |
| 42 | + |
| 43 | + |
| 44 | +## Requirements |
| 45 | + |
| 46 | +- Python 3.8 or newer |
| 47 | +- Robot Framework 4.1 or newer |
| 48 | +- PyCharm 2024.3.1 or newer |
| 49 | + |
| 50 | +## Getting Started |
| 51 | + |
| 52 | +1. Install the [RobotCode Plugin](https://plugins.jetbrains.com/plugin/26216) from the JETBRAINS Marketplace. |
| 53 | +2. Configure your Robot Framework Python environment |
| 54 | +3. Start writing and running your Robot Framework tests! |
| 55 | + |
| 56 | +(Comming soon...) |
| 57 | +For a more detailed guide, check out the [Let's get started](https://robotcode.io/02_get_started/) Guide on the [RobotCode](https://robotcode.io) website. |
| 58 | + |
21 | 59 | <!-- Plugin description end --> |
22 | 60 |
|
23 | 61 | ## Installation |
24 | 62 |
|
25 | 63 | - Using the IDE built-in plugin system: |
26 | | - |
27 | | - <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "robotcode4ij"</kbd> > |
| 64 | + |
| 65 | + <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "RobotCode"</kbd> > |
28 | 66 | <kbd>Install</kbd> |
29 | | - |
| 67 | + |
30 | 68 | - Using JetBrains Marketplace: |
31 | 69 |
|
32 | | - Go to [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/MARKETPLACE_ID) and install it by clicking the <kbd>Install to ...</kbd> button in case your IDE is running. |
| 70 | + Go to [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/26216) and install it by clicking the <kbd>Install to ...</kbd> button in case your IDE is running. |
33 | 71 |
|
34 | | - You can also download the [latest release](https://plugins.jetbrains.com/plugin/MARKETPLACE_ID/versions) from JetBrains Marketplace and install it manually using |
| 72 | + You can also download the [latest release](https://plugins.jetbrains.com/plugin/26216/versions) from JetBrains Marketplace and install it manually using |
35 | 73 | <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd> |
36 | 74 |
|
37 | 75 | - Manually: |
38 | 76 |
|
39 | | - Download the [latest release](https://github.com/robotcodedev/robotcode4ij/releases/latest) and install it manually using |
| 77 | + Download the [latest release](https://github.com/robotcodedev/robotcode/releases/latest) and install it manually using |
40 | 78 | <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd> |
41 | | - |
42 | | - |
43 | | ---- |
44 | | -Plugin based on the [IntelliJ Platform Plugin Template][template]. |
45 | | - |
46 | | -[template]: https://github.com/JetBrains/intellij-platform-plugin-template |
47 | | -[docs:plugin-description]: https://plugins.jetbrains.com/docs/intellij/plugin-user-experience.html#plugin-description-and-presentation |
|
0 commit comments