2.4.x update

.gitignore

@@ -42,3 +42,5 @@ bin/
 .DS_Store
 
 .idea
+
+src/main/resources/config/local.properties

BUILD_PLUGIN.md

@@ -0,0 +1,6 @@
+# Prerequisite
+
+If you want to build your own complete plugin like DevPilot, there are some required condition:
+1. AI gateway: support multi LLM model and provide api for plugin [Gateway repo](https://github.com/openpilot-hub/devpilot-gateway)
+2. Auth System: support authorization check for login user (You can close it by setting `DefaultConst.AUTH_ON` to false)
+3. Telemetry System: upload user behavior data for analysis (You can close it by setting `DefaultConst.TELEMETRY_ON` to false)

BUILD_PLUGIN_ZH.md

@@ -0,0 +1,6 @@
+# 前提条件
+
+如果想构建一个完整的属于你自己的DevPilot应用，需要有如下几个条件：
+1. AI网关：用于兼容不同的LLM模型，并提供API给插件使用 [网关仓库](https://github.com/openpilot-hub/devpilot-gateway)
+2. 权限系统：用于校验插件用户的登录和使用权限（可以通过设置`DefaultConst.AUTH_ON`为false来关闭）
+3. 指标系统：用于处理用户上报的使用数据用于分析（可以通过设置`DefaultConst.TELEMETRY_ON`为false来关闭）

CONTRIBUTING.md

@@ -11,15 +11,19 @@ Java 11 or higher version is required to build and test this repository.
 ### Building
 
 1. Clone this repository to your local machine.
-
     `git clone https://github.com/openpilot-hub/devpilot-intellij.git`
 2. Run the following command to build the project.
-
     `./gradlew runIde`
 3. If you are using windows, run the following command to build the project.
-
     `gradlew.bat runIde`
 
+### Update Webview
+
+1. Clone this repository
+    `https://github.com/openpilot-hub/devpilot-h5`
+2. Run `pnpm install` and `pnpm run build`
+3. `cp dist/ext.html ../devpilot-intellij/src/main/resources/webview/index.html`
+
 ### Testing & Checks
 
 Before you commit your changes, please run the following command to check if there are any errors.

CONTRIBUTING_ZH.md

@@ -11,15 +11,19 @@
 ### 项目构建
 
 1. 将项目克隆到本地。
-
     `git clone https://github.com/openpilot-hub/devpilot-intellij.git`
 2. 运行如下指令构建项目。
-
     `./gradlew runIde`
 3. 如果你使用的是 windows，运行如下指令构建项目。
-
     `gradlew.bat runIde`
 
+### 更新 Webview 页面
+
+1. 克隆前端webview项目
+   `https://github.com/openpilot-hub/devpilot-h5`
+2. 执行 `pnpm install` 和 `pnpm run build`
+3. 执行`cp dist/ext.html ../devpilot-intellij/src/main/resources/webview/index.html`
+
 ### 测试和检查
 
 在提交commit之前，请运行如下指令检查是否有错误。

README.md

@@ -17,155 +17,17 @@ This innovative AI-based plugin is set to supercharge your development process.
 5. **Code Explanation:** Don't just write code, understand it! DevPilot can explain unfamiliar code snippets, helping you grasp what's happening and learn faster.
 6. **Auto-Comments:** Keep your code clear! DevPilot can automatically add comments to your code, ensuring it's easy to understand and maintain.
 
-## Prerequisites
-
-1. You will need an OpenAI API key / Codellama API endpoint before you use this plugin.
-2. For use of Codellama, see [deploy Codellama into you local environment](https://github.com/openpilot-hub/codellama-deploy).
-
-## Installation
-
-Currently, the plugin has version requirements for IntelliJ IDEA. The minimum required version is 2021.2, make sure you have the appropriate version installed before attempting to use the plugin.
-
-There are three ways for installing plugins:
-
-- IDEA official marketplace - You can get the plugin from [here](https://plugins.jetbrains.com/plugin/23322-devpilot).
-
-- Installation via compressed package - select "install from disk" in the plugin page settings, and then import the zip package. The download link for the compressed package is available in [Release page](https://github.com/openpilot-hub/devpilot-intellij/releases).
-  ![img.png](doc/images/screenshot/cn/install_from_disk.png)
-- Build from scratch
-  1. Clone this repository to your local machine.
-     `git clone https://github.com/openpilot-hub/devpilot-intellij.git`
-  2. Run the following command to build the project.
-
-     `./gradlew runIde`
-
-     If you are using windows, run the following command to build the project.
-
-     `gradlew.bat runIde`
-
-## Configuration
-
-After the successful installation of the plugin, you can find the configuration page of DevPilot in the Tools section of the IDEA settings page.
-open the settings with <kbd>command</kbd>+<kbd>,</kbd>,
-
-then navigate to Tools ❯ DevPilot ❯ Service Configuration.
-
-![configuration](doc/images/screenshot/en/config.png)
-
-On the configuration page, you can switch the language of the plugin between multiple choices, as well as select different models and their addresses. The username will be displayed on the page during the conversation.  
-![settings](doc/images/screenshot/en/settings.png)
-
 ## How to use
 
-In the dialog box, you can ask any question and send it by pressing Enter or using the send button. DevPilot will then provide an answer and display it on the current page.
-
-Select a block of code, then right-click on the "DevPilot" option on the context menu.You can choose from one of:
-
-- New DevPilot Chat
-- Generate Tests
-- Review Code
-- Generate Comments
-- Fix This
-- Performance Check
-- Explain This
-
-![menu](doc/images/screenshot/en/chat_menu.png)
-
-**For example**, select the code, right-click ❯ DevPilot ❯ Fix This.
-
-Then, the window will automatically open and provide relevant suggestions for fixes. You can modify the code based on the suggestions.
-
-## Plugin Functionality
-
-DevPilot provides developers with rich capabilities to help them eliminate the tedious work of writing test cases and comments, write more efficient code, and troubleshoot code issues, among other things.
-
-### Chat with DevPilot
-
-The plugin supports chat, the conversation page can be opened through the right-click menu or the entry on the right sidebar.
-
-![menu chat](doc/images/screenshot/en/menu_chat.png)
-
-You can write questions in the dialogue box, send them by pressing enter or the send button, and OpenAI will provide answers and display them on the current page.
-
-![welcome](doc/images/screenshot/en/welcome.png)
-
-### Generate test cases
-
-Users can generate test cases through our plugin. Users can right-click on a selected method and click "Generate Tests".
-
-![menu testcase](doc/images/screenshot/en/menu_testcase.png)
-
-Afterward, a window will automatically open and the window will return the relevant test cases. Users can directly copy the test or choose to insert or replace the relevant code at the cursor position. They can even create a new test class file.
-
-![testcase result](doc/images/screenshot/en/testcase_result.png)
-
-### Generate comments
-
-Plugin supports the function of generating code comments. Users can right-click and select "Generate comments" after selecting a code block.
-
-![menu gen comments](doc/images/screenshot/en/menu_gen_comments.png)
-
-Afterward, the window will automatically open and return the relevant annotation results. The edited code will also automatically show the generated annotations and the original code in a diff format, allowing users to compare and accept the corresponding annotations.
-
-### Fix bugs
-
-The plugin supports the ability to fix code. Users can right-click on "Fix This" after selecting a code block.
-
-![menu fix bug](doc/images/screenshot/en/menu_fix_bug.png)
-
-Afterward, the window will automatically open and provide relevant repair suggestions. Users can modify their code based on the suggestions.
-
-![fix bugs result](doc/images/screenshot/en/fix_bug_result.png)
-
-### Review code
-
-The plugin supports the ability to review code. Users can right-click on the selected code block and click "Review Code".
-
-![menu code review.png](doc/images/screenshot/en/menu_code_review.png)
-
-Afterward, the window will automatically open and return the relevant review results. Users can edit their code logic based on the results.
-
-![review code result](doc/images/screenshot/en/code_review_result.png)
-
-### Performance Check
-
-The plugin supports performance checking of code. Users can right-click on the selected code block and choose "Performance Check".
-
-![menu performance check](doc/images/screenshot/en/menu_performance_check.png)
-
-Afterward, the window will automatically open and return the relevant performance test results. Additionally, the optimized code and the original code will be automatically compared using diff in the editor, allowing users to optimize their code based on the results.
-
-![performance check result](doc/images/screenshot/en/performance_check_result.png)
-
-### Clear context
-
-The overall capabilities of the plugin are context-dependent, but the context may be polluted, and OpenAI or other large models may have token limitations that result in errors when exceeded. Therefore, we provide the ability to clean up by clicking the clear button in the upper right corner of the window, which will clear the entire session.
-
-![menu clear context](doc/images/screenshot/en/clear_context.png)
-
-## Roadmap
-
-At DevPilot, we are constantly working on expanding the capabilities of our AI-powered plugin to meet the evolving needs of our users. Our roadmap is a reflection of our commitment to continually improve and innovate.
-
-### Near-Term Goals : integration with local LLM
-
-We weill soon support Codellama, an opensource LLM developed by Meta, into DevPilot. This will provide you with the ability to leverage the power of LLM directly in your local development environment, without sending any sensitive data to OpenAI.
-
-With Codellama integration, users can expect:
-
-- More accurate and context-specific code suggestions, Codellama has a 100k context length, so the suggestions it provides will be based on a deeper understanding of the code's context. This will significantly reduce the time developers spend on figuring out the appropriate code to use.
-- With its fine-tuning on a large codebase, Codellama can outperform ChatGPT in certain cases.
+[DevPilot for JetBrains](https://github.com/openpilot-hub/documentation/blob/main/README_JetBrains_EN.md)
 
-### Long-Term Goals: Model as a Service (MaaS) Support
+## RAG
 
-Looking ahead, we plan to extend our capabilities further by supporting Model as a Service (MaaS). MaaS provides the ability for users to utilize AI models in a service-based manner, without the need for local deployment or maintenance. This feature will enable seamless access to the latest AI models without bearing the computational costs or complexities of managing these models locally.
+[DevPilot RAG](https://github.com/openpilot-hub/documentation/blob/main/README_RAG_EN.md)
 
-By integrating MaaS into DevPilot, we aim to:
+## Build your own plugin
 
-- Access the latest OpenAI models without the hassle of setting up a OpenAI API key.
-- Provide a plug-and-play solution for accessing state-of-the-art AI models
-- Allow developers to leverage the latest AI advancements without the need for local resources.
-- Offer a scalable solution that can grow with your project's needs.
+[Build DevPilot](BUILD_PLUGIN.md)
 
 ## Contributing