You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/actions.md
+30-30Lines changed: 30 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -785,7 +785,7 @@ The server's running state is monitored in a separate thread, which allows for a
785
785
786
786
The `AppServer` plugin provides a robust and flexible way to integrate web applications, including real-time WebSocket applications, into your development environment. By following the instructions outlined in this documentation, you can effectively manage and interact with web applications within your project.
787
787
788
-
# generic\AnalogueFileAction.kt
788
+
# generic\GenerateRelatedFileAction.kt
789
789
790
790
791
791
## Analogue File Action Plugin Documentation
@@ -968,17 +968,17 @@ Before you can use the Code Chat Plugin, ensure you have the following:
968
968
969
969
The Code Chat Plugin offers a powerful way to enhance collaboration and streamline the code review process directly within your IDE. By following this guide, you should be well-equipped to start using the plugin to its full potential. Happy coding and collaborating!
The `CreateFileAction` plugin is a powerful tool designed to automate the process of file creation within a project, leveraging natural language directives to generate the necessary code. This document provides a comprehensive guide on how to use the `CreateFileAction` plugin effectively.
976
+
The `CreateFileFromDescriptionAction` plugin is a powerful tool designed to automate the process of file creation within a project, leveraging natural language directives to generate the necessary code. This document provides a comprehensive guide on how to use the `CreateFileFromDescriptionAction` plugin effectively.
977
977
978
978
979
979
### Overview
980
980
981
-
The `CreateFileAction` plugin integrates with the project environment to interpret natural language instructions and generate files accordingly. It utilizes the OpenAI API to understand the directives and create files with the specified content and at the desired location within the project structure.
981
+
The `CreateFileFromDescriptionAction` plugin integrates with the project environment to interpret natural language instructions and generate files accordingly. It utilizes the OpenAI API to understand the directives and create files with the specified content and at the desired location within the project structure.
982
982
983
983
984
984
### Key Components
@@ -999,7 +999,7 @@ The `CreateFileAction` plugin integrates with the project environment to interpr
999
999
1000
1000
1. **Configure the Directive**:Access the `SettingsUI` component and input your directive in the provided text area. For example, "Create a default log4j configuration file".
1001
1001
2. **Select the TargetLocation**:In your project, select the location where you want the new file to be created. This selection will determine the base path for the new file.
1002
-
3. **Execute the Action**:Run the `CreateFileAction` plugin. It will process your directive and the selected location to generate and create the new file accordingly.
1002
+
3. **Execute the Action**:Run the `CreateFileFromDescriptionAction` plugin. It will process your directive and the selected location to generate and create the new file accordingly.
1003
1003
1004
1004
1005
1005
### Example
@@ -1008,7 +1008,7 @@ Suppose you want to create a new log4j configuration file in your Java project.
1008
1008
1009
1009
1. Open the `SettingsUI` and input the directive:"Create a default log4j configuration file".
1010
1010
2. Select the `src/main/resources` directory in your project as the target location.
1011
-
3. Execute the `CreateFileAction`. The plugin will then generate a log4j configuration file based on your directive and place it in the specified directory.
1011
+
3. Execute the `CreateFileFromDescriptionAction`. The plugin will then generate a log4j configuration file based on your directive and place it in the specified directory.
1012
1012
1013
1013
1014
1014
### HandlingExistingFiles
@@ -1018,17 +1018,17 @@ If the plugin detects that the generated file's intended path already exists, it
1018
1018
1019
1019
### Conclusion
1020
1020
1021
-
The `CreateFileAction` plugin offers a convenient and efficient way to automate file creation within your projects, leveraging natural language processing to interpret directives and generate the necessary files. By following the steps outlined in this document, you can harness the power of this plugin to streamline your development workflow.
1021
+
The `CreateFileFromDescriptionAction` plugin offers a convenient and efficient way to automate file creation within your projects, leveraging natural language processing to interpret directives and generate the necessary files. By following the steps outlined in this document, you can harness the power of this plugin to streamline your development workflow.
1022
1022
1023
-
# generic\AppendAction.kt
1023
+
# generic\AppendTextWithChatAction.kt
1024
1024
1025
1025
1026
-
## AppendAction Plugin Documentation
1026
+
## AppendTextWithChatAction Plugin Documentation
1027
1027
1028
1028
1029
1029
### Overview
1030
1030
1031
-
The `AppendAction` plugin is designed to enhance your coding experience by allowing you to automatically append generated text to a selected piece of text within your code editor. This functionality is particularly useful for developers looking for quick ways to extend their code snippets based on AI-generated suggestions.
1031
+
The `AppendTextWithChatAction` plugin is designed to enhance your coding experience by allowing you to automatically append generated text to a selected piece of text within your code editor. This functionality is particularly useful for developers looking for quick ways to extend their code snippets based on AI-generated suggestions.
1032
1032
1033
1033
1034
1034
### Features
@@ -1047,16 +1047,16 @@ The `AppendAction` plugin is designed to enhance your coding experience by allow
1047
1047
1048
1048
### Usage
1049
1049
1050
-
To use the `AppendAction` plugin, follow these steps:
1050
+
To use the `AppendTextWithChatAction` plugin, follow these steps:
1051
1051
1052
1052
1. **Select Text**: Highlight the text in your code editor that you want to append generated text to.
1053
-
2. **Activate AppendAction**: Use the designated shortcut or menu option to activate the `AppendAction` plugin.
1053
+
2. **Activate AppendTextWithChatAction**: Use the designated shortcut or menu option to activate the `AppendTextWithChatAction` plugin.
1054
1054
3. **Review and Accept**: The plugin will automatically append the AI-generated text to your selection. Review the appended text and make any necessary adjustments.
1055
1055
1056
1056
1057
1057
### Configuration
1058
1058
1059
-
The behavior of the `AppendAction` plugin can be customized through the `AppSettingsState`. Key settings include:
1059
+
The behavior of the `AppendTextWithChatAction` plugin can be customized through the `AppSettingsState`. Key settings include:
1060
1060
1061
1061
- **Default Chat Model**: Specifies the AI model used for generating text. This can be adjusted to use different models based on your preference or the specific needs of your project.
1062
1062
- **Temperature**: Controls the creativity of the generated text. A higher temperature results in more creative (but potentially less predictable) outputs, while a lower temperature produces more conservative and predictable text.
@@ -1070,19 +1070,19 @@ The behavior of the `AppendAction` plugin can be customized through the `AppSett
1070
1070
1071
1071
### Conclusion
1072
1072
1073
-
The `AppendAction` plugin offers a powerful way to extend your code with AI-generated text, streamlining your development process and sparking creativity. By customizing the plugin settings, you can tailor the text generation to meet your specific needs and preferences.
1073
+
The `AppendTextWithChatAction` plugin offers a powerful way to extend your code with AI-generated text, streamlining your development process and sparking creativity. By customizing the plugin settings, you can tailor the text generation to meet your specific needs and preferences.
1074
1074
1075
-
# generic\DictationAction.kt
1075
+
# generic\VoiceToTextAction.kt
1076
1076
1077
1077
1078
-
## DictationActionPluginDocumentation
1078
+
## VoiceToTextActionPluginDocumentation
1079
1079
1080
-
The `DictationAction` plugin is designed to enhance your coding experience by allowing you to dictate code and comments directly into your IDE. This document provides an overview of the plugin's functionality, setup instructions, and usage guidelines.
1080
+
The `VoiceToTextAction` plugin is designed to enhance your coding experience by allowing you to dictate code and comments directly into your IDE. This document provides an overview of the plugin's functionality, setup instructions, and usage guidelines.
1081
1081
1082
1082
1083
1083
### Overview
1084
1084
1085
-
The `DictationAction` plugin captures audio through your microphone, processes the audio to convert speech to text, and then inserts the transcribed text into your code editor at the current cursor position or replaces the selected text. It operates in the background, starting with a simple action trigger and stopping when you close a specific dialog window.
1085
+
The `VoiceToTextAction` plugin captures audio through your microphone, processes the audio to convert speech to text, and then inserts the transcribed text into your code editor at the current cursor position or replaces the selected text. It operates in the background, starting with a simple action trigger and stopping when you close a specific dialog window.
1086
1086
1087
1087
1088
1088
### Features
@@ -1095,7 +1095,7 @@ The `DictationAction` plugin captures audio through your microphone, processes t
1095
1095
1096
1096
### Prerequisites
1097
1097
1098
-
Before using the `DictationAction` plugin, ensure you have:
1098
+
Before using the `VoiceToTextAction` plugin, ensure you have:
1099
1099
1100
1100
-A compatible IDE (IntelliJ-based IDEs).
1101
1101
-A working microphone set up and configured on your system.
@@ -1104,7 +1104,7 @@ Before using the `DictationAction` plugin, ensure you have:
1104
1104
1105
1105
### Installation
1106
1106
1107
-
1. Download the `DictationAction` plugin from the plugin marketplace or the provided source.
1107
+
1. Download the `VoiceToTextAction` plugin from the plugin marketplace or the provided source.
1108
1108
2. In your IDE, navigate to `Settings` > `Plugins`.
1109
1109
3. Click on `InstallPlugin from Disk...` and select the downloaded plugin file.
1110
1110
4. Restart your IDE to activate the plugin.
@@ -1115,7 +1115,7 @@ Before using the `DictationAction` plugin, ensure you have:
1115
1115
To start dictating:
1116
1116
1117
1117
1. Ensure your microphone is on and properly configured.
1118
-
2. Trigger the `DictationAction` from the IDE's action menu or use the assigned shortcut.
1118
+
2. Trigger the `VoiceToTextAction` from the IDE's action menu or use the assigned shortcut.
1119
1119
3. A dialog titled "Dictation" will appear, indicating that dictation is active. Keep this dialog open while dictating.
1120
1120
4. Speak clearly into your microphone. Your spoken words will be transcribed and inserted into your editor in real-time.
1121
1121
5. To stop dictation, simply close the "Dictation" dialog window.
@@ -1135,9 +1135,9 @@ For support, feature requests, or to report bugs, please visit the plugin's GitH
1135
1135
1136
1136
### Conclusion
1137
1137
1138
-
The `DictationAction` plugin offers a convenient way to enhance your coding efficiency through voice commands. By following the setup instructions and usage guidelines provided inthis document, you can seamlessly integrate dictation into your development workflow.
1138
+
The `VoiceToTextAction` plugin offers a convenient way to enhance your coding efficiency through voice commands. By following the setup instructions and usage guidelines provided inthis document, you can seamlessly integrate dictation into your development workflow.
1139
1139
1140
-
# generic\DocumentationCompilerAction.kt
1140
+
# generic\GenerateDocumentationAction.kt
1141
1141
1142
1142
1143
1143
#### DocumentationCompilerActionPlugin
@@ -1435,15 +1435,15 @@ For support, feature requests, or to report bugs, please visit the plugin's GitH
1435
1435
1436
1436
This documentation aims to provide you with all the necessary information to get started with the MarkdownListAction plugin. Enhance your Markdown editing experience by leveraging the power of AI to generate list items effortlessly.
The `ReplaceOptionsAction` plugin is designed to enhance your coding experience within the IntelliJIDEA environment by providing smart text replacement suggestions. Leveraging advanced AI models, this plugin analyzes the context of your selected text and offers a list of suggestions to replace it, aiming to improve code quality, readability, or simply to offer creative alternatives.
1446
+
The `ReplaceWithSuggestionsAction` plugin is designed to enhance your coding experience within the IntelliJIDEA environment by providing smart text replacement suggestions. Leveraging advanced AI models, this plugin analyzes the context of your selected text and offers a list of suggestions to replace it, aiming to improve code quality, readability, or simply to offer creative alternatives.
1447
1447
1448
1448
1449
1449
### Features
@@ -1457,7 +1457,7 @@ The `ReplaceOptionsAction` plugin is designed to enhance your coding experience
1457
1457
### How to Use
1458
1458
1459
1459
1. **SelectText:**Begin by selecting the text in your code that you wish to replace.
1460
-
2. **ActivateAction:**Trigger the `ReplaceOptionsAction` by using its assigned shortcut or by finding it in the context menu.
1460
+
2. **ActivateAction:**Trigger the `ReplaceWithSuggestionsAction` by using its assigned shortcut or by finding it in the context menu.
1461
1461
3. **ChooseReplacement:**A dialog will appear with a list of suggestions. Select the one that best fits your needs and confirm your choice.
1462
1462
4. **ReviewChanges:**The selected text in your code will be replaced with your chosen suggestion. Review the change to ensure it meets your expectations.
1463
1463
@@ -1471,7 +1471,7 @@ The `ReplaceOptionsAction` plugin is designed to enhance your coding experience
1471
1471
1472
1472
### Customization
1473
1473
1474
-
To tailor the behavior of the `ReplaceOptionsAction` plugin to your preferences, you can adjust the settings in `AppSettingsState`. This includes:
1474
+
To tailor the behavior of the `ReplaceWithSuggestionsAction` plugin to your preferences, you can adjust the settings in `AppSettingsState`. This includes:
1475
1475
1476
1476
-**DefaultChatModel:**Choose the AI model that best suits your coding style or the specific language/framework you are working with.
1477
1477
-**Temperature:**Adjust the creativity level of the suggestions. A higher temperature results in more creative (but potentially less accurate) suggestions, while a lower temperature favors more conservative and contextually accurate options.
@@ -1485,7 +1485,7 @@ To tailor the behavior of the `ReplaceOptionsAction` plugin to your preferences,
1485
1485
1486
1486
### Conclusion
1487
1487
1488
-
The `ReplaceOptionsAction` plugin offers a powerful way to enhance your coding experience by integrating AI-powered text replacement suggestions directly into your workflow. By understanding and utilizing its features, you can significantly improve the efficiency and quality of your code writing process.
1488
+
The `ReplaceWithSuggestionsAction` plugin offers a powerful way to enhance your coding experience by integrating AI-powered text replacement suggestions directly into your workflow. By understanding and utilizing its features, you can significantly improve the efficiency and quality of your code writing process.
0 commit comments