Rules Reference - Eslint

{% from 'components/rule-categories.macro.html' import ruleCategories, recommended, fixable, hasSuggestions %} {% from 'components/rule.macro.html' import rule %}

Rules in ESLint are grouped by type to help you understand their purpose. Each rule has emojis denoting:

{{ ruleCategories({ index: true, recommended: true, fixable: true, frozen: true, hasSuggestions: true }) }}

{%- for type, content in rules.types -%}

<h2 id="{{ rules_categories[type].displayName | slugify }}"> {{ rules_categories[type].displayName }} </h2>

{%- for the_rule in content -%}

{%- if rules_categories[type].displayName == 'deprecated' -%}
{%- set deprecated_value = true -%}
{%- endif -%}

{%- set name_value = the_rule.name -%}
{%- set description_value = the_rule.description -%}
{%- set isRecommended = the_rule.recommended -%}
{%- set isFrozen = the_rule.frozen -%}
{%- set isFixable = the_rule.fixable -%}
{%- set isHasSuggestions = the_rule.hasSuggestions -%}

{{ rule({
        name: name_value,
        deprecated: deprecated_value,
        description: description_value,
        categories: {
            recommended: isRecommended,
            fixable: isFixable,
            frozen: isFrozen,
            hasSuggestions: isHasSuggestions
        }
}) }}
{%- endfor -%}

{%- endfor -%}

{%- if rules.deprecated -%}

<h2 id="{{ rules_categories.deprecated.displayName | slugify }}">{{ rules_categories.deprecated.displayName }}</h2>

{%- for the_rule in rules.deprecated -%} {%- set name_value = the_rule.name -%} {%- set isReplacedBy = the_rule.replacedBy -%} {%- set isRecommended = the_rule.recommended -%} {%- set isFixable = the_rule.fixable -%} {%- set isHasSuggestions = the_rule.hasSuggestions -%}

{{ rule({
        name: name_value,
        deprecated: true,
        replacedBy: isReplacedBy,
        categories: {
            recommended: isRecommended,
            fixable: isFixable,
            hasSuggestions: isHasSuggestions
        }
}) }}

{%- endfor -%} {%- endif -%}

{%- if rules.removed -%}

<h2 id="{{ rules_categories.removed.displayName | slugify }}">{{ rules_categories.removed.displayName }}</h2>

{%- for the_rule in rules.removed -%} {%- set name_value = the_rule.removed -%} {%- set isReplacedBy = the_rule.replacedBy -%}

{{ rule({
        name: name_value,
        removed: true,
        replacedBy: isReplacedBy
}) }}

{%- endfor -%} {%- endif -%}

{#  #}