Class AnalysisRequestRule

A static analysis rule to apply during code analysis.

Hierarchy

  • AnalysisRequestRule

Constructors

constructor

Properties

additionalProperties? category checksum code entityChecked? id language regex? severity treeSitterQuery type

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

category

category: string

The category of the rule (for example, BEST_PRACTICES, SECURITY).

checksum

checksum: string

A checksum of the rule definition.

code

code: string

The base64-encoded rule implementation code.

Optional entityChecked

entityChecked?: string

The code entity type checked by the rule, applicable when rule type is AST_CHECK.

id

id: string

The unique identifier of the rule.

language

language: string

The programming language this rule targets.

Optional regex

regex?: string

A base64-encoded regex pattern used by the rule, applicable when rule type is REGEX.

severity

severity: string

The severity of findings from this rule (for example, ERROR, WARNING).

treeSitterQuery

treeSitterQuery: string

The base64-encoded tree-sitter query used by the rule.

type

type: string

The rule type indicating the detection mechanism (for example, TREE_SITTER_QUERY).

Settings

Member Visibility

Theme

Generated using TypeDoc