An open API service indexing awesome lists of open source software.

https://github.com/xdev-software/intellij-plugin-pmd

A plugin for IntelliJ that provides code analysis and highlighting with PMD
https://github.com/xdev-software/intellij-plugin-pmd

code-analysis intellij-plugin intelllij java jetbrains pmd

Last synced: 26 days ago
JSON representation

A plugin for IntelliJ that provides code analysis and highlighting with PMD

Awesome Lists containing this project

README

          

[![Latest version](https://img.shields.io/jetbrains/plugin/v/28935?logo=jetbrains)](https://plugins.jetbrains.com/plugin/28935)
[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/intellij-plugin-pmd/check-build.yml?branch=develop)](https://github.com/xdev-software/intellij-plugin-pmd/actions/workflows/check-build.yml?query=branch%3Adevelop)
[![Feel free to leave a rating](https://img.shields.io/jetbrains/plugin/r/rating/28935?style=social&logo=jetbrains&label=Feel%20free%20to%20leave%20a%20rating)](https://plugins.jetbrains.com/plugin/28935/reviews)

# Plugin icon PMD X

A plugin for IntelliJ that provides code analysis and highlighting with PMD - an extensible cross-language static code analyzer.

## Features
* Optimized for real-time analysis and zero configuration project setups that just require you to checkout the code
* Real-time analysis and highlighting of currently edited file
* Run bulk analysis of files by right clicking the project menu


* Currently Java and Kotlin are supported, Language versions are automatically detected

## Usage
1. Install the plugin and open a project
2. Configure PMD for the project (`Settings > Tools > PMD`)

* If there is already a project configuration file (`.idea/pmd-x.xml`) present this will be done automatically
3. Open a supported file
4. You should see the problems being automatically highlighted in the file and find more details in the PMD tool window

## Installation
[Installation guide for the latest release](https://github.com/xdev-software/intellij-plugin-pmd/releases/latest#Installation)

> [!TIP]
> [Development versions](https://plugins.jetbrains.com/plugin/28935/versions/snapshot) can be installed by [adding the ``snapshot`` release channel as a plugin repository](https://www.jetbrains.com/help/idea/managing-plugins.html#repos):

> ``https://plugins.jetbrains.com/plugins/snapshot/list``

## Contributing
See the [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to get started with our project.

## Acknowledgment
This plugin was inspired by existing plugin like [CheckStyle-IDEA](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea), [Sonarlint](https://plugins.jetbrains.com/plugin/7973-sonarqube-for-ide) and "[PMD](https://plugins.jetbrains.com/plugin/1137-pmd)".
Please have a look at [`THIRD-PARTY-CREDITS`](./THIRD-PARTY-CREDITS.md) for more details.

Disclaimer: This is not an official PMD project and not associated