AutoDev: Automatic Code Generation and Debugging Tool with Multi-Language Support

General Introduction

AutoDev is an open source project developed by the Unit Mesh team and hosted on GitHub, aiming to improve developers' programming efficiency through artificial intelligence technology. It is a powerful coding assistant that supports a variety of programming languages , including Java, Kotlin, Python , etc., providing automatic code generation , error debugging , test case creation and documentation and other practical functions. Whether using VSCode or IntelliJ IDEA and other mainstream development tools, users can quickly integrate AutoDev by installing the corresponding plug-ins to enhance the automation level of the development process. The project has received attention from developers for its flexible customization and multi-language support, and although it was withdrawn from the JetBrains marketplace due to copyright issues, it is still available for download and community support via GitHub, making it suitable for individual developers and teams.

Function List

• Automatic code generation: Generate pattern-compliant code based on context, such as the CRUD structure of the Spring framework.
• Intelligent Debugging Assistant: Analyze code errors, provide recommendations for fixes, and help locate the root cause of problems.
• automated test: Generate unit test cases and run them automatically to try to fix failed tests.
• Document Generation: Automatically generate comments or complete documentation based on the code, reducing manual writing efforts.
• Multi-language support: Compatible with Java, Kotlin, JavaScript, Python, Rust and many other languages.
• context-sensitive: Suggests relevant code snippets based on the current code file or recent modifications.
• AI Dialogue: Interactively chat with the selected code to get explanations or optimization suggestions.
• Customized Configuration: Support for customized prompts, AI model servers and teamwork templates.
• DevIns Language: Provides a proprietary AI agent language for writing and executing automation tasks.

Using Help

Installation process

AutoDev currently supports VSCode and IntelliJ series IDEs in the form of plug-ins, the following are the specific installation steps:

VSCode Version Installation

1. Download plug-ins::
   • Open VSCode and go to the Extended Marketplace (shortcut) Ctrl+Shift+X (or click on the expansion icon on the left).
   • Search for "AutoDev" to find extensions published by Unit Mesh (or just visit the GitHub AutoDev VSCode Page (Download the latest release version).
   • Click the "Install" button and wait for the installation to complete.
2. Configuration environment::
   • After the installation is complete, open the VSCode setup (Ctrl+,), search for "AutoDev".
   • Enter your AI model server address (custom LLM servers are supported) or use the default configuration.
   • Save the settings and restart the VSCode.
3. Verify Installation::
   • Open any code file, right click and select "AutoDev" menu, if the function option pops up, then the installation is successful.

IntelliJ Version Installation

1. manual download::
   • Due to copyright issues, AutoDev has been removed from the JetBrains Plugin Marketplace and users should go to the GitHub Releases page to download the latest or historical version of the .zip Documentation.
2. Installation of plug-ins::
   • Open IntelliJ IDEA and click File > Settings > Plugins(Mac for Preferences > Plugins).
   • Click the gear icon in the upper right corner and select "Install Plugin from Disk".
   • Select Downloaded .zip file, click "OK" and restart the IDE.
3. Configuration settings::
   • After rebooting, go to Settings > Tools > AutoDevThe default model is the AI server address, which is configured or the default model is enabled.
   • To test the functionality: right click in the code editor and see if the "AutoDev" option is available.

Main function operation flow

1. Automatic code generation

• procedure::
  1. Open a code file (e.g., Java's Controller class).
  2. Right click and select "AutoDev > Generate Code" or use a shortcut (not set by default, can be bound in settings).
  3. Enter the requirement in the pop-up dialog (e.g., "Generate RESTful API endpoint") and click Confirm.
  4. AutoDev generates code based on the context and inserts it at the cursor position.
• typical example: In the Spring project, type "CRUD operation to create User" and AutoDev will generate the complete code for Model, Controller, Service and Repository.
• take note of: Ensure that the file is saved and the context is sufficiently clear (e.g., importing relevant packages) to improve generation accuracy.

2. Intelligent debugging assistant

• procedure::
  1. When an error is encountered in the code (e.g. an exception is thrown), check the error code segment.
  2. Right click and select "AutoDev > Debug & Fix".
  3. AutoDev analyzes the cause of the error (e.g. NullPointerException) and displays a suggested fix in the sidebar.
  4. Click "Apply Fix" in the suggestions to apply the fix, or adjust the code manually.
• typical example: If the lack of a null check in the code causes a crash, AutoDev suggests adding a conditional judgment and generating the code.
• finesse: Providing more context (e.g., exception logs) improves the quality of fix suggestions.

3. Automated testing

• procedure::
  1. Right click on the target method and select "AutoDev > Create Unit Test".
  2. AutoDev automatically generates test files (such as JUnit test classes) and saves them to the test directory.
  3. After running the test, if it fails, you can right click again and select "AutoDev > Fix Test" to try to fix it automatically.
• typical example: for add(int a, int b) method generates tests, AutoDev creates test cases with assertions.
• take note of: Test frameworks (e.g. JUnit, PyTest) need to be configured, otherwise functionality may not be available.

4. Documentation generation

• procedure::
  1. Select the block of code (such as a class or method) for which you need to generate documentation.
  2. Right click and select "AutoDev > Generate Document".
  3. AutoDev generates comments or standalone Markdown files that are displayed in the editor.
• typical example: When a complex method is selected, AutoDev generates a comment containing a description of the parameter and a description of the function.
• customizable: Adjust document templates in settings, such as adding author information or level of detail.

5. AI Dialogues and DevIns

• AI Dialogue::
  1. Select the code, right click and select "AutoDev > Chat with AI".
  2. Type a question in the pop-up chat window (e.g., "What does this code do?") .
  3. AutoDev returns explanations or optimization suggestions that can be applied directly to the code.
• DevIns uses::
  1. newly built .devins file, enter commands such as /write:src/main/java/Test.java Followed by a code block.
  2. Save and run (right click "Run DevIns"), AutoDev will execute the command and generate the file.
• typical example: Input /write Create file and insert System.out.println("Hello");The Java file can be generated automatically.

caveat

• network requirement: Some features (e.g. AI dialog) require a connection to the server to ensure a smooth network.
• version compatibility: When downloading plug-ins, make sure they are compatible with the IDE version to avoid missing functionality.
• Community Support: If you encounter a problem, submit feedback or check for a solution on the GitHub Issues page.

By following these steps, you can quickly get started with AutoDev and take full advantage of its automation features to improve development efficiency. Whether you're generating code or debugging problems, AutoDev provides intuitive and practical support.