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.
Optional argumentsThe list of configurable arguments accepted by this rule.
Optional categoryThe category classifying the type of issue this rule detects (e.g., security, style, performance).
Optional checksumA checksum of the rule definition used to detect changes.
Optional codeThe rule implementation code used by the static analysis engine.
Optional createdThe date and time when the rule was created.
Optional createdThe 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.
The resource identifier and type for a static analysis rule.
Optional descriptionA 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.
Optional isIndicates whether the rule is publicly published and available to all users.
Optional isIndicates whether the rule is in testing mode and not yet promoted to production.
Optional languageThe programming language this rule applies to.
Optional lastThe date and time when the rule was last modified.
Optional lastThe identifier of the user or system that last updated the rule.
Optional nameThe unique name identifying this rule within its ruleset.
Optional regexA regular expression pattern used by the rule for pattern-based detection.
Optional severityThe severity level of findings produced by this rule (e.g., ERROR, WARNING, NOTICE).
Optional shortA brief summary of what the rule detects, suitable for display in listings.
Optional shouldIndicates whether an AI-generated fix suggestion should be offered for findings from this rule.
Optional testsThe 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.
Optional typeThe 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.