aladdin插件开发规范有哪些?
软件: aladdin
Aladdin插件开发规范主要基于Alibaba编码规范,并结合研发中心组件使用规约,提供实时增量代码扫描、提交前拦截等功能。以下是核心规范要点:
插件注册与配置
需在plugin.xml中注册增量Inspection检查器,配置包括:
shortName(短名称):如"AladdinCodeStyleP1Incr"
displayName(全称):如"增量高危代码分析"
implementationClass(实现类):指定具体检查器类

enabledByDefault(默认启用):设置为true以自动触发扫描
增量扫描机制
支持实时增量扫描、编译时扫描、提交前扫描等模式,确保代码变动时及时检测问题
扫描规则基于Alibaba编码规范条款,覆盖60条具体规约
问题拦截与修复
在代码提交阶段拦截未修复的增量代码和第三方依赖问题,强制修复后再允许合并
提供问题描述渲染功能,将违规代码直接标注在编辑器中
扩展性与兼容性
遵循IntelliJ插件开发规范,确保与IDE深度集成
通过extensions标签配置插件扩展点,支持多语言和自定义规则扩展
集成与部署
插件需打包为JAR文件,部署至IntelliJ插件仓库或开发环境
支持手动触发全局或增量扫描,满足不同场景需求
上面规范确保插件功能完整性与兼容性,同时强化代码质量管控流程。开发时需重点参考Alibaba编码规范文档,并结合实际项目需求调整扫描规则。
插件注册与配置
需在plugin.xml中注册增量Inspection检查器,配置包括:
shortName(短名称):如"AladdinCodeStyleP1Incr"
displayName(全称):如"增量高危代码分析"
implementationClass(实现类):指定具体检查器类

enabledByDefault(默认启用):设置为true以自动触发扫描
增量扫描机制
支持实时增量扫描、编译时扫描、提交前扫描等模式,确保代码变动时及时检测问题
扫描规则基于Alibaba编码规范条款,覆盖60条具体规约
问题拦截与修复
在代码提交阶段拦截未修复的增量代码和第三方依赖问题,强制修复后再允许合并
提供问题描述渲染功能,将违规代码直接标注在编辑器中
扩展性与兼容性
遵循IntelliJ插件开发规范,确保与IDE深度集成
通过extensions标签配置插件扩展点,支持多语言和自定义规则扩展
集成与部署
插件需打包为JAR文件,部署至IntelliJ插件仓库或开发环境
支持手动触发全局或增量扫描,满足不同场景需求
上面规范确保插件功能完整性与兼容性,同时强化代码质量管控流程。开发时需重点参考Alibaba编码规范文档,并结合实际项目需求调整扫描规则。