Huawei Cloud CodeArts Check

• Huawei Cloud CodeArts Check 插件简介
• 注意事项
  • 1. 插件配置界面
  • 2. vscode版本要求
  • 3. 本地安装
  • 4. 自动更新
• 功能介绍
  • 一、检查并查看扫描结果
    • 1. 检查
      • 1.1 单文件扫描检查
      • 1.2 多文件扫描检查
      • 1.3 整个项目扫描检查
      • 1.4 增量扫描检查
    • 2. 查看告警
      • 2.1 分类查看
      • 2.2 筛选查看
  • 二、一键格式化及自动修复
    • 1. 一键格式化
    • 2. 自动修复
  • 三、配置
    • 1. 登录查看CodeArts Check配置
    • 2. 支持手动关闭/开启无感扫描
    • 3. 支持配置屏蔽目录和扫描目录
    • 4. 支持规则分类检索和快速设置
    • 5. 支持规则的导入和导出

Huawei Cloud CodeArts Check 插件简介

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

注意事项

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

1. 插件配置界面

需要您这边使用华为云账号信息登录之后，才可以解锁插件配置界面。（注：不会影响插件其他功能的使用）

2. vscode版本要求

下载 Visual Studio Code 官网(1.67.0版本以上)并安装，具体请参考安装Vscode，目前只支持windows和linux。

3. 本地安装

3.1 打开 VSCode 在左侧导航栏选择“扩展”功能。
3.2 在扩展商店中搜索"Huawei Cloud CodeArts Check", 查看详情并安装。 3.3 安装成功后, 左侧边栏中会展示已安装的"Huawei Cloud CodeArts Check"插件。

4. 自动更新

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

功能介绍

一、检查并查看扫描结果

1. 检查

1.1 单文件扫描检查

在当前打开的文件代码编辑区，点击鼠标右键，选择“CodeArts Check文件检查”：

或者 在项目的资源管理器界面里，鼠标移动到需要扫描的文件，点击鼠标右键，选择“CodeArts Check文件检查”：

1.2 多文件扫描检查

在项目的资源管理器里，按住ctrl键，鼠标左键选择需要扫描的几个文件；选择完毕之后，点击鼠标右键，选择“CodeArts Check文件检查”：

1.3 整个项目扫描检查

在当前打开的文件代码编辑区，点击鼠标右键，选择“CodeArts Check项目检查”：

或者 在项目的资源管理器界面里，点击鼠标右键，选择“CodeArts Check项目检查”：

1.4 增量扫描检查

在当前打开的文件代码编辑区，点击鼠标右键，选择“CodeArts Check增量检查”（前提：当前打开的是标准的git工程）：

或者 在项目的资源管理器界面里，点击鼠标右键，选择“CodeArts Check增量检查”（前提：当前打开的是标准的git工程）：

2. 查看告警

可以按严重级别、规范规则、文件分类查看和告警类型筛选；告警帮助提供告警详细描述、严重级别、告警类型、正确示例、错误示例及修复建议。

2.1 分类查看

鼠标移动到检查结果区域，会有四个按钮浮现，点击第一个“分类'按钮，根据需要选择”严重程度/文件分类/规则分类”来进行查看：

2.2 筛选查看

鼠标移动到检查结果区域，会有四个按钮浮现，点击第二个“筛选'按钮，根据需要来选择显示问题的方式：

二、一键格式化及自动修复

1. 一键格式化

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

2. 自动修复

针对插件扫描出来的单个问题，插件提供建议如何修复的预览界面及自动修复按钮，用户在根据插件的告警指导修改后，我们的插件会自动进行检查，自动更新告警信息，如下gif动图举例，我们在修改了插件的告警提示G.OTH.03之后，插件会自动检查，自动更新告警信息：

三、配置

1. 登录查看CodeArts Check配置

打开左侧CodeArts Check插件，点击“您尚未登录，请先登录”，使用华为云账号或者AK/SK的方式进行登录，登录成功后点击“CodeArts Check配置”查看配置：

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

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

3. 支持配置屏蔽目录和扫描目录

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

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

支持规则的搜索或过滤：

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

5. 支持规则的导入和导出

支持规则端对端导入：

支持导出已应用激活的规则：

• Introduction of Huawei Cloud CodeArts Check Plugin
• Precautions
  • 1. Plugin Configuration Page
  • 2. Version Requirements Of Vscode
  • 3. Installation
  • 4. Automatic Update
