Tooling: migrated dt-header to ESLint, with a script (DefinitelyTyped…

…#61793)

* Tooling: migrated dt-header to ESLint, with a script

* Update scripts/tslint-rule-to-eslint.js

Co-authored-by: Nathan Shively-Sanders <[email protected]>

* Fix up logging a bit

* Add mistakenly deleted tslint.jsons

* Manual fixup of */v* dt-header overrides

Co-authored-by: Nathan Shively-Sanders <[email protected]>

.eslintrc.json

@@ -7,6 +7,7 @@
         "@typescript-eslint"
     ],
     "rules": {
+      "dt-header": "error",
       "no-dead-reference": "error",
       "no-const-enum": "error"
     }

package.json

@@ -31,6 +31,7 @@
         "@definitelytyped/utils": "latest",
         "@octokit/core": "^3.5.1",
         "@octokit/rest": "^16.0.0",
+        "comment-json": "^4.2.3",
         "d3-array": "^3.0.2",
         "d3-axis": "^3.0.0",
         "d3-scale": "^4.0.0",

scripts/jsconfig.json

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

scripts/tslint-rule-to-eslint.js

@@ -0,0 +1,69 @@
+import { parse } from 'comment-json';
+import { promises as fs } from 'fs';
+import { format } from 'prettier';
+import * as path from 'path';
+
+const emptyObject = {};
+
+const parseAndReadFileContents = async filePath => {
+    try {
+        return parse((await fs.readFile(filePath)).toString());
+    } catch {
+        return undefined;
+    }
+};
+
+(async () => {
+    const prettierConfig = await parseAndReadFileContents('.prettierrc.json');
+
+    const writeFileFormatted = async (filePath, contents) => {
+        await fs.writeFile(
+            filePath,
+            format(JSON.stringify(contents, null, 4), {
+                ...prettierConfig,
+                filepath: filePath,
+            }),
+        );
+    };
+
+    const [, , tslintRuleName, eslintRuleName = tslintRuleName] = process.argv;
+
+    const typeNames = await fs.readdir('types');
+    for (const typeName of typeNames) {
+        const typeDirectory = path.join('types', typeName);
+
+        const tslintFilePath = path.join(typeDirectory, 'tslint.json');
+        const tslintData = await parseAndReadFileContents(tslintFilePath);
+        if (tslintData?.rules?.[tslintRuleName] !== false) {
+            continue;
+        }
+
+        console.log(`Converting ${typeName}...`);
+
+        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;
+        } else {
+            console.log(`\t${tslintFilePath} has remaining rules.`);
+        }
+        await writeFileFormatted(tslintFilePath, tslintData);
+
+        const eslintFilePath = path.join(typeDirectory, '.eslintrc.json');
+        const eslintData = (await parseAndReadFileContents(eslintFilePath)) ?? emptyObject;
+
+        if (eslintData === emptyObject) {
+            console.log(`\t${eslintFilePath} did not yet exist; creating.`);
+        } else {
+            console.log(`\t${eslintFilePath} already exists; modifying.`);
+        }
+
+        writeFileFormatted(eslintFilePath, {
+            ...eslintData,
+            rules: {
+                ...eslintData.rules,
+                [eslintRuleName]: 'off',
+            },
+        });
+    }
+})();

types/absolute/.eslintrc.json

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

types/absolute/tslint.json

@@ -1,7 +1,6 @@
 {
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
-        "dt-header": false,
         "npm-naming": [
             true,
             {

types/acc-wizard/.eslintrc.json

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

types/acc-wizard/tslint.json

@@ -2,7 +2,6 @@
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
         "ban-types": false,
-        "dt-header": false,
         "no-consecutive-blank-lines": false,
         "no-trailing-whitespace": false,
         "no-var-keyword": false,

types/ace/.eslintrc.json

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

types/ace/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,
         "max-line-length": false,

types/add2home/.eslintrc.json

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

types/add2home/tslint.json

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

types/alertify/.eslintrc.json

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

types/alertify/tslint.json

@@ -2,7 +2,6 @@
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
         "ban-types": false,
-        "dt-header": false,
         "interface-name": false,
         "no-consecutive-blank-lines": false,
         "no-trailing-whitespace": false,

types/alt/.eslintrc.json

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

types/alt/tslint.json

@@ -5,7 +5,6 @@
         "array-type": false,
         "ban-types": false,
         "comment-format": false,
-        "dt-header": false,
         "interface-over-type-literal": false,
         "no-declare-current-package": false,
         "no-inferrable-types": false,

types/amazon-product-api/.eslintrc.json

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

types/amazon-product-api/tslint.json

@@ -2,7 +2,6 @@
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
         "ban-types": false,
-        "dt-header": false,
         "interface-name": false,
         "no-consecutive-blank-lines": false,
         "one-line": false,

types/amqp-rpc/.eslintrc.json

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

types/amqp-rpc/tslint.json

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

types/angular-agility/.eslintrc.json

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

types/angular-agility/tslint.json

@@ -2,7 +2,6 @@
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
         "arrow-return-shorthand": false,
-        "dt-header": false,
         "interface-name": false,
         "no-consecutive-blank-lines": false,
         "no-object-literal-type-assertion": false,
@@ -11,12 +10,7 @@
         "npm-naming": [
             true,
             {
-                "errors": [
-                    [
-                        "NeedsExportEquals",
-                        false
-                    ]
-                ],
+                "errors": [["NeedsExportEquals", false]],
                 "mode": "code"
             }
         ],

types/angular-bootstrap-calendar/.eslintrc.json

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

types/angular-bootstrap-calendar/tslint.json

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

types/angular-breadcrumb/.eslintrc.json

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

types/angular-breadcrumb/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/angular-clipboard/.eslintrc.json

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

types/angular-clipboard/tslint.json

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

types/angular-cookie/.eslintrc.json

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

types/angular-cookie/tslint.json

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

types/angular-deferred-bootstrap/.eslintrc.json

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

types/angular-deferred-bootstrap/tslint.json

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

types/angular-dialog-service/.eslintrc.json

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

types/angular-dialog-service/tslint.json

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

types/angular-environment/.eslintrc.json

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

types/angular-environment/tslint.json

@@ -2,7 +2,6 @@
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
         "array-type": false,
-        "dt-header": false,
         "no-trailing-whitespace": false,
         "no-unnecessary-qualifier": false,
         "no-var-keyword": false,

types/angular-es/.eslintrc.json

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

types/angular-es/tslint.json

@@ -3,7 +3,6 @@
     "rules": {
         "array-type": false,
         "ban-types": false,
-        "dt-header": false,
         "no-declare-current-package": false,
         "no-duplicate-imports": false,
         "no-padding": false,

types/angular-feature-flags/.eslintrc.json

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

types/angular-feature-flags/tslint.json

@@ -2,7 +2,6 @@
     "extends": "@definitelytyped/dtslint/dt.json",
     "rules": {
         "array-type": false,
-        "dt-header": false,
         "no-reference-import": false,
         "no-unnecessary-qualifier": false,
         "only-arrow-functions": false,

types/angular-formly/.eslintrc.json

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

types/angular-formly/tslint.json

@@ -4,7 +4,6 @@
         "array-type": false,
         "ban-types": false,
         "comment-format": false,
-        "dt-header": false,
         "interface-name": false,
         "no-consecutive-blank-lines": false,
         "no-declare-current-package": false,

types/angular-fullscreen/.eslintrc.json

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