suricata_check.checkers.styleguide.whitespace

WhitespaceChecker.

Classes

The WhitespaceChecker contains several checks based on the Suricata Style guide relating to formatting rules.

class suricata_check.checkers.styleguide.whitespace.WhitespaceChecker(include: collections.abc.Iterable[str] | None = None)[source]

The WhitespaceChecker contains several checks based on the Suricata Style guide relating to formatting rules.

Codes S100-S109 report on unneccessary whitespace that should be removed.

Codes S110-S119 report on missing whitespace that should be added.

Codes S120-S129 report on non-standard escaping of special characters.

Initializes the checker given a list of issue codes to emit.

codes: A Mapping of issue codes emitted by the checker to metadata for those issue types. The metadata is structured in the form of a Mapping from attribute name to attribute value. The one mandatory metadata attribute is severity, which must be one of the levels provided by the logging module