Checking your code with Code Builder

After installation and configuration the Live Check Quality extension, it enables you to assess and enhance your code using best practices from our rulesets.

Check your code with Code Builder

With this extension, you will be able to run a Live Check on the code you are working on and address any issues as necessary. 

→ To check your code

1. Go to the 'Explorer' icon and select the code you would like to run a LiveCheck.
2. Click on 'Run LiveCheck'.                    
3. Check the issues detected in the Problems section in the editor. 

Working on issues

After launching a LiveCheck scan, you will see the issues detected in the 'Problems' section. You will be able to check the following information about each issue:

• Issue type
• Issue severity: high, medium, low, warning
• Line and character number; example: Ln 1, Col 1
• Link to the docs best practice.

→ How it works?

1. For each issue, you can highlight it in the code by clicking on it from the Problems section.
2. Check issue severity and open up the best practice link included in the description.
3. Once you have finished fixing the issue, you can save the file or check again that it does not come up by running the Live check. 

Working with issues from Quality Gates

→ What is Quality Gates?

Quality Gate is a mechanism for preventing any new technical debt from coming into the platform. It helps you in creating and implementing a strategy for dealing with technical debt in your platform. When you enable a quality gate on your instance, you create a baseline of issues to work from, and you define which new issues can be created while dealing with the debt (accepted).

→ How does affect my LiveCheck scan results?

If the Quality Gates has been enabled correctly in the Admin Portal, after launching a LiveCheck scan, you will receive two messages:

1.  LiveCheck completed.
2. Quality Gates passed or Quality Gates failed.

If there are any new issues detected, the Quality Gates is alerting you and your developers that these should be fixed first by displaying the following message: 

Quality Gate does not allow code with any new issues. Make sure you solve these first.

Request write-off in Code Builder extension

The write-off functionality allows you to skip certain issues on succeeding scans so that it does not show up in the scan in question, or in any later scan, and enables the issues to be identified and flagged individually.

→ How to request a write-off?

1.  Log in to Code Builder extension. 
2. Go to the 'Explorer' icon and select the code you would like to run a LiveCheck.
3. Click on 'Run LiveCheck'.                    
4. Check the issues detected in the Problems section in the editor. 
5. Click on 'Write off menu'.
6. Add the following information:
   1. Filter the issue by severity.
   2. Select the issue you want to request a write-off.
   3. Select the reason.
   4. Select an approver. Note this box will only appear if the Quality Gates is enable. 
   5. Add a description if needed. 
7. Click on 'Request a write-off'. 

→ How to view the status of a requested write-off?

1.  Log in to Code Builder extension. 
2. Go to the 'Explorer' icon and select the code you would like to run a LiveCheck.
3. Click on 'Run LiveCheck'.                    
4. Check the issues detected in the Problems section in the editor. 
5. Click on 'Write off menu'.
6. Add the following information:
   1. Filter the issue by severity.
   2. Select the issue you want to request a write-off.
   3. Select the reason.
   4. Add a description if needed. 
7. Click on 'Request a write-off'. 
8. Go to the 'Problems' section
   1. The write-off has been approved
   2. The write-off has been requested

9. Go to the 'Write off menu' and view the requested write-offs.