Huawei Cloud CodeArts Check代码检查插件Huawei Cloud CodeArts Check 插件简介本插件致力于守护开发人员代码质量,成为开发人员的助手和利器。秉承极简、极速、即时看护的理念,提供业界规范(含华为云)的检查、代码风格一键格式化及代码自动修复功能。 注意事项当前有4个需要注意的事项。 1. 插件配置界面需要您这边使用华为云账号信息登录之后,才可以解锁插件配置界面。(注:不会影响插件功能的使用) 2. vscode版本要求下载 Visual Studio Code 官网(1.67.0版本以上)并安装,具体请参考安装Vscode,目前只支持windows和linux。 3. 本地安装2.1 打开 VSCode 在左侧导航栏选择“扩展”功能。 4. 自动更新插件会在每次检查的时候,对本地的资源包版本和线上环境里资源包的版本做校验;如果本地资源包版本低于线上最新版本,插件会对资源包进行自动更新。 功能介绍一、检查1. 检查并查看扫描结果1.1 单文件扫描检查在当前打开的文件代码编辑区,点击鼠标右键,选择“CodeArts Check文件检查”:
或者 在项目的资源管理器界面里,鼠标移动到需要扫描的文件,点击鼠标右键,选择“CodeArts Check文件检查”:
1.2 多文件扫描检查在项目的资源管理器里,按住ctrl键,鼠标左键选择需要扫描的几个文件;选择完毕之后,点击鼠标右键,选择“CodeArts Check文件检查”:
1.3 整个项目扫描检查在当前打开的文件代码编辑区,点击鼠标右键,选择“CodeArts Check项目检查”:
或者 在项目的资源管理器界面里,点击鼠标右键,选择“CodeArts Check项目检查”:
2. 分类/筛选查看告警详情可以按告警类型、严重级别、规范规则、文件分类筛选查看;告警帮助提供告警详细描述、严重级别、告警类型、正确示例、错误示例及修复建议 2.1 分类按钮鼠标移动到检查结果区域,会有四个按钮浮现,点击第一个“分类'按钮,根据需要选择”严重程度/文件分类/规则分类”来进行查看:
2.2 筛选按钮鼠标移动到检查结果区域,会有四个按钮浮现,点击第二个“筛选'按钮,根据需要来选择显示问题的方式: 3. 根据告警指导修改后自动检查用户在根据插件的告警指导修改后,我们的插件会自动进行检查,自动更新告警信息。如下gif动图举例,我们在修改了插件的告警提示G.OTH.03之后,插件会自动检查,自动更新告警信息:
二、一键格式化及自动修复1. 一键格式化支持直接点击一键格式化选项。支持对单文件/多文件/文件夹/整个项目进行一键格式化。 2. 自动修复针对插件扫描出来的单个问题,插件提供建议如何修复的预览界面及自动修复按钮,用户可以选择此按钮,插件会进行自动修复:
三、配置1. 登录查看CodeArts Check配置打开左侧CodeArts Check插件,点击“您尚未登录,请先登录”,使用账号的AK/SK进行登录,登录成功后点击“CodeArts Check配置”查看配置:
2. 支持配置规则的导出3. 支持扫描排除目录支持写相对代码仓的相对目录,例如:一级目录写 目录名,二级目录写 目录1名/目录2名;多个指定目录扫描,可用;号隔开,不填默认扫描整个项目的所有内容(仅在项目检查时生效):
4. 支持规则分类检索和快速设置支持规则的搜索或过滤:
支持规则的快速勾选/取消勾选:
5. 支持手动关闭/开启无感扫描支持无感扫描(扫描完成不影响用户当前作业窗口,修改保存自动扫描、结果自动刷新在问题窗口和CodeArts Check窗口),该功能可以在配置界面手动关闭。
|