更新时间:2024-10-10 GMT+08:00

配置代码检查任务预置规则集

规则集则是一组用于做代码检查的规则组成的集合。一般根据不同的检查目标和需求,规则集也有相应的分类,比如对安全类、安卓应用、编程风格,使用这些类别进行检查的时候,规则集内的规则也会有所不同。

用户可根据实际需要更换代码检查任务使用的规则集,新启用的规则集将在下一次执行检查时生效。

代码检查服务支持多种语言的规则集,且每种语言类型对应多种不同级别的规则集,系统规则集列表请参见表1

多个编译语言的规则集不能选择一起同时检查。例如:C#语言规则集不可与其它语言规则集进行混合检查。

表1 预置规则集

语言

系统规则集类型

默认规则集

支持扫描文件后缀

C++

  • Generic Inspection Rule Set

Generic Inspection Rule Set

.c/.cc/.cpp/.cxx/.cp/.c++/.inc/.inl/.mm/.h/.hh/.hpp/.hxx/.h++

Java

  • Generic Inspection Rule Set

Generic Inspection Rule Set

.java

Go

  • Generic Inspection Rule Set

Generic Inspection Rule Set

.go

Python

  • Generic Inspection Rule Set

Generic Inspection Rule Set

.py

JavaScript

  • Generic Inspection Rule Set

Generic Inspection Rule Set

.js/.jsx

C#

  • Generic Inspection Rule Set

Generic Inspection Rule Set

.cs

TypeScript

  • Generic Inspection Rule Set

Generic Inspection Rule Set

.ts/.tsx

CSS

  • Generic Inspection Rule Set

Generic Inspection Rule Set

.css

HTML

  • Generic Inspection Rule Set

Generic Inspection Rule Set

.html

PHP

  • Generic Inspection Rule Set

Generic Inspection Rule Set

.php

LUA

通用检查规则集

通用检查规则集

.lua

RUST

通用检查规则集

通用检查规则集

.rs

Shell

通用检查规则集

通用检查规则集

.sh

KOTLIN

通用检查规则集

通用检查规则集

.kt

/

detektout

查看规则集中规则详情

用户可优先了解各个规则集中的规则详情,选择符合检查要求的规则集。可查看的规则详情包含:问题级别、正确示例、错误示例和修复建议等信息。

  1. 基于项目入口访问CodeArts Check服务首页
  2. 单击“规则集”页签,进入检查规则集列表页面。
  3. 单击规则集名称,进入到该规则集的规则详情页面可在线查看规则详情。

    您也可以单击“导出”,导出该规则集中已启用的规则到本地查看规则详情。

修改默认规则集

初次使用代码检查服务时,每种编程语言都设置一个默认的检查规则集,如表1所示。如果用户需要修改各个语言的默认检查规则集,可参考以下指导操作。

以项目入口访问代码检查服务,规则集列表中才会为每种检查语言预置默认规则集。

  1. “规则集”页面的“语言”列筛选需要配置的语言。
  2. 单击规则集所在行的,选择“默认规则集”,即可将当前的规则集设置为默认规则集。

配置代码检查任务使用的规则集

如果用户需要在代码检查任务中使用其他的预置规则集,可参考以下指导操作。如果预置规则集不满足用户的检查需求,可参考配置代码检查任务自定义规则集

  1. 进入代码检查页面,在任务列表中,单击任务名称。
  2. 进入“代码检查详情”页面,选择“设置 > 规则集”。
  3. “已包含语言”区域,打开目标语言开关。
  4. “启用规则集”区域单击,选择需要使用的规则集。

    当选中的规则集需配置扩展参数(此处以Java为例)时,单击“检查参数”,配置代码检查扩展参数并开启配置开关,完成后单击“确认”。

    用户购买了代码安全检查增强包后,使用代码安全检查增强包规则集必须设置编译脚本检查参数。