@definitelytyped/eslint-plugin 0.0.180 → 0.0.181

package/src/rules/no-old-dt-header.ts

@@ -0,0 +1,40 @@
+import { createRule } from "../util";
+
+const rule = createRule({
+  name: "no-bad-reference",
+  defaultOptions: [],
+  meta: {
+    type: "problem",
+    docs: {
+      description: `Forbids <reference path="./vNN"/> in all files, <reference path="../etc"/> in declaration files, and all <reference path> in test files.`,
+      recommended: "error",
+    },
+    messages: {
+      noOldDTHeader:
+        "Specify package metadata in package.json. Do not use a header like `// Type definitions for foo 1.2`",
+    },
+    schema: [],
+  },
+  create(context) {
+    const text = context.getSourceCode().text;
+    if (
+      context.getFilename().endsWith(".d.ts") &&
+      text.indexOf("// Type definitions for ") === 0 &&
+      text.indexOf("// Definitions by: ") > 0
+    ) {
+      context.report({
+        messageId: "noOldDTHeader",
+        loc: {
+          start: { column: 0, line: 1 },
+          end: {
+            column: "// Type definitions for ".length,
+            line: 1,
+          },
+        },
+      });
+    }
+    return {};
+  },
+});
+
+export = rule;

package/src/rules/no-self-import.ts

@@ -1,16 +1,17 @@
 import { createRule, getTypesPackageForDeclarationFile } from "../util";
-
 const rule = createRule({
   name: "no-self-import",
   defaultOptions: [],
   meta: {
     type: "problem",
     docs: {
-      description: "Forbids declaration files to import the current package using a global import.",
+      description:
+        "Forbids declaration files to import the current package using a global import or old versions with a relative import.",
       recommended: "error",
     },
     messages: {
       useRelativeImport: "Declaration file should not use a global import of itself. Use a relative import.",
+      useOnlyCurrentVersion: "Don't import an old version of the current package.",
     },
     schema: [],
   },
@@ -25,6 +26,11 @@ const rule = createRule({
             messageId: "useRelativeImport",
             node,
           });
+        } else if (node.source.value.match(/^\.\/v\d+(?:\.\d+)?(?:\/.*)?$/)) {
+          context.report({
+            messageId: "useOnlyCurrentVersion",
+            node,
+          });
         }
       },
     };

package/src/rules/no-useless-files.ts

