Temp disable eslint-comments/require-description

Re-enable in a follow-up PR.
starbeamjs · Sep 27, 2023 · 0e9086e · 0e9086e
1 parent 8a4c3bf
commit 0e9086e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/workspace/@domtree/minimal/index.ts b/workspace/@domtree/minimal/index.ts
@@ -12,7 +12,11 @@ export type XmlnsNamespace = "http://www.w3.org/2000/xmlns/";
 
 export type AttributeNamespace = XlinkNamespace | XmlNamespace | XmlnsNamespace;
 
-// eslint-disable-next-line @typescript-eslint/no-namespace
+/*
+  eslint-disable-next-line @typescript-eslint/no-namespace
+  -- using a namespace to map onto the `Node.*` JavaScript API (so that
+  you can use `Node.TEXT_NODE` as a type and not `Node["TEXT_NODE"]`)
+*/
 export namespace Node {
   export type ELEMENT_NODE = 1;
   export type ATTRIBUTE_NODE = 2;
@@ -76,7 +80,7 @@ export interface Document extends ReadonlyParent {
   createElementNS: (
     ns: ElementNamespace,
     qualifiedName: string,
-    options?: { is: string }
+    options?: { is: string },
   ) => Element;
 
   createRange: () => LiveRange;
@@ -114,7 +118,7 @@ interface MutableElement extends Element, MutableParent, MutableChild {
   setAttributeNS: (
     namespace: AttributeNamespace | null,
     qualifiedName: string,
-    value: string
+    value: string,
   ) => void;
 
   set innerHTML(html: string);

diff --git a/workspace/eslint/src/base.js b/workspace/eslint/src/base.js
@@ -138,7 +138,7 @@ exports.rules = {
   ...TYPED_RULES,
   "eslint-comments/no-unused-disable": "error",
   "eslint-comments/require-description": [
-    "error",
+    "off", // enable in a subsequent PR
     { ignore: ["eslint-enable"] },
   ],
   "eslint-comments/disable-enable-pair": ["error", { allowWholeFile: true }],