• Functions
  • Section 1. Checking and viewing result
    • 1. Checking
      • 1.1 Checking one file
      • 1.2 Checking multiple files
      • 1.3 Checking the entire project
      • 1.4 Incremental check
    • 2. Viewing defects
      • 2.1 Viewing defects by category
      • 2.2 Filtering defects by defect type
  • Section 2. One-Click Formatting and Automatic Fix
    • 1. One-click formatting
    • 2. Automatic fix
  • Section 3. Configuring
    • 1. Logging to the CodeArts Check plug-in
    • 2. Manually turn off/on insensible scanning
    • 3. Scan and exclude directories configuration
    • 4. Searching for rules by category and setting rules
    • 5. Importing and exporting rules

Introduction of Huawei Cloud CodeArts Check Plugin

The plug-in is a powerful assistant for developers to protect the code quality. It provides industry standard check, one-click code style formatting, and automatic code fixing, adhering to the concepts of simplicity, high speed, and real-time monitoring. Currently, it supports Java, C, C++, Python, and ArkTs.

Precautions

There are 4 things to look out:

1. Plugin Configuration Page

To configure the plug-in, log in to the plug-in using your Huawei Cloud account. (Note: Other functions of the plug-in can be used without login).

2. Version Requirements Of Vscode

Download the Visual Studio Code official website ((later than 1.67.0) and install it, for details, see vscode installation guide. Currently, only Windows and Linux are supported.

3. Installation

3.1 Open Visual Studio Code and click the extension icon from the navigation pane on the left.

3.2 Search for "Huawei Cloud CodeArts Check" in the extension marketplace, view details, and install it.

3.3 After the installation is successful, the installed plug-in is displayed in the left pane.

4. Automatic Update

The plug-in verifies both the local and online resource package versions during open the window. If the local version is outdated, the plug-in will automatically update it.

4.1 It handles the download process and keeps users informed about the update's start, progress, and completion.

4.2 It remains available when the network is disconnecte.

Functions

Section 1. Checking and viewing results

1. Checking

1.1 Checking one file

In the editor area, right-click and click "File Check with CodeArts Check":

Alternatively, in the Project window, right-click the file to be checked and click "File Check with CodeArts Check":

1.2 Checking multiple files

In the Project window, hold down Ctrl and select multiple files. Then, right-click and click "File Check with CodeArts Check":

1.3 Checking the entire project

In the editor area, right-click and click "Project Check with CodeArts Check":

Alternatively, in the Project window, right-click the file and click "Project Check with CodeArts Check":

1.4 Incremental check

In the editor area, right-click and click "Incremental Check with CodeArts Check" (Prerequisite: A standard git project is opened):

Alternatively, in the Project window, right-click the file and click "Incremental Check with CodeArts Check" (Prerequisite: A standard git project is opened):

2. Viewing defects

Viewing defect details, severity, type, compliant example, non-compliant example, and fixing suggestion by severity, rule, file, and defect type.

2.1 Viewing defects by category

In the Defects area, click the first button on the left, and viewing defects by severity, rule, and file to view details:

2.2 Filtering defects by defect type

In the Defects area, click the second button on the left, and filter defects as needed:

Section 2. One-Click Formatting and Automatic Fix

1. One-click formatting

Easily format one file, multiple files, a folder, or an entire project with just one click. With one-click formatting, you can easily resolve common code specification issues in your project, such as extra spaces or blank lines.
In the editor area or in the Project window, right-click and click "Auto Format with CodeArts Check". Then, the plug-in formats the file and checks the current file:

2. Automatic fix

The plug-in provides a preview window with fix suggestions and the automatic fix function:

Section 3. Configuring

1. Logging to the CodeArts Check plug-in

Open the CodeArts Check plug-in on the left, click "You are not logged in, please log in first", and use a Huawei Cloud account or AK/SK to log in. After the login is successful, click "CodeArts Check Configuration" to view the configuration:

2. Manually turn off/on insensible scanning

Automatic check does not affect the current window. Once you modify and save the code, the latest check results will be automatically updated in the Defects window and the CodeArts Check window. This function can be manually disabled on the configuration page:

3. Scan and exclude directories configuration

Specify multiple directories by separating them with commas (,). To check the dir1 directory, enter dir1. To check dir2 in the dir1 directory, enter dir1/dir2. If no directory is specified, all content of the entire project is checked by default. (This parameter is valid only during "Project Check with CodeArts Check" is used):

4. Searching for rules by category and setting rules

Search for or filter rules:

Enable or disable rules:

5. Importing and exporting rules

End-to-End import rules:

Exporting rules that have been applied and activated: