suricata_check.checkers.styleguide.order
========================================

.. py:module:: suricata_check.checkers.styleguide.order

.. autoapi-nested-parse::

   `OrderChecker`.



Classes
-------

.. autoapisummary::

   suricata_check.checkers.styleguide.order.OrderChecker


Module Contents
---------------

.. py:class:: OrderChecker(include: Optional[collections.abc.Iterable[str]] = None)

   Bases: :py:obj:`suricata_check.checkers.interface.CheckerInterface`


   The `OrderChecker` contains several checks on the ordering Suricata options.

   Note that the correct ordering of detection options is as follows:
       1. Buffer
       2. Size
       3. Transformation
       4. Content
       5. Pointer movement
       6. Fast pattern
       7. Nocase
       8. Other payload options

   Codes S200-S209 report on the non-standard ordering of common options.

   Codes S210-S219 report on the non-standard ordering of content matches.

   Codes S220-S229 report on the non-standard ordering of flow options.

   Codes S230-S239 report on the non-standard ordering of detection options.

   Codes S240-S249 report on the non-standard ordering of threshold options.

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


   .. py:attribute:: 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