--- layout: base.html --- {% include "partials/docs-header.html" %} {% from 'components/rule-categories.macro.html' import ruleCategories %}
{% include 'components/version-switcher.html' %}
{% include 'components/docs-index.html' %}
{# Add in various sections to content so TOC is accurate #} {% set all_content = content %} {% set rule_meta = rules_meta[title] %} {% set added_version = rule_versions.added[title] %} {% set removed_version = rule_versions.removed[title] %} {% if handled_by_typescript %} {% set handled_by_typescript_content %}

Handled by TypeScript

It is safe to disable this rule when using TypeScript because TypeScript's compiler enforces this check.

{% if extra_typescript_info %}

{{ extra_typescript_info | markdown | safe }}

{% endif %} {% endset %} {% set all_content = [all_content, handled_by_typescript_content] | join %} {% endif %} {% if related_rules %} {% set related_rules_content %} {% related_rules related_rules %} {% endset %} {% set all_content = [all_content, related_rules_content] | join %} {% endif %} {% if added_version %} {% set version_content %}

Version

This rule was introduced in ESLint v{{added_version}}{% if removed_version%} and removed in v{{removed_version}}{% endif %}.

{% endset %} {% set all_content = [all_content, version_content] | join %} {% endif %} {% if further_reading %} {% set further_reading_content %}

Further Reading

{% for url in further_reading %} {% link url %} {% endfor %} {% endset %} {% set all_content = [all_content, further_reading_content] | join %} {% endif %} {% if rule_meta %} {% set resources_content %}

Resources

{% endset %} {% set all_content = [all_content, resources_content] | join %} {% endif %}

{{ title }}

{% if rule_meta %} {%set id = true if (rule_meta.docs.recommended or rule_meta.fixable or rule_meta.hasSuggestions) else false %}

{{ rule_meta.docs.description | markdown | safe }}

{{ ruleCategories({ index: id, recommended: rule_meta.docs.recommended, fixable: rule_meta.fixable, hasSuggestions: rule_meta.hasSuggestions }) }} {% endif %} {% include 'components/docs-toc.html' %} {{ all_content | safe }}
{% include 'components/docs-toc.html' %}
{% include "partials/docs-footer.html" %}