docs: add typescript template (#17500)

* docs: add typescript template * fix: formatting * chore: update docs with AndreaPontrandolfo's findings * Update no-import-assign.md * chore: update no-redeclare * fix: update TS code numbers * feat: cleanup typescript error codes * Update docs/src/_includes/layouts/doc.html Co-authored-by: Nicholas C. Zakas <[email protected]> * Update docs/src/rules/no-redeclare.md Co-authored-by: Nicholas C. Zakas <[email protected]> * Update docs/src/rules/no-import-assign.md Co-authored-by: Nicholas C. Zakas <[email protected]> * Update docs/src/rules/no-invalid-this.md Co-authored-by: Nicholas C. Zakas <[email protected]> * fix: formatting error --------- Co-authored-by: Nicholas C. Zakas <[email protected]>
eslint · Sep 1, 2023 · 032c4b1 · 032c4b1
1 parent cd7da5c
commit 032c4b1
Show file tree

Hide file tree

Showing 18 changed files with 39 additions and 6 deletions.
diff --git a/docs/src/_includes/layouts/doc.html b/docs/src/_includes/layouts/doc.html
@@ -19,6 +19,22 @@
     {% set added_version = rule_versions.added[title] %}
     {% set removed_version = rule_versions.removed[title] %}
 
+    {% if handled_by_typescript %}
+        {% set handled_by_typescript_content %}
+            <h2 id="handled_by_typescript">Handled by TypeScript</h2>
+            <p>
+                It is safe to disable this rule when using TypeScript because TypeScript's compiler enforces this check.
+            </p>
+            {% if extra_typescript_info %}
+                <p>
+                    {{ extra_typescript_info | markdown | safe }}
+                </p>
+            {% endif %}
+        {% endset %}
+
+        {% set all_content = [all_content, handled_by_typescript_content] | join %}
+    {% endif %}
+
     {% if related_rules %}
         {% set related_rules_content %}
             <h2 id="related-rules">Related Rules</h2>
@@ -48,7 +64,7 @@ <h2 id="further-reading">Further Reading</h2>
 
         {% set all_content = [all_content, further_reading_content] | join %}
     {% endif %}
-        
+
     {% if rule_meta %}
         {% set resources_content %}
             <h2 id="resources">Resources</h2>
@@ -76,7 +92,7 @@ <h1>{{ title }}</h1>
                 {% endif %}
 
                 {% include 'components/docs-toc.html' %}
-                
+
                 {{ all_content | safe }}
             </div>
 
@@ -102,6 +118,7 @@ <h1>{{ title }}</h1>
             {% include "partials/docs-footer.html" %}
         </div>
     </div>
+
     <a id="scroll-up-btn" href="#site_top">
         <svg fill="none" height="24" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" viewBox="0 0 24 24" width="24"><line x1="12" x2="12" y1="19" y2="5"/><polyline points="5 12 12 5 19 12"/></svg>
     </a>

diff --git a/docs/src/rules/constructor-super.md b/docs/src/rules/constructor-super.md
@@ -1,6 +1,7 @@
 ---
 title: constructor-super
 rule_type: problem
+handled_by_typescript: true
 ---
 
 Constructors of derived classes must call `super()`.
@@ -69,5 +70,3 @@ class A extends B {
 ## When Not To Use It
 
 If you don't want to be notified about invalid/missing `super()` callings in constructors, you can safely disable this rule.
-
-It is safe to disable this rule when using TypeScript because TypeScript's compiler enforces this check (`ts(2335) & ts(2377)`).
diff --git a/docs/src/rules/getter-return.md b/docs/src/rules/getter-return.md
@@ -1,6 +1,7 @@
 ---
 title: getter-return
 rule_type: problem
+handled_by_typescript: true
 further_reading:
 - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/get
 - https://leanpub.com/understandinges6/read/#leanpub-auto-accessor-properties

diff --git a/docs/src/rules/no-const-assign.md b/docs/src/rules/no-const-assign.md
@@ -1,6 +1,7 @@
 ---
 title: no-const-assign
 rule_type: problem
+handled_by_typescript: true
 ---
 
 

diff --git a/docs/src/rules/no-dupe-args.md b/docs/src/rules/no-dupe-args.md
@@ -1,6 +1,7 @@
 ---
 title: no-dupe-args
 rule_type: problem
+handled_by_typescript: true
 ---
 
 

diff --git a/docs/src/rules/no-dupe-class-members.md b/docs/src/rules/no-dupe-class-members.md
@@ -1,6 +1,7 @@
 ---
 title: no-dupe-class-members
 rule_type: problem
+handled_by_typescript: true
 ---
 
 
@@ -101,5 +102,3 @@ class Foo {
 This rule should not be used in ES3/5 environments.
 
 In ES2015 (ES6) or later, if you don't want to be notified about duplicate names in class members, you can safely disable this rule.
-
-It is safe to disable this rule when using TypeScript because TypeScript's compiler enforces this check (`ts(2300) & ts(2393)`).
diff --git a/docs/src/rules/no-dupe-keys.md b/docs/src/rules/no-dupe-keys.md
@@ -1,6 +1,7 @@
 ---
 title: no-dupe-keys
 rule_type: problem
+handled_by_typescript: true
 ---
 
 

diff --git a/docs/src/rules/no-func-assign.md b/docs/src/rules/no-func-assign.md
@@ -1,6 +1,7 @@
 ---
 title: no-func-assign
 rule_type: problem
+handled_by_typescript: true
 ---
 
 

diff --git a/docs/src/rules/no-import-assign.md b/docs/src/rules/no-import-assign.md
@@ -1,6 +1,8 @@
 ---
 title: no-import-assign
 rule_type: problem
+handled_by_typescript: true
+extra_typescript_info: Note that the compiler will not catch the `Object.assign()` case. Thus, if you use `Object.assign()` in your codebase, this rule will still provide some value.
 ---
 
 

diff --git a/docs/src/rules/no-invalid-this.md b/docs/src/rules/no-invalid-this.md
@@ -1,6 +1,8 @@
 ---
 title: no-invalid-this
 rule_type: suggestion
+handled_by_typescript: true
+extra_typescript_info: Note that, technically, TypeScript will only catch this if you have the `strict` or `noImplicitThis` flags enabled. These are enabled in most TypeScript projects, since they are considered to be best practice.
 ---
 
 

diff --git a/docs/src/rules/no-new-symbol.md b/docs/src/rules/no-new-symbol.md
@@ -1,6 +1,7 @@
 ---
 title: no-new-symbol
 rule_type: problem
+handled_by_typescript: true
 further_reading:
 - https://www.ecma-international.org/ecma-262/6.0/#sec-symbol-objects
 ---

diff --git a/docs/src/rules/no-obj-calls.md b/docs/src/rules/no-obj-calls.md
@@ -1,6 +1,7 @@
 ---
 title: no-obj-calls
 rule_type: problem
+handled_by_typescript: true
 further_reading:
 - https://es5.github.io/#x15.8
 ---

diff --git a/docs/src/rules/no-redeclare.md b/docs/src/rules/no-redeclare.md
@@ -1,6 +1,8 @@
 ---
 title: no-redeclare
 rule_type: suggestion
+handled_by_typescript: true
+extra_typescript_info: Note that while TypeScript will catch `let` redeclares and `const` redeclares, it will not catch `var` redeclares. Thus, if you use the legacy `var` keyword in your TypeScript codebase, this rule will still provide some value.
 related_rules:
 - no-shadow
 ---

diff --git a/docs/src/rules/no-setter-return.md b/docs/src/rules/no-setter-return.md
@@ -1,6 +1,7 @@
 ---
 title: no-setter-return
 rule_type: problem
+handled_by_typescript: true
 related_rules:
 - getter-return
 further_reading:

diff --git a/docs/src/rules/no-this-before-super.md b/docs/src/rules/no-this-before-super.md
@@ -1,6 +1,7 @@
 ---
 title: no-this-before-super
 rule_type: problem
+handled_by_typescript: true
 ---
 
 

diff --git a/docs/src/rules/no-undef.md b/docs/src/rules/no-undef.md
@@ -1,6 +1,7 @@
 ---
 title: no-undef
 rule_type: problem
+handled_by_typescript: true
 related_rules:
 - no-global-assign
 - no-redeclare

diff --git a/docs/src/rules/no-unreachable.md b/docs/src/rules/no-unreachable.md
@@ -1,6 +1,7 @@
 ---
 title: no-unreachable
 rule_type: problem
+handled_by_typescript: true
 ---
 
 

diff --git a/docs/src/rules/no-unsafe-negation.md b/docs/src/rules/no-unsafe-negation.md
@@ -1,6 +1,7 @@
 ---
 title: no-unsafe-negation
 rule_type: problem
+handled_by_typescript: true
 ---