Create a linter check
Create a linter check to identify any issues in a script. When a linter check is run on a record, an abstract syntax tree for its code is generated. You can use the abstract syntax tree to analyze issues with the code.
Before you begin
Role required: scan_admin.
Before performing this task you must complete [Create a check](hs-create-health-check.md).
Procedure
Select Create a new Linter Check.
On the form, fill in the fields.
| Fields | Description |
|---|---|
| Name | Name of the check record. |
| Application | Application that has the check record. |
| Category | Category of the check record. |
| Priority | Priority at which the findings should be resolved. |
| Version | Current version of the check record.Note: If you want to update an already existing check, the Version field increments itself. |
| Active | Option to activate this check record. |
| Short Description | Mandatory description about the check records. |
| Description | Additional information about the check records. |
| Resolution Details | Guideline to avoid check to go off against one or more tables. |
| Documentation URL | Documentation link for the check details.Note: A scan_user can't edit the Documentation URL field. |
| Run Condition | Boolean field that determines if the check should be run. |
| Script | The script that executes against each record that matches the condition. By default, this field has an engine object to use. This engine object contains other objects like engine.finding which you can call engine.finding.increment() to manually increment the Count field on that specific finding. Another object is engine.current which is the current GlideRecord that the check would be viewing when running.Note: This is new to Quebec release, where previously you would call finding and current directly. |
- Advanced linter check scripts
Linter check scripts helps you in writing checks that look for issues in scripts. When a linter check is run on a record, it provides an abstract syntax tree for its code. You can use this abstract syntax tree to analyze issues with the code such as too many nested if statements or usages of slow API in a while loop.
Parent Topic:Create a check