Dextorm Plugin

This VS Code plugin is designed to integrate analysis results generated by Dextorm, an open-source code analysis tool. It allows you to visualize the commits associated with each line of code in a Java file, as well as the links to corresponding GitHub issues.

Features

• Displays the commits associated with each line of code in a Java file.
• Shows authors and messages for each commit.
• Provides links to GitHub issues associated with the commits.
• Allows you to navigate directly to the corresponding code lines in the editor.

Configuration

Before using this plugin, make sure to complete the following steps:

1. Ensure that you have installed Dextorm and configured the analysis options according to your needs.

2. Make sure to configure the dextorm_config.yaml file with the appropriate parameters. This file should be located at the root of your VS Code workspace.

3. Make sure to have the dextorm_result.yaml file at the root of your VS Code workspace.

4. Ensure that you have the required extensions installed:

   • Java Parser: Allows parsing of Java code.
   • Simple Git: Enables interacting with Git to retrieve commit information.

Usage

Once you have properly configured the plugin, you can use it as follows:

1. Open a Java file in the VS Code editor.

2. The plugin will automatically display the commits associated with each line of code in the file. You will see colored decorations on the corresponding code lines.

3. Hover over a decorated line of code to display commit details, such as authors, messages, and links to associated GitHub issues.

4. Click on a GitHub issue link to open the issue in your default browser.

5. You can also use the Dextorm: Open Commits Panel command in the command palette to open the side panel displaying all associated commits.

Additional Commands

This extension also provides the following additional commands:

• Dextorm: Disable Decoration: This command disables the commit decorations. You can use it if you want to temporarily hide the commit information. When decorations are disabled, a message indicating this will be displayed in the VS Code status bar.

• Dextorm: Enable Decoration: If you have previously disabled the decorations, you can use this command to enable them again. When decorations are enabled, a message indicating this will be displayed in the VS Code status bar.

• Dextorm: Update Result: This command forces an update of the Dextorm analysis results. Use it when you have made changes to the code and want to see the updated commit information.

You can execute these commands from the Command Palette (Ctrl+Shift+P or Cmd+Shift+P on Mac), or you can assign them to keybindings of your choice.

Contribution

Any contribution to this plugin is welcome! If you would like to contribute, please follow these steps:

1. Fork the repository.

2. Create a branch for your feature or bug fix.

3. Make your changes and test them locally.

4. Submit a pull request with a clear description of your modifications.

Known Issues

• Analysis results can be slow for large projects or files with a large number of commits. This is due to the time required to analyze and display the information.

• Some files or projects may not be supported by the plugin due to specific configurations or technical limitations.

If you encounter any issues or have suggestions for improvement, please report them in the GitHub repository's issue section.

License

This plugin is distributed under the GNU GENERAL PUBLIC LICENSE License.