Huawei Cloud CodeArts Check代码检查插件

• Huawei Cloud CodeArts Check代码检查插件
  • Introduction of Huawei Cloud CodeArts Check Plugin
  • Precautions
    • 1. CloudIDE Online Instance
    • 2. Online Installation And Local Download
      • 2.1 Online Installation
      • 2.2 Local Download
    • 3. Automatic Update
    • 4. IDE Environments Support
  • Huawei Cloud CodeArts Check 插件简介
  • 注意事项
    • 1. 线上CloudIDE实例
    • 2. 线上安装与本地下载
      • 2.1 线上安装
      • 2.2 本地下载
    • 3. 自动更新
  • 功能介绍
    • 一、检查
      • 1. 检查并查看扫描结果
        • 1.1 单文件扫描检查
        • 1.2 多文件扫描检查
        • 1.3 整个项目扫描检查
      • 2. 分类/筛选查看告警详情
      • 2.1 分类按钮
      • 2.2 筛选按钮
      • 3. 根据告警指导修改后自动检查
    • 二、一键格式化及自动修复
      • 1. 一键格式化
      • 2. 自动修复
    • 三、配置
      • 1. 支持配置规则的导出
      • 2. 支持扫描排除目录
      • 3. 支持规则分类检索和快速设置
      • 4. 支持手动关闭/开启无感扫描

Introduction of Huawei Cloud CodeArts Check Plugin

This plugin is dedicated to safeguarding the code quality of developers and becoming an assistant and weapon for developers. Adhering to the concept of minimalism, extreme speed, and real-time care, it provides industry-standard (including Huawei Cloud) check,one-click formatting of code styles, and automatic code repair functions. Currently Supported Languages: Java, C, C++, Python.

Precautions

Here are 4 things to keep in mind:

1. CloudIDE Online Instance

If you are currently developing a Java project, use a CloudIDE instance with the Java technology stack or AllInOne:

If you are currently developing a non-Java project: C or C++ project, use the CloudIDE instance with the C/C++ technology stack or AllInOne:

2. Online Installation And Local Download

2.1 Online Installation

In the plugin details page, click Install Plugin(If no instance is available, click Create Instance), In the displayed dialog box, click Install:
If a new instance is created, you can search for CodeArts Check in the plugin market to find our plugin and click install:

Or we can find our plugin in the recommended list of the plugin market and click "install":

2.2 Local Download

In the plugin details page, click version to download the latest .vsix plugin package:
Install the plugin package in the local ide：

3. Automatic Update

During each check, the plugin will verify the local resource package version and the online resource package version; If the local resource package version is lower than the latest online version, the plugin automatically updates the resource package.
3.1 Users don't need to worry about automatic updates, the plugin will handle the download process and informs users if the update is complete.
3.2 Users don't need to worry about the plugin that cannot be used in the network disconnected environment, The plugin ensures that functions can still be used in the network disconnected environment.

4. IDE Environments Support

Currently, only Windows and Linux are supported.

Huawei Cloud CodeArts Check 插件简介

本插件致力于守护开发人员代码质量，成为开发人员的助手和利器。秉承极简、极速、即时看护的理念，提供业界规范（含华为云）的检查、代码风格一键格式化及代码自动修复功能。
当前支持语言：Java，C，C++，Python。

注意事项

当前有4个需要注意的事项。

1. 线上CloudIDE实例

如果当前您正在开发的是Java项目，请使用带Java技术栈或者AllInOne技术栈的CloudIDE实例:

如果当前您正在开发的是非Java项目：C或者C++项目，请使用带C/C++技术栈或者AllInOne技术栈的CloudIDE实例:

2. 线上安装与本地下载

2.1 线上安装

可以在插件详情页，点击安装插件按钮（如果还没有实例，先去点击创建实例），在弹出界面里点击安装按钮：
如果新建了实例，那么在创建的实例里，我们可以在插件市场里直接搜索"CodeArts Check"，找到我们的插件，点击"install"：

或者我们可以在插件市场的RECOMMENDED列表里找到我们的插件，点击"install"：

2.2 本地下载

可以在插件详情页，点击版本，点击下载最新版本的.vsix格式插件包:
然后在本地IDE编辑器里安装上插件包：

3. 自动更新

插件会在每次检查的时候，对本地的资源包版本和线上环境里资源包的版本做校验；如果本地资源包版本低于线上最新版本，插件会对资源包进行自动更新。
3.1 用户无需担心自动更新，插件会处理下载过程并告知用户更新的开始、进度与结束。
3.2 用户也无需担心断网环境下插件无法使用的情况，插件保障断网环境下功能仍可正常使用。

4. 支持IDE环境

目前只支持windows和linux。

功能介绍

一、检查

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. 一键格式化

支持直接点击一键格式化选项。支持对单文件/多文件/文件夹/整个项目进行一键格式化。
一键格式化选项帮助用户自动解决项目里基础的代码风格问题-比如多余的空格或者额外的空行。
在当前打开的文件代码编辑区或者在项目的资源管理器界面里，点击鼠标右键，选择“CodeArts Check一键格式化”（插件里的工具会先去做格式化操作，然后再对当前文件进行“CodeArts Check检查”）：

2. 自动修复

针对插件扫描出来的单个问题，插件提供建议如何修复的预览界面及自动修复按钮，用户可以选择此按钮，插件会进行自动修复：

三、配置

1. 支持配置规则的导出

2. 支持扫描排除目录

支持写代码仓的相对目录，例如：一级目录写 目录名，二级目录写 目录1名/目录2名；多个指定目录扫描，可用;号隔开，不填默认扫描整个项目的所有内容（仅在项目检查时生效）:

3. 支持规则分类检索和快速设置

支持规则的搜索或过滤：

支持规则的快速勾选/取消勾选：

4. 支持手动关闭/开启无感扫描

支持无感扫描（扫描完成不影响用户当前作业窗口，修改保存自动扫描、结果自动刷新在问题窗口和CodeArts Check窗口），该功能可以在配置界面手动关闭。