Merge branch 'develop' into update-from-template-github_com_xdev-software_intellij-plugin-template_master-merged

Author: xdev-gh-bot

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: pmd
+open_collective: pmd

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -15,9 +15,9 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I am able to reproduce the bug with the [latest version](https://github.com/xdev-software/template-placeholder/releases/latest)"
+        - label: "I am able to reproduce the bug with the [latest version](https://github.com/xdev-software/intellij-plugin-pmd/releases/latest)"
           required: true
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/intellij-plugin-pmd/issues) or [closed](https://github.com/xdev-software/intellij-plugin-pmd/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the bug report will be dismissed otherwise."
           required: true

.github/ISSUE_TEMPLATE/enhancement.yml

@@ -13,7 +13,7 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/intellij-plugin-pmd/issues) or [closed](https://github.com/xdev-software/intellij-plugin-pmd/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the feature request will be dismissed otherwise."
           required: true

.github/ISSUE_TEMPLATE/question.yml

@@ -12,7 +12,7 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/intellij-plugin-pmd/issues) or [closed](https://github.com/xdev-software/intellij-plugin-pmd/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the question will be dismissed otherwise."
           required: true

CHANGELOG.md

@@ -0,0 +1,31 @@
+# 1.0.8
+* Correctly handle missing/removal of built-in configuration
+* Fix crash on non Java-IDEs #67
+
+# 1.0.7
+* Update PMD to 7.23.0
+
+# 1.0.6
+* Correctly handle control flow exceptions in "doAnnotate"
+
+# 1.0.5
+* Update PMD to 7.22.0
+
+# 1.0.4
+* Update PMD to 7.21.0
+
+# 1.0.3
+* Update PMD to 7.20.0
+
+# 1.0.2
+* Update PMD to 7.19.0
+
+# 1.0.1
+* Workaround inaccurate analysis due to outdated classpath #6
+* Add some additional details why an analysis was not executed
+
+# 1.0.0
+_Initial release_
+
+* Bundled PMD version: 7.18.0
+* Support for Java and Kotlin

CONTRIBUTING.md

@@ -46,17 +46,17 @@ Start idea and import the `build.gradle` file with "File > Open". Then in the "I
 ./gradlew cleanIdea idea
 ```
 
-IntelliJ should refresh and the project is now configured as a gradle project. You can find IntelliJ gradle tasks in "Gradle > Gradle projects > template-placeholder > Tasks > intellij". To run the plugin, use the `runIde` task:
+IntelliJ should refresh and the project is now configured as a gradle project. You can find IntelliJ gradle tasks in "Gradle > Gradle projects > intellij-plugin-pmd > Tasks > intellij". To run the plugin, use the `runIde` task:
 
 ```bash
 # Run the plugin (starts new idea)
 ./gradlew runIde
 ```
 
-## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/template-placeholder/release.yml?branch=master)](https://github.com/xdev-software/template-placeholder/actions/workflows/release.yml)
+## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/intellij-plugin-pmd/release.yml?branch=master)](https://github.com/xdev-software/intellij-plugin-pmd/actions/workflows/release.yml)
 
 Before releasing:
-* Consider doing a [test-deployment](https://github.com/xdev-software/template-placeholder/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
+* Consider doing a [test-deployment](https://github.com/xdev-software/intellij-plugin-pmd/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
 * Check the [changelog](CHANGELOG.md)
 
 If the ``develop`` is ready for release, create a pull request to the ``master``-Branch and merge the changes

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2024 XDEV Software
+   Copyright 2025 XDEV Software
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -1,17 +1,36 @@
-[![Latest version](https://img.shields.io/jetbrains/plugin/v/pluginId?logo=jetbrains)](https://plugins.jetbrains.com/plugin/pluginId)
-[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/template-placeholder/check-build.yml?branch=develop)](https://github.com/xdev-software/template-placeholder/actions/workflows/check-build.yml?query=branch%3Adevelop)
-[![Feel free to leave a rating](https://img.shields.io/jetbrains/plugin/r/rating/pluginId?style=social&logo=jetbrains&label=Feel%20free%20to%20leave%20a%20rating)](https://plugins.jetbrains.com/plugin/pluginId/reviews)
+[![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)
 
-# <img alt="Plugin icon" src="./src/main/resources/META-INF/pluginIcon.svg" width="30"> template-placeholder
+# <img alt="Plugin icon" src="./src/main/resources/META-INF/pluginIcon.svg" width="30"> PMD X
 
+A plugin for IntelliJ that provides code analysis and highlighting with <a href="https://pmd.github.io">PMD</a> - 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 <br/> <img src="./assets/run-bulk-analysis.avif"> <br/> <img src="./assets/toolwindow-report.avif">
+* 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`) <br/><img height=500 src="./assets/project-configuration.avif">
+    * 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 <br/> <img src="./assets/annotator.avif"> <br/> <img src="./assets/toolwindow-current-file.avif">
 
 ## Installation
-[Installation guide for the latest release](https://github.com/xdev-software/template-placeholder/releases/latest#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/pluginId/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):<br/>
+> [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):<br/>
 > ``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.
+
+<sub>Disclaimer: This is not an official PMD project and not associated</sub>

SECURITY.md

@@ -2,4 +2,4 @@
 
 ## Reporting a Vulnerability
 
-Please report a security vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/template-placeholder/security/advisories/new).
+Please report a security vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/intellij-plugin-pmd/security/advisories/new).