/
doc.html
107 lines (91 loc) · 3.72 KB
/
doc.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
---
layout: base.html
---
{% include "partials/docs-header.html" %}
{% from 'components/rule-categories.macro.html' import ruleCategories %}
<div class="docs-wrapper">
<div class="docs-nav">
<div class="desktop-only">
{% include 'components/version-switcher.html' %}
</div>
{% include 'components/docs-index.html' %}
</div>
{# 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 related_rules %}
{% set related_rules_content %}
<h2 id="related-rules">Related Rules</h2>
{% related_rules related_rules %}
{% endset %}
{% set all_content = [all_content, related_rules_content] | join %}
{% endif %}
{% if added_version %}
{% set version_content %}
<h2 id="version">Version</h2>
<p>This rule was introduced in ESLint v{{added_version}}{% if removed_version%}
and removed in v{{removed_version}}{% endif %}.</p>
{% endset %}
{% set all_content = [all_content, version_content] | join %}
{% endif %}
{% if further_reading %}
{% set further_reading_content %}
<h2 id="further-reading">Further Reading</h2>
{% 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 %}
<h2 id="resources">Resources</h2>
<ul>
<li><a href="https://github.com/eslint/eslint/blob/main/lib/rules/{{ title }}.js">Rule source</a></li>
<li><a href="https://github.com/eslint/eslint/blob/main/tests/lib/rules/{{ title }}.js">Tests source</a></li>
</ul>
{% endset %}
{% set all_content = [all_content, resources_content] | join %}
{% endif %}
<div class="docs-content">
<main id="main" tabindex="-1" class="docs-main">
<div class="docs-main__content">
<h1>{{ title }}</h1>
{% if rule_meta %}
{%set id = true if (rule_meta.docs.recommended or rule_meta.fixable or rule_meta.hasSuggestions) else false %}
<p>{{ rule_meta.docs.description | markdown | safe }}</p>
{{ 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 }}
</div>
<div class="docs-edit-link">
<a href="
{% if edit_link %}
{{ edit_link }}
{% else %}
{{ site.edit_link.start_with }}{{ page.inputPath }}
{% endif %}
"
class="c-btn c-btn--secondary">{{ site.edit_link.text }}</a>
</div>
</main>
<div class="docs-aside">
<div class="docs-aside__content">
<aside class="docs-ad">
{%- include 'partials/carbon-ad.html' -%}
</aside>
{% include 'components/docs-toc.html' %}
</div>
{% include "partials/docs-footer.html" %}
</div>
</div>
</div>
<script src="{{ '/assets/js/tabs.js' | url }}"></script>