The JetBrains Blog
·
扩展Qodana：添加自定义代码检查
💡
原文英文，约1800词，阅读约需7分钟。
📝
内容提要
Qodana是一个静态代码分析工具，支持自定义检查以执行项目规范。通过创建插件，可以检查特定代码约定，如Kotlin类名后缀。插件开发类似于JetBrains IDE插件，需声明依赖、实现检查逻辑并生成报告。Qodana可在本地或云端运行，并支持CI/CD集成。
🎯
关键要点
- Qodana是一个静态代码分析工具，支持在持续集成中进行代码检查和快速修复。
- Qodana可以在云端运行，或通过Docker容器执行，并集成到CI/CD管道中。
- 用户可以添加自定义检查以执行项目特定的代码约定。
- 插件开发类似于JetBrains IDE插件，需要声明依赖、实现检查逻辑并生成报告。
- 创建插件的步骤包括初始化项目、调整项目属性、声明本地检查和实现逻辑。
- 需要在插件描述文件中声明Kotlin插件作为依赖。
- 代码检查的实现需要声明扩展、创建实现类和提供检查描述的HTML文件。
- 构建插件后，需要将其作为单个JAR文件或解压到特定目录中。
- 可以通过将插件的JAR文件放入项目的.qodana目录来快速集成Qodana插件。
- Qodana的配置文件需要包含自定义代码检查的引用。
- 可以在IDE中安装Qodana插件，自动启用并对Kotlin类进行检查。
- 可以通过JetBrains Marketplace发布经过测试的自定义检查插件，简化Qodana的扫描命令。
- 总结了创建Qodana插件的多种运行方式，包括作为JAR文件、IDE安装和Marketplace引用。
❓
延伸问答
Qodana是什么工具，它的主要功能是什么？
Qodana是一个静态代码分析工具，主要用于在持续集成中进行代码检查和快速修复。
如何为Qodana创建自定义代码检查插件？
创建自定义插件需要初始化项目、调整项目属性、声明依赖、实现检查逻辑并生成报告。
Qodana插件如何集成到CI/CD管道中？
Qodana可以通过Docker容器运行，并集成到CI/CD管道中，支持在云端或本地执行。
在Qodana中如何声明Kotlin插件作为依赖？
在gradle.properties文件中声明platformBundledPlugins为org.jetbrains.kotlin，并在plugin.xml中添加<depends>org.jetbrains.kotlin</depends>。
如何在IDE中安装和使用Qodana插件？
可以将Qodana插件从磁盘安装到IDE中，安装后会自动启用并对Kotlin类进行检查。
如何在JetBrains Marketplace发布Qodana插件？
需要确保插件经过测试并符合要求，然后在Qodana配置中指定公共插件标识符，便可发布到JetBrains Marketplace。
➡️
