eslint/docs/src/pages/rules.md

   1 ---
   2 title: Rules
   3 layout: doc
   4 permalink: /rules/index.html
   5 eleventyNavigation:
   6     key: rules
   7     parent: user guide
   8     title: Rules
   9     order: 4
  10 ---
  11
  12 {% from 'components/rule-categories.macro.html' import ruleCategories, recommended, fixable, hasSuggestions %}
  13 {% from 'components/rule.macro.html' import rule %}
  14
  15 Rules in ESLint are grouped by type to help you understand their purpose. Each rule has emojis denoting:
  16
  17 {{ ruleCategories({
  18         index: true,
  19         recommended: true,
  20         fixable: true,
  21         hasSuggestions: true
  22 }) }}
  23
  24 {%- for type in rules.types -%}
  25
  26 <h2 id="{{ type.displayName | slugify }}"> {{ type.displayName }} </h2>
  27
  28 {{ type.description | safe }}
  29
  30     {%- for the_rule in type.rules -%}
  31     {%- if type.displayName == 'deprecated' -%}{%- set deprecated_value = true -%}{%- endif -%}
  32
  33     {%- set name_value = the_rule.name -%}
  34     {%- set description_value = the_rule.description -%}
  35     {%- set isRecommended = the_rule.recommended -%}
  36     {%- set isFixable = the_rule.fixable -%}
  37     {%- set isHasSuggestions = the_rule.hasSuggestions -%}
  38
  39     {{ rule({
  40             name: name_value,
  41             deprecated: deprecated_value,
  42             description: description_value,
  43             categories: {
  44                 recommended: isRecommended,
  45                 fixable: isFixable,
  46                 hasSuggestions: isHasSuggestions
  47             }
  48     }) }}
  49     {%- endfor -%}
  50 {%- endfor -%}
  51
  52 {%- if rules.deprecated -%}
  53
  54 <h2 id="{{ rules.deprecated.name | slugify }}">{{ rules.deprecated.name }}</h2>
  55
  56 {{ rules.deprecated.description | safe }}
  57
  58 {%- for the_rule in rules.deprecated.rules -%}
  59     {%- set name_value = the_rule.name -%}
  60     {%- set isReplacedBy = the_rule.replacedBy -%}
  61
  62     {{ rule({
  63             name: name_value,
  64             deprecated: true,
  65             replacedBy: isReplacedBy
  66     }) }}
  67 {%- endfor -%}
  68 {%- endif -%}
  69
  70 {%- if rules.removed -%}
  71
  72 <h2 id="{{ rules.removed.name | slugify }}">{{ rules.removed.name }}</h2>
  73
  74 {{ rules.removed.description | safe }}
  75
  76 {%- for the_rule in rules.removed.rules -%}
  77     {%- set name_value = the_rule.removed -%}
  78     {%- set isReplacedBy = the_rule.replacedBy -%}
  79
  80     {{ rule({
  81             name: name_value,
  82             removed: true,
  83             replacedBy: isReplacedBy
  84     }) }}
  85 {%- endfor -%}
  86 {%- endif -%}
  87
  88 {# <!-- markdownlint-disable-file MD046 --> #}