{#
  This template is rendered by conf.py & Sphinx when building documentation.

  The reST comment below should land in the rendered file, to discourage people
  from editing it instead of this template.
#}

..
   Please, do not edit this file, is is rendered from lint-checks.rst.j2,
   and all your changes would be overwritten.

.. _lint-checks:

Lint Checks
==================================================================

In order to ensure that all configuration data are valid and
aligned with the specification the ``lint`` command can be used.
Below you can find the list of available checks. See the
:ref:`lint` section for more details.

{% macro emit_table(title, linters) %}
{{ title }}
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. list-table::
   :header-rows: 1

   * - Check ID
     -

{% for linter in linters %}
   * - ``{{ linter.id }}``
     - {{ linter.help }}

{% endfor %}
{% endmacro %}

{{ emit_table('Test checks', TEST_LINTERS) }}
{{ emit_table('Plan checks', PLAN_LINTERS) }}
{{ emit_table('Story checks', STORY_LINTERS) }}
{{ emit_table('Checks for all Tests, Plans and Stories', COLLECTION_LINTERS) }}