Configuring a Preset Rule Set

Constraints

• Rule sets of multiple languages cannot be used to check a task at the same time. Example: C# rule sets cannot be applied with other language rule sets to check a task.
• Preset rule sets are uneditable, while custom rule sets can be edited. If needed, you can create custom rule sets based on preset ones by referring to Customizing a Rule Set.

Viewing Preset Rule Sets

• CodeArts Check supports rule sets in multiple languages at different levels. For details about system rule sets, see Table 1.
• View the rule details in rules sets, such as issue levels, compliant and non-compliant examples, and fix suggestions, to select a desired rule set.

1. Access CodeArts Check.
2. Click the Rule Sets tab.

   By default, the check engine used by the rule is not displayed. To view the check engine, see Displaying the Check Engine.

   You can sort rule sets by Rules or Modified. The two sorting criteria are exclusive. For example, if rules are sorted by Modified, the sorting by Rules becomes invalid.

3. Click the rule set name to go to the details page and view the rule usage details.
   • Online viewing:
     Figure 1 Viewing rules in a rule set
     
   • Offline viewing: Choose > Export to export enabled rules from the rule set to your local PC.

Copying a Preset Rule Set

On the rule set list page, click next to a rule set to copy it. Copied rule sets are custom rule sets. For the constraints, see Constraints.

Viewing Tasks Using a Rule Set

1. On the rule set list page, click a rule set name. The rule set details page is displayed.
2. Choose > Task Usage to view the tasks using the rule set.
   

   When you view how many tasks are using a rule set, if the task count exceeds 10,000 and fluctuates, the count updates with a one-hour delay. However, on first view, there is no delay.

Modifying the Default Rule Set

Each language has its default set, as shown in Table 1. Perform the following operations to modify the default rule set if needed.

To view the default rule sets, access CodeArts Check through a project.

1. On the Rule Sets tab page, filter the target language in the Language column.
2. Click in the row where the rule set locates and select Default Set to set the current rule set as default.

Configuring the Rule Set to Be Used

Perform the following operations to use other preset rule sets. Alternatively, customize rule sets if needed. For details, see Configuring a Custom Rule Set.

1. Go to the task page. In the task list, click a task name.
2. On the task details page, choose Settings > Rule Sets.
3. In the Languages Included area, enable the switch of target language.
4. In the Enable Rule Set area, click to select the rule set to be used.

   To configure extended parameters for the selected rule set, click Parameter, configure extended parameters, enable the configuration function, and click Confirm.

   

   Configuration parameter description

   You can configure compilation parameters for only one language at a time. To change to another language, disable the current language first.

   Compiler Tools Options: This option is disabled by default. You need to toggle it on to enable the strict compilation mode.

   Strict Compile Mode: If this mode is enabled, code compilation failures will cause task failures. If this mode is disabled, code compilation failures do not affect task results. Note: Only the SecBrella engine is supported, and this engine supports only version-level full check.

   Build Tool: The corresponding compilation image is matched during the task execution. When you select a compilation tool, the default version and command are auto-filled. You can manually modify the parameters if necessary. When using the Go compiler, ensure proper retrieval of dependency packages for a successful build. To adjust the GOPROXY environment variables, use go env -w in your compile script.

   buildToolVersion: Select the compilation tool version supported by the extended parameters from the drop-down list.

   compileScriptCmd: The corresponding compilation command is automatically obtained after you select a compilation tool.

Preset Rule Sets

CodeArts Check has compilation tools for supported languages.

Related Documents

• For APIs about rule sets, see Rule Management.
• For details about the best practices of using preset rule sets, see Checking Code from Git with Preset Rules.