Step 4: Checking Code

Updated on 2024-11-18 GMT+08:00

View PDF

CodeArts Check provides cloud-based code quality management, static code check (quality and style), security check, issue fixing suggestions, and trend analysis.

As Phoenix Mall becomes increasingly larger, more issues have occurred, involving high fixing costs. However, no unified coding standards are available. The project manager suggests some basic standards, continuous static code scanning, and issue fixing within sprints.

This section describes how developer Chris scans static code and identify and fix issues for different technology stacks.

Introduction to Preset Tasks

The sample project has four preset code check tasks.

**Table 1** Preset tasks
Preset Task	Description
phoenix-codecheck-worker	Checks the Worker function code.
phoenix-codecheck-result	Checks the Result function code.
phoenix-codecheck-vote	Checks the Vote function code.
phoenix-sample-javas	Checks the JavaScript code of the entire code repository.

This section uses the phoenix-codecheck-worker task as an example.

Configuring and Executing a Task

For comprehensive checks, developers can add some simple configurations (for example, a Python check rule set) to the preset code check task.

Edit a task.
1. Go to the Phoenix Mall project and choose Code > Check. The preset four tasks are displayed.
2. Find the phoenix-codecheck-worker task in the list.
3. Click the task name to go to the details page and click the Settings tab.
4. In the navigation pane, choose Rule Sets. The default language of a rule set is Java.
5. Add the Python language check rule set.
  1. Click next to Languages Included to refresh the language list.
    NOTE:
    
    If Python is displayed on the page, skip this step.
  2. Click to enable the Python language.
Execute the task.
1. Click Start Check to start the task.
2. If is displayed, the task is successfully executed.
  If the task fails, check and fix errors based on the message displayed on the page.

Viewing the Code Check Result

CodeArts Check collects check results and provides fix suggestions for detected issues. Optimize the project code based on the suggestions.

On the task details page, click the Overview tab to view the result statistics.
Click the Issues tab to view the issue list.

Click Help in the question box to view fix suggestions. You can find the corresponding file and code location in the code repository as required and optimize the code based on the fix suggestions.

Figure 1 Viewing help information