Learn how to extend Qodana with a custom JetBrains plugin that adds a Kotlin code inspection to enforce project naming conventions across CI, Docker, and the IDE.

JetBrains is a software development company known for its suite of developer tools, including integrated development environments (IDEs) such as IntelliJ IDEA, PyCharm, and WebStorm. Through its platform, JetBrains provides developers with powerful tools for coding, debugging, and collaboration, across a wide range of programming languages and frameworks. From their blog developers can learn about JetBrains' IDE features, productivity tips, and best practices for using its tools effectively to streamline their development workflows and boost productivity.

JetBrains

Qodana, JetBrains' static code analysis tool, can be extended with custom code inspections through plugins. This guide demonstrates creating an IntelliJ Platform plugin that enforces a Kotlin naming convention requiring classes in 'service' packages to have a 'Service' suffix. The process involves initializing from the plugin template, declaring dependencies (including the Kotlin plugin and K2 compiler support), implementing the inspection using AbstractKotlinInspection and PSI visitors, building the plugin as a JAR, and configuring Qodana to use it either locally via the .qodana directory or through JetBrains Marketplace. The same plugin works in both Qodana CI/CD pipelines and directly within JetBrains IDEs.

Extending Qodana: Adding Custom Code Inspections