@@ -1,4 +1,4 @@
-import { createRule } from "../util";
+import { commentsMatching, createRule } from "../util";
 
 const rule = createRule({
   name: "no-useless-files",
@@ -25,15 +25,9 @@ const rule = createRule({
       } else {
         const referenceRegExp = /^\/\s*<reference\s*(types|path)\s*=\s*["|'](.*)["|']/;
         let noReferenceFound = true;
-
-        for (const comment of comments) {
-          const referenceMatch = comment.value.match(referenceRegExp)?.[1];
-          if (!referenceMatch) {
-            continue;
-          }
+        commentsMatching(context.getSourceCode(), referenceRegExp, () => {
           noReferenceFound = false;
-          break;
-        }
+        });
 
         if (noReferenceFound) {
           reportNoContent();

package/src/util.ts

@@ -1,7 +1,7 @@
 import { unmangleScopedPackage } from "@definitelytyped/utils";
-import { ESLintUtils } from "@typescript-eslint/utils";
+import { TSESTree, ESLintUtils } from "@typescript-eslint/utils";
 import { RuleWithMetaAndName } from "@typescript-eslint/utils/dist/eslint-utils";
-import { RuleListener, RuleModule } from "@typescript-eslint/utils/dist/ts-eslint";
+import { RuleListener, RuleModule, SourceCode } from "@typescript-eslint/utils/dist/ts-eslint";
 import { basename, dirname } from "path";
 
 // Possible TS bug can't figure out how to do declaration emit of created rules
@@ -46,3 +46,14 @@ export function isMainFile(fileName: string, allowNested: boolean) {
   // Allow "types/foo/index.d.ts", not "types/foo/utils/index.d.ts"
   return basename(dirname(parent)) === "types";
 }
+
+export function commentsMatching(
+  sourceFile: Readonly<SourceCode>,
+  regex: RegExp,
+  f: (match: string, c: TSESTree.Comment) => void
+): void {
+  for (const comment of sourceFile.ast.comments) {
+    const m = comment.value.match(regex);
+    if (m) f(m[1], comment);
+  }
+}

package/test/no-bad-reference.test.ts

@@ -44,6 +44,66 @@ ruleTester.run("@definitelytyped/no-bad-reference", noBadReference, {
       ],
       filename: "types.d.ts",
     },
+    {
+      code: `/// <reference path="./v11" />`,
+      errors: [
+        {
+          column: 20,
+          endColumn: 25,
+          line: 1,
+          messageId: "referencePathOldVersion",
+        },
+      ],
+      filename: "types.d.ts",
+    },
+    {
+      code: `/// <reference path="./v11/index" />`,
+      errors: [
+        {
+          column: 20,
+          endColumn: 31,
+          line: 1,
+          messageId: "referencePathOldVersion",
+        },
+      ],
+      filename: "types.d.ts",
+    },
+    {
+      code: `/// <reference path="./v11/subdir/file" />`,
+      errors: [
+        {
+          column: 20,
+          endColumn: 37,
+          line: 1,
+          messageId: "referencePathOldVersion",
+        },
+      ],
+      filename: "types.d.ts",
+    },
+    {
+      code: `/// <reference path="./v0.1" />`,
+      errors: [
+        {
+          column: 20,
+          endColumn: 26,
+          line: 1,
+          messageId: "referencePathOldVersion",
+        },
+      ],
+      filename: "types.d.ts",
+    },
+    {
+      code: `/// <reference path="./v0.1/index" />`,
+      errors: [
+        {
+          column: 20,
+          endColumn: 32,
+          line: 1,
+          messageId: "referencePathOldVersion",
+        },
+      ],
+      filename: "types.d.ts",
+    },
   ],
   valid: [
     ``,
@@ -57,6 +117,14 @@ ruleTester.run("@definitelytyped/no-bad-reference", noBadReference, {
       code: `/// <reference path="./other" />`,
       filename: "types.d.ts",
     },
+    {
+      code: `/// <reference path="./v1gardenpath" />`,
+      filename: "types.d.ts",
+    },
+    {
+      code: `/// <reference path="./v1verb/other" />`,
+      filename: "types.d.ts",
+    },
     {
       code: `/// <reference path="other" />
 /// <reference path="other2" />`,

package/test/no-import-of-dev-dependencies.test.ts

@@ -0,0 +1,72 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+
+import * as noImportDefaultOfDevDependencies from "../src/rules/no-import-of-dev-dependencies";
+
+const ruleTester = new ESLintUtils.RuleTester({
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: 2018,
+  },
+});
+
+ruleTester.run("@definitelytyped/no-import-of-dev-dependencies", noImportDefaultOfDevDependencies, {
+  invalid: [
+    {
+      filename: "index.d.ts",
+      code: `import eslint from "eslint"`,
+      errors: [
+        {
+          line: 1,
+          messageId: "noImportOfDevDependencies",
+        },
+      ],
+    },
+    // test @types/ removal
+    {
+      filename: "index.d.ts",
+      code: `import yargs from "yargs"`,
+      errors: [
+        {
+          line: 1,
+          messageId: "noImportOfDevDependencies",
+        },
+      ],
+    },
+    {
+      filename: "index.d.ts",
+      code: `/// <reference types="node" />`,
+      errors: [
+        {
+          line: 1,
+          messageId: "noReferenceOfDevDependencies",
+        },
+      ],
+    },
+  ],
+  valid: [
+    {
+      filename: "index.d.ts",
+      code: `import other from 'other'`,
+    },
+    {
+      filename: "types/yargs/index.d.ts",
+      code: `import self from "yargs"`,
+    },
+    {
+      filename: "index.d.ts",
+      code: `/// <reference types="other"/>`,
+    },
+    {
+      filename: "test.ts",
+      code: `import eslint from "eslint"`,
+    },
+    {
+      filename: "test.ts",
+      code: `import yargs from "yargs"`,
+    },
+    {
+      filename: "test.ts",
+      code: `/// <reference types="node" />`,
+    },
+  ],
+});

package/test/no-old-dt-header.test.ts

@@ -0,0 +1,71 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+
+import * as noOldDtHeader from "../src/rules/no-old-dt-header";
+
+const ruleTester = new ESLintUtils.RuleTester({
+  parser: "@typescript-eslint/parser",
+});
+
+ruleTester.run("@definitelytyped/no-old-dt-header", noOldDtHeader, {
+  invalid: [
+    {
+      code: `// Type definitions for AFRAME 1.2
+// Project: https://aframe.io/
+// Definitions by: Paul Shannon <https://github.com/devpaul>
+//                 Roberto Ritger <https://github.com/bertoritger>
+//                 Trygve Wastvedt <https://github.com/twastvedt>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 4.4
+
+/**
+ * Extended tests and examples available at https://github.com/devpaul/aframe-experiments.git
+ */
+
+import * as anime from "animejs";
+import * as three from "three";`,
+      errors: [
+        {
+          column: 1,
+          endColumn: 25,
+          line: 1,
+          messageId: "noOldDTHeader",
+        },
+      ],
+      filename: "index.d.ts",
+    },
+    {
+      code: `// Type definitions for AFRAME 1.2
+// Definitions by: Paul Shannon <https://github.com/devpaul>`,
+      errors: [
+        {
+          column: 1,
+          endColumn: 25,
+          line: 1,
+          messageId: "noOldDTHeader",
+        },
+      ],
+      filename: "types.d.ts",
+    },
+  ],
+  valid: [
+    {
+      code: `// Type definitions for AFRAME 1.2
+// Definitions by: Paul Shannon <https://github.com/devpaul>`,
+      filename: "test.ts",
+    },
+    {
+      code: `// Type definitions for AFRAME 1.2`,
+      filename: "types.d.ts",
+    },
+    {
+      code: `// Definitions by: Paul Shannon <https://github.com/devpaul>`,
+      filename: "types.d.ts",
+    },
+    {
+      code: `// A line before the old header
+      // Type definitions for AFRAME 1.2
+// Definitions by: Paul Shannon <https://github.com/devpaul>`,
+      filename: "types.d.ts",
+    },
+  ],
+});

package/test/no-self-import.test.ts

@@ -28,6 +28,66 @@ ruleTester.run("@definitelytyped/no-self-import", dtHeader, {
       ],
       filename: "types/this-package/index.d.ts",
     },
+    {
+      code: `import old from "./v11"`,
+      errors: [
+        {
+          column: 1,
+          endColumn: 24,
+          line: 1,
+          messageId: "useOnlyCurrentVersion",
+        },
+      ],
+      filename: "types.d.ts",
+    },
+    {
+      code: `import old from "./v11/index"`,
+      errors: [
+        {
+          column: 1,
+          endColumn: 30,
+          line: 1,
+          messageId: "useOnlyCurrentVersion",
+        },
+      ],
+      filename: "types.d.ts",
+    },
+    {
+      code: `import old from "./v11/subdir/file"`,
+      errors: [
+        {
+          column: 1,
+          endColumn: 36,
+          line: 1,
+          messageId: "useOnlyCurrentVersion",
+        },
+      ],
+      filename: "types.d.ts",
+    },
+    {
+      code: `import old from "./v0.1"`,
+      errors: [
+        {
+          column: 1,
+          endColumn: 25,
+          line: 1,
+          messageId: "useOnlyCurrentVersion",
+        },
+      ],
+      filename: "types.d.ts",
+    },
+    {
+      code: `import old from "./v0.1/index"`,
+      errors: [
+        {
+          column: 1,
+          endColumn: 31,
+          line: 1,
+          messageId: "useOnlyCurrentVersion",
+        },
+      ],
+      filename: "types.d.ts",
+    },
   ],
   valid: [
     {
@@ -42,5 +102,13 @@ ruleTester.run("@definitelytyped/no-self-import", dtHeader, {
       code: `import myself from "this-package";`,
       filename: "types/grandparent/this-package/index.d.ts",
     },
+    {
+      code: `import old from "./v1gardenpath"`,
+      filename: "types.d.ts",
+    },
+    {
+      code: `import old from "./v1verb/other"`,
+      filename: "types.d.ts",
+    },
   ],
 });