Tooling: dt-header fast follow fixes (#61805)

* Tooling: dt-header fast follow fixes

* Enable JSDoc, jakebailey is right

* Improve type annotations slightly

A little less precision globally, a little more where it's useful.

Co-authored-by: Nathan Shively-Sanders <293473+sandersn@users.noreply.github.com>

scripts/jsconfig.json

@@ -1,5 +1,5 @@
 {
-    "exclude": ["close-old-issues.js", "fix-tslint.js", "tslint-rule-to-eslint.js"],
+    "exclude": ["close-old-issues.js", "fix-tslint.js"],
     "compilerOptions": {
         "noUnusedLocals": true,
         "target": "es6",

scripts/tslint-rule-to-eslint.js

@@ -3,8 +3,13 @@ import { promises as fs } from 'fs';
 import { format } from 'prettier';
 import * as path from 'path';
 
+/** @type {any} */
 const emptyObject = {};
 
+/**
+ * @param {string} filePath
+ * @returns {Promise<any>}
+ */
 const parseAndReadFileContents = async filePath => {
     try {
         return parse((await fs.readFile(filePath)).toString());
@@ -16,6 +21,10 @@ const parseAndReadFileContents = async filePath => {
 (async () => {
     const prettierConfig = await parseAndReadFileContents('.prettierrc.json');
 
+    /**
+     * @param {string} filePath
+     * @param {unknown} contents
+     */
     const writeFileFormatted = async (filePath, contents) => {
         await fs.writeFile(
             filePath,
@@ -32,7 +41,14 @@ const parseAndReadFileContents = async filePath => {
     for (const typeName of typeNames) {
         const typeDirectory = path.join('types', typeName);
 
+        typeNames.push(
+            ...(await fs.readdir(typeDirectory))
+                .filter(childDirectory => /^(ts|v)(\d+|\.)+$/.test(childDirectory))
+                .map(childDirectory => path.join(typeName, childDirectory)),
+        );
+
         const tslintFilePath = path.join(typeDirectory, 'tslint.json');
+        /** @type {{ rules?: { [s:string]: boolean }}} */
         const tslintData = await parseAndReadFileContents(tslintFilePath);
         if (tslintData?.rules?.[tslintRuleName] !== false) {
             continue;
@@ -43,7 +59,7 @@ const parseAndReadFileContents = async filePath => {
         delete tslintData.rules[tslintRuleName];
         if (Object.keys(tslintData.rules).length === 0) {
             console.log(`\t${tslintFilePath} has no remaining rules; deleting rules property.`);
-            delete tslintFilePath.rules;
+            delete tslintData.rules;
         } else {
             console.log(`\t${tslintFilePath} has remaining rules.`);
         }

types/amplitude-js/v4/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/amplitude-js/v4/tslint.json

@@ -1,7 +1,6 @@
 {
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
-        "dt-header": false,
         "no-boolean-literal-compare": false,
         "no-consecutive-blank-lines": false,
         "no-internal-module": false,

types/bitcore-lib-cash/tslint.json

@@ -1,4 +1,3 @@
 {
-  "extends": "@definitelytyped/dtslint/dt.json",
-  "rules": {}
+  "extends": "@definitelytyped/dtslint/dt.json"
 }

types/bitcore-lib/tslint.json

@@ -1,4 +1,3 @@
 {
-  "extends": "@definitelytyped/dtslint/dt.json",
-  "rules": {}
+  "extends": "@definitelytyped/dtslint/dt.json"
 }

types/bluebird/v1/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/bluebird/v1/tslint.json

@@ -5,7 +5,6 @@
         "array-type": false,
         "ban-types": false,
         "comment-format": false,
-        "dt-header": false,
         "jsdoc-format": false,
         "max-line-length": false,
         "no-consecutive-blank-lines": false,

types/bluebird/v2/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/bluebird/v2/tslint.json

@@ -5,7 +5,6 @@
         "array-type": false,
         "ban-types": false,
         "comment-format": false,
-        "dt-header": false,
         "jsdoc-format": false,
         "max-line-length": false,
         "no-consecutive-blank-lines": false,

types/bull/v2/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/bull/v2/tslint.json

@@ -3,7 +3,6 @@
     "rules": {
         "arrow-return-shorthand": false,
         "ban-types": false,
-        "dt-header": false,
         "jsdoc-format": false,
         "no-consecutive-blank-lines": false,
         "no-padding": false,

types/chai/v2/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/chai/v2/tslint.json

@@ -3,7 +3,6 @@
     "rules": {
         "ban-types": false,
         "comment-format": false,
-        "dt-header": false,
         "no-empty-interface": false,
         "no-padding": false,
         "no-single-declare-module": false,

types/chroma-js/v0/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/chroma-js/v0/tslint.json

@@ -2,7 +2,6 @@
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
         "comment-format": false,
-        "dt-header": false,
         "no-duplicate-variable": false,
         "no-misused-new": false,
         "no-padding": false,

types/clean-css/v3/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/clean-css/v3/tslint.json

@@ -3,7 +3,6 @@
     "rules": {
         "array-type": false,
         "ban-types": false,
-        "dt-header": false,
         "max-line-length": false,
         "no-consecutive-blank-lines": false,
         "no-duplicate-variable": false,

types/color/v0/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/color/v0/tslint.json

@@ -2,7 +2,6 @@
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
         "array-type": false,
-        "dt-header": false,
         "no-duplicate-variable": false,
         "no-padding": false,
         "no-var-keyword": false,

types/d3-dsv/v0/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/d3-dsv/v0/tslint.json

@@ -1,6 +1,3 @@
 {
-    "extends": "@definitelytyped/dtslint/dt.json",
-    "rules": {
-        "dt-header": false
-    }
+    "extends": "@definitelytyped/dtslint/dt.json"
 }

types/d3kit/v1/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/d3kit/v1/tslint.json

@@ -3,7 +3,6 @@
     "rules": {
         "array-type": false,
         "ban-types": false,
-        "dt-header": false,
         "export-just-namespace": false,
         "no-any-union": false,
         "no-consecutive-blank-lines": false,

types/deasync/tslint.json

@@ -1,4 +1,3 @@
 {
-    "extends": "@definitelytyped/dtslint/dt.json",
-    "rules": {}
+    "extends": "@definitelytyped/dtslint/dt.json"
 }

types/devexpress-web/v161/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/devexpress-web/v161/tslint.json

@@ -3,7 +3,6 @@
     "rules": {
         "adjacent-overload-signatures": false,
         "ban-types": false,
-        "dt-header": false,
         "max-line-length": false,
         "no-consecutive-blank-lines": false,
         "no-duplicate-variable": false,

types/devexpress-web/v162/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/devexpress-web/v162/tslint.json

@@ -3,7 +3,6 @@
     "rules": {
         "adjacent-overload-signatures": false,
         "ban-types": false,
-        "dt-header": false,
         "max-line-length": false,
         "no-consecutive-blank-lines": false,
         "no-duplicate-variable": false,

types/devexpress-web/v171/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/devexpress-web/v171/tslint.json

@@ -3,7 +3,6 @@
     "rules": {
         "adjacent-overload-signatures": false,
         "ban-types": false,
-        "dt-header": false,
         "interface-name": false,
         "max-line-length": false,
         "no-consecutive-blank-lines": false,

types/devexpress-web/v172/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/devexpress-web/v172/tslint.json

@@ -3,7 +3,6 @@
     "rules": {
         "adjacent-overload-signatures": false,
         "ban-types": false,
-        "dt-header": false,
         "interface-name": false,
         "max-line-length": false,
         "no-consecutive-blank-lines": false,

types/devexpress-web/v181/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/devexpress-web/v181/tslint.json

@@ -3,7 +3,6 @@
     "rules": {
         "adjacent-overload-signatures": false,
         "ban-types": false,
-        "dt-header": false,
         "interface-name": false,
         "max-line-length": false,
         "no-consecutive-blank-lines": false,

types/devexpress-web/v182/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/devexpress-web/v182/tslint.json

@@ -3,7 +3,6 @@
     "rules": {
         "adjacent-overload-signatures": false,
         "ban-types": false,
-        "dt-header": false,
         "max-line-length": false,
         "no-duplicate-variable": false,
         "no-empty-interface": false,

types/devexpress-web/v191/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/devexpress-web/v191/tslint.json

@@ -2,7 +2,6 @@
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
         "ban-types": false,
-        "dt-header": false,
         "interface-name": false,
         "jsdoc-format": false,
         "max-line-length": false,

types/devexpress-web/v192/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/devexpress-web/v192/tslint.json

@@ -2,7 +2,6 @@
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
         "ban-types": false,
-        "dt-header": false,
         "interface-name": false,
         "jsdoc-format": false,
         "max-line-length": false,

types/devexpress-web/v201/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/devexpress-web/v201/tslint.json

@@ -2,7 +2,6 @@
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
         "ban-types": false,
-        "dt-header": false,
         "interface-name": false,
         "jsdoc-format": false,
         "max-line-length": false,

types/digibyte/tslint.json

@@ -1,4 +1,3 @@
 {
-  "extends": "@definitelytyped/dtslint/dt.json",
-  "rules": {}
+  "extends": "@definitelytyped/dtslint/dt.json"
 }

types/dragula/v2/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/dragula/v2/tslint.json

@@ -2,7 +2,6 @@
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
         "ban-types": false,
-        "dt-header": false,
         "no-var-keyword": false,
         "object-literal-shorthand": false,
         "only-arrow-functions": false,

types/dropzone/v4/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/dropzone/v4/tslint.json

@@ -4,7 +4,6 @@
         "adjacent-overload-signatures": false,
         "array-type": false,
         "ban-types": false,
-        "dt-header": false,
         "max-line-length": false,
         "no-padding": false,
         "no-reference-import": false,

types/durandal/v1/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/durandal/v1/tslint.json

@@ -2,7 +2,6 @@
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
         "ban-types": false,
-        "dt-header": false,
         "interface-name": false,
         "jsdoc-format": false,
         "max-line-length": false,

types/ember/v1/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/ember/v1/tslint.json

@@ -3,7 +3,6 @@
     "rules": {
         "adjacent-overload-signatures": false,
         "ban-types": false,
-        "dt-header": false,
         "jsdoc-format": false,
         "no-any-union": false,
         "no-consecutive-blank-lines": false,

types/epilogue/tslint.json

@@ -1,4 +1,3 @@
 {
-    "extends": "@definitelytyped/dtslint/dt.json",
-    "rules": {}
+    "extends": "@definitelytyped/dtslint/dt.json"
 }

types/esprima/v2/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/esprima/v2/tslint.json

@@ -2,7 +2,6 @@
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
         "array-type": false,
-        "dt-header": false,
         "export-just-namespace": false,
         "no-padding": false,
         "no-reference-import": false,

types/express-boom/tslint.json

@@ -1,4 +1,3 @@
 {
-    "extends": "@definitelytyped/dtslint/dt.json",
-    "rules": {}
+    "extends": "@definitelytyped/dtslint/dt.json"
 }

types/express-useragent/v0/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/express-useragent/v0/tslint.json

@@ -2,7 +2,6 @@
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
         "ban-types": false,
-        "dt-header": false,
         "no-single-declare-module": false,
         "no-unnecessary-type-assertion": false,
         "no-var-keyword": false,

types/frida-gum/tslint.json

@@ -1,4 +1,3 @@
 {
-    "extends": "@definitelytyped/dtslint/dt.json",
-    "rules": {}
+    "extends": "@definitelytyped/dtslint/dt.json"
 }

types/frisby/v0/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/frisby/v0/tslint.json

@@ -2,7 +2,6 @@
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
         "comment-format": false,
-        "dt-header": false,
         "no-padding": false,
         "no-var-keyword": false,
         "prefer-const": false,

types/grecaptcha/v0/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/grecaptcha/v0/tslint.json

@@ -2,7 +2,6 @@
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
         "ban-types": false,
-        "dt-header": false,
         "no-duplicate-variable": false,
         "no-unnecessary-class": false,
         "no-var-keyword": false

types/gulp/v3/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/gulp/v3/tslint.json

@@ -2,7 +2,6 @@
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
         "array-type": false,
-        "dt-header": false,
         "no-consecutive-blank-lines": false,
         "no-padding": false,
         "no-reference-import": false,

types/hammerjs/v1/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/hammerjs/v1/tslint.json

@@ -1,7 +1,6 @@
 {
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
-        "dt-header": false,
         "no-consecutive-blank-lines": false,
         "no-padding": false,
         "no-var-keyword": false,

types/hapi/v12/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/hapi/v12/tslint.json

@@ -4,7 +4,6 @@
         "array-type": false,
         "ban-types": false,
         "comment-format": false,
-        "dt-header": false,
         "interface-name": false,
         "jsdoc-format": false,
         "max-line-length": false,

types/hapi/v8/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/hapi/v8/tslint.json

@@ -4,7 +4,6 @@
         "array-type": false,
         "ban-types": false,
         "comment-format": false,
-        "dt-header": false,
         "interface-name": false,
         "jsdoc-format": false,
         "max-line-length": false,

types/hashmap/v1/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/hashmap/v1/tslint.json

@@ -1,7 +1,6 @@
 {
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
-        "dt-header": false,
         "no-consecutive-blank-lines": false,
         "no-var-keyword": false,
         "only-arrow-functions": false,

types/icepick/tslint.json

@@ -1,4 +1,3 @@
 {
-    "extends": "@definitelytyped/dtslint/dt.json",
-    "rules": {}
+    "extends": "@definitelytyped/dtslint/dt.json"
 }

types/leaflet/v0/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/leaflet/v0/tslint.json

@@ -4,7 +4,6 @@
         "adjacent-overload-signatures": false,
         "ban-types": false,
         "comment-format": false,
-        "dt-header": false,
         "interface-name": false,
         "jsdoc-format": false,
         "no-consecutive-blank-lines": false,

types/node-notifier/v5/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/node-notifier/v5/tslint.json

@@ -1,7 +1,6 @@
 {
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
-        "dt-header": false,
         "jsdoc-format": false,
         "no-consecutive-blank-lines": false,
         "no-var-keyword": false,

types/openlayers/v3/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/openlayers/v3/tslint.json

@@ -4,7 +4,6 @@
         "array-type": false,
         "ban-types": false,
         "comment-format": false,
-        "dt-header": false,
         "interface-name": false,
         "jsdoc-format": false,
         "max-line-length": false,

types/parse/v1/.eslintrc.json

@@ -1,5 +1,6 @@
 {
-  "rules": {
-      "no-const-enum": "off"
-  }
+    "rules": {
+        "no-const-enum": "off",
+        "dt-header": "off"
+    }
 }

types/parse/v1/tslint.json

@@ -5,7 +5,6 @@
         "array-type": false,
         "ban-types": false,
         "comment-format": false,
-        "dt-header": false,
         "interface-name": false,
         "jsdoc-format": false,
         "no-any-union": false,

types/postal/v0/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/postal/v0/tslint.json

@@ -3,7 +3,6 @@
     "rules": {
         "array-type": false,
         "ban-types": false,
-        "dt-header": false,
         "interface-name": false,
         "no-consecutive-blank-lines": false,
         "no-single-declare-module": false,

types/q/v0/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/q/v0/tslint.json

@@ -5,7 +5,6 @@
         "array-type": false,
         "ban-types": false,
         "comment-format": false,
-        "dt-header": false,
         "interface-name": false,
         "jsdoc-format": false,
         "max-line-length": false,

types/qunit/v1/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/qunit/v1/tslint.json

@@ -4,7 +4,6 @@
         "array-type": false,
         "ban-types": false,
         "comment-format": false,
-        "dt-header": false,
         "jsdoc-format": false,
         "no-consecutive-blank-lines": false,
         "no-padding": false,

types/rbush/v2/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/rbush/v2/tslint.json

@@ -1,7 +1,6 @@
 {
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
-        "dt-header": false,
         "interface-name": false,
         "no-single-declare-module": false,
         "no-unnecessary-generics": false,

types/react-dom/v15/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/react-dom/v15/tslint.json

@@ -1,7 +1,6 @@
 {
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
-        "dt-header": false,
         "no-unnecessary-generics": false,
         "no-unnecessary-type-assertion": false
     }

types/react-dom/v16/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/react-dom/v16/tslint.json

@@ -1,7 +1,6 @@
 {
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
-        "dt-header": false,
         "no-unnecessary-generics": false
     }
 }

types/react-dom/v17/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/react-dom/v17/tslint.json

@@ -1,7 +1,6 @@
 {
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
-        "dt-header": false,
         "no-unnecessary-generics": false
     }
 }

types/react-relay/tslint.json

@@ -1,4 +1,3 @@
 {
-    "extends": "@definitelytyped/dtslint/dt.json",
-    "rules": {}
+    "extends": "@definitelytyped/dtslint/dt.json"
 }

types/react-relay/v7/tslint.json

@@ -1,4 +1,3 @@
 {
-    "extends": "@definitelytyped/dtslint/dt.json",
-    "rules": {}
+    "extends": "@definitelytyped/dtslint/dt.json"
 }

types/react-spinkit/v1/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "dt-header": "off"
+    }
+}

types/react-spinkit/v1/tslint.json

@@ -1,7 +1,6 @@
 {
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
-        "dt-header": false,
         "strict-export-declare-modifiers": false
     }
 }