Optional additionalA container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.
The list of configurable arguments accepted by this rule.
The category classifying the type of issue this rule detects (e.g., security, style, performance).
A checksum of the rule definition used to detect changes.
The rule implementation code used by the static analysis engine.
The date and time when the rule was created.
The identifier of the user or system that created the rule.
Optional cveThe CVE identifier associated with the vulnerability this rule detects, if applicable.
Optional cweThe CWE identifier associated with the weakness category this rule detects, if applicable.
A detailed explanation of what the rule detects and why it matters.
Optional documentationA URL pointing to additional documentation for this rule.
Optional entityThe code entity type (e.g., function, class, variable) that this rule inspects.
The unique identifier of the rule, which is the same as its name.
Indicates whether the rule is publicly published and available to all users.
Indicates whether the rule is in testing mode and not yet promoted to production.
The programming language this rule applies to.
The date and time when the rule was last modified.
The identifier of the user or system that last updated the rule.
The unique name identifying this rule within its ruleset.
Optional regexA regular expression pattern used by the rule for pattern-based detection.
The severity level of findings produced by this rule (e.g., ERROR, WARNING, NOTICE).
A brief summary of what the rule detects, suitable for display in listings.
Indicates whether an AI-generated fix suggestion should be offered for findings from this rule.
The list of test cases used to validate the rule's behavior.
Optional treeThe Tree-sitter query expression used by the rule to match code patterns in the AST.
The rule type indicating the detection mechanism used (e.g., tree_sitter, regex).
Generated using TypeDoc
A static analysis rule within a ruleset, including its definition, metadata, and associated test cases.