@definitelytyped/eslint-plugin 0.0.186 → 0.0.188

package/src/util.ts

@@ -1,7 +1,9 @@
-import { unmangleScopedPackage } from "@definitelytyped/utils";
+import { isDeclarationPath, typesPackageNameToRealName } from "@definitelytyped/utils";
 import { TSESTree, ESLintUtils } from "@typescript-eslint/utils";
 import { RuleWithMetaAndName } from "@typescript-eslint/utils/dist/eslint-utils";
 import { RuleListener, RuleModule, SourceCode } from "@typescript-eslint/utils/dist/ts-eslint";
+import path from "path";
+import fs from "fs";
 
 // Possible TS bug can't figure out how to do declaration emit of created rules
 // without an explicit type annotation here due to pnpm symlink stuff
@@ -13,16 +15,10 @@ export const createRule: <TOptions extends readonly unknown[], TMessageIds exten
 );
 
 export function getTypesPackageForDeclarationFile(file: string) {
-  if (!file.endsWith(".d.ts")) {
+  if (!isDeclarationPath(file)) {
     return undefined;
   }
-
-  const match = file.match(/types\/([^\/]+)\//)?.[1];
-  if (!match) {
-    return undefined;
-  }
-
-  return unmangleScopedPackage(match) ?? match;
+  return findTypesPackage(file)?.realName;
 }
 
 export function commentsMatching(
@@ -35,3 +31,67 @@ export function commentsMatching(
     if (m) f(m[1], comment);
   }
 }
+
+function findUp<T extends {}>(p: string, fn: (p: string) => T | undefined): T | undefined {
+  p = path.resolve(p);
+  const root = path.parse(p).root;
+
+  while (true) {
+    const v = fn(p);
+    if (v !== undefined) {
+      return v;
+    }
+    if (p === root) {
+      break;
+    }
+    p = path.dirname(p);
+  }
+
+  return undefined;
+}
+
+export interface TypesPackageInfo {
+  dir: string;
+  /** package.json with name="@types/foo__bar-baz" */
+  packageJson: PackageJSON;
+  /** real package name being typed, like "@foo/bar-baz" */
+  realName: string;
+}
+
+export interface PackageJSON {
+  name: string;
+  version: string;
+  owners: string[];
+  dependencies?: Record<string, string | undefined>;
+  devDependencies?: Record<string, string | undefined>;
+}
+
+// TODO(jakebailey): pull this helper out to util package?
+function isTypesPackage(packageJson: Partial<PackageJSON>): boolean {
+  return (
+    typeof packageJson.name === "string" &&
+    packageJson.name.startsWith("@types/") &&
+    typeof packageJson.version === "string" &&
+    Array.isArray(packageJson.owners)
+  );
+}
+
+export function findTypesPackage(file: string): TypesPackageInfo | undefined {
+  return findUp(file, (p) => {
+    const packageJsonPath = path.join(p, "package.json");
+    if (!fs.existsSync(packageJsonPath)) {
+      return undefined;
+    }
+
+    const packageJsonContents = fs.readFileSync(packageJsonPath, "utf8");
+    const packageJson = JSON.parse(packageJsonContents);
+    if (!isTypesPackage(packageJson)) {
+      return undefined;
+    }
+    return {
+      dir: p,
+      packageJson,
+      realName: typesPackageNameToRealName(packageJson.name),
+    };
+  });
+}

package/test/fixtureTester.ts

@@ -0,0 +1,64 @@
+import { TSESLint, ESLintUtils } from "@typescript-eslint/utils";
+import path from "path";
+import fs from "fs";
+
+export const fixtureRoot = path.join(__dirname, "fixtures");
+
+export function getFixturePath(filename: string): string {
+  return path.join(fixtureRoot, filename);
+}
+
+type ValidTestCase<TOptions extends Readonly<unknown[]>> = Omit<
+  TSESLint.ValidTestCase<TOptions>,
+  "code" | "filename"
+> & {
+  filename: string;
+};
+
+type InvalidTestCase<TMessageIds extends string, TOptions extends Readonly<unknown[]>> = Omit<
+  TSESLint.InvalidTestCase<TMessageIds, TOptions>,
+  "code" | "filename"
+> & {
+  filename: string;
+};
+
+interface RunTests<TMessageIds extends string, TOptions extends Readonly<unknown[]>> {
+  readonly valid: readonly ValidTestCase<TOptions>[];
+  readonly invalid: readonly InvalidTestCase<TMessageIds, TOptions>[];
+}
+
+function convertTestCase<TOptions extends Readonly<unknown[]>>(
+  test: ValidTestCase<TOptions>
+): TSESLint.ValidTestCase<TOptions>;
+function convertTestCase<TMessageIds extends string, TOptions extends Readonly<unknown[]>>(
+  test: InvalidTestCase<TMessageIds, TOptions>
+): TSESLint.InvalidTestCase<TMessageIds, TOptions>;
+function convertTestCase<
+  TMessageIds extends string,
+  TOptions extends Readonly<unknown[]>,
+  T extends ValidTestCase<TOptions> | InvalidTestCase<TMessageIds, TOptions>
+>(test: T): TSESLint.ValidTestCase<TOptions> | TSESLint.InvalidTestCase<TMessageIds, TOptions> {
+  const fixture = getFixturePath(test.filename);
+  const code = fs.readFileSync(fixture, "utf8");
+  return {
+    name: test.filename,
+    ...test,
+    code,
+    filename: fixture,
+  };
+}
+
+export function runTestsWithFixtures<TMessageIds extends string, TOptions extends Readonly<unknown[]>>(
+  name: string,
+  rule: TSESLint.RuleModule<TMessageIds, TOptions>,
+  tests: RunTests<TMessageIds, TOptions>
+): void {
+  const ruleTester = new ESLintUtils.RuleTester({
+    parser: "@typescript-eslint/parser",
+  });
+
+  return ruleTester.run(name, rule, {
+    valid: tests.valid.map(convertTestCase<TOptions>),
+    invalid: tests.invalid.map(convertTestCase<TMessageIds, TOptions>),
+  });
+}

package/test/fixtures/notNeededPackages.json

@@ -0,0 +1,3 @@
+{
+    "packages": {}
+}

package/test/fixtures/package.json

@@ -0,0 +1,4 @@
+{
+    "name": "definitely-typed",
+    "private": "true"
+}

package/test/fixtures/types/foo/index.d.ts

@@ -0,0 +1 @@
+export const foo = 1234;

package/test/fixtures/types/foo/package.json

@@ -0,0 +1,5 @@
+{
+    "name": "@types/foo",
+    "version": "2.0.9999",
+    "owners": []
+}

package/test/fixtures/types/foo/tsconfig.json

@@ -0,0 +1,20 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6",
+            "dom"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "foo-tests.ts"
+    ]
+}

package/test/fixtures/types/foo/v1/index.d.ts

@@ -0,0 +1 @@
+export const foo = 1234;

package/test/fixtures/types/foo/v1/package.json

@@ -0,0 +1,5 @@
+{
+    "name": "@types/foo",
+    "version": "1.0.9999",
+    "owners": []
+}

package/test/fixtures/types/foo/v1/tsconfig.json

@@ -0,0 +1,20 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6",
+            "dom"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "foo-tests.ts"
+    ]
+}

package/test/fixtures/types/no-bad-reference/index.d.ts

@@ -0,0 +1,16 @@
+/// <reference path="../other" />
+/// <reference path="./v11" />
+/// <reference path="./v11/index" />
+/// <reference path="./v11/subdir/file" />
+/// <reference path="./v0.1" />
+/// <reference path="./v0.1/index" />
+/// <reference path="other" />
+/// <reference path="./other" />
+/// <reference path="./v1gardenpath" />
+/// <reference path="./v1verb/other" />
+/// <reference path="other" />
+/// <reference path="other2" />
+/// <reference path="..\index.d.ts" />
+
+// unrelated comment
+/// similar (reference path) comment

package/test/fixtures/types/no-bad-reference/no-bad-reference-tests.ts

@@ -0,0 +1,2 @@
+/// <reference path="../other" />
+/// <reference path="other" />

package/test/fixtures/types/no-bad-reference/package.json

@@ -0,0 +1,5 @@
+{
+    "name": "@types/no-bad-references",
+    "version": "12.0.9999",
+    "owners": []
+}

package/test/fixtures/types/no-bad-reference/tsconfig.json

@@ -0,0 +1,20 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6",
+            "dom"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "no-relative-references-tests.ts"
+    ]
+}

package/test/fixtures/types/no-bad-reference/v0.1/index.d.ts

@@ -0,0 +1,15 @@
+/// <reference path="../../foo/index.d.ts" />
+/// <reference path="../v1/index.d.ts" />
+/// <reference path="../../foo/v0.1/index.d.ts" />
+/// <reference path="../index.d.ts" />
+
+import * as foo from "../../foo";
+import * as foo2 from "../v0.1";
+import * as foo3 from "../../foo/v0.1";
+import * as va4 from "../index";
+
+declare module "no-relative-references" {
+  import A = require("no-relative-references/blah"); // Okay; relative
+  import B = require("no-relative-references/v0.1"); // Okay; no versioned dir here
+  import C = require("../index"); // Bad; parent dir
+}

package/test/fixtures/types/no-bad-reference/v0.1/package.json

@@ -0,0 +1,5 @@
+{
+    "name": "@types/no-bad-references",
+    "version": "0.1.9999",
+    "owners": []
+}

package/test/fixtures/types/no-bad-reference/v0.1/tsconfig.json

@@ -0,0 +1,20 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6",
+            "dom"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "no-relative-references-tests.ts"
+    ]
+}

package/test/fixtures/types/no-bad-reference/v11/index.d.ts

@@ -0,0 +1,15 @@
+/// <reference path="../../foo/index.d.ts" />
+/// <reference path="../v11/index.d.ts" />
+/// <reference path="../../foo/v1/index.d.ts" />
+/// <reference path="../index.d.ts" />
+
+import * as foo from "../../foo";
+import * as foo2 from "../v11";
+import * as foo3 from "../../foo/v11";
+import * as va4 from "../index";
+
+declare module "no-relative-references" {
+  import A = require("no-relative-references/blah"); // Okay; relative
+  import B = require("no-relative-references/v11"); // Okay; no versioned dir here
+  import C = require("../index"); // Bad; parent dir
+}

package/test/fixtures/types/no-bad-reference/v11/package.json

@@ -0,0 +1,5 @@
+{
+    "name": "@types/no-bad-references",
+    "version": "11.0.9999",
+    "owners": []
+}

package/test/fixtures/types/no-bad-reference/v11/tsconfig.json

@@ -0,0 +1,20 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6",
+            "dom"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "no-relative-references-tests.ts"
+    ]
+}

package/test/fixtures/types/no-declare-current-package/index.d.ts

@@ -0,0 +1 @@
+declare module "no-declare-current-package" { }

package/test/fixtures/types/no-declare-current-package/package.json

@@ -0,0 +1,8 @@
+{
+    "name": "@types/no-declare-current-package",
+    "version": "2.0.9999",
+    "owners": [],
+    "devDependencies": {
+        "@types/no-declare-current-package": "workspace:."
+    }
+}

package/test/fixtures/types/no-declare-current-package/test/deep/import.d.ts

@@ -0,0 +1 @@
+declare module "no-declare-current-package/deep/import" { }

package/test/fixtures/types/no-declare-current-package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6",
+            "dom"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "no-import-of-dev-dependencies-tests.ts"
+    ]
+}

package/test/fixtures/types/no-declare-current-package-other/index.d.ts

@@ -0,0 +1,2 @@
+declare module "no-declare-current-package" { }
+declare module "@scoped/no-declare-current-package" { }

package/test/fixtures/types/no-declare-current-package-other/package.json

@@ -0,0 +1,8 @@
+{
+    "name": "@types/no-declare-current-package-other",
+    "version": "2.0.9999",
+    "owners": [],
+    "devDependencies": {
+        "@types/no-declare-current-package-other": "workspace:."
+    }
+}

package/test/fixtures/types/no-declare-current-package-other/tsconfig.json

@@ -0,0 +1,20 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6",
+            "dom"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "no-import-of-dev-dependencies-tests.ts"
+    ]
+}

package/test/fixtures/types/no-import-of-dev-dependencies/bad.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="devdep"/>
+/// <reference types="otherdevdep"/>
+
+import devdep from "devdep";
+import * as otherdevdep from "otherdevdep";

package/test/fixtures/types/no-import-of-dev-dependencies/index.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="other"/>
+
+import other from "other";
+import self from "no-import-of-dev-dependencies";

package/test/fixtures/types/no-import-of-dev-dependencies/no-import-of-dev-dependencies-tests.ts

@@ -0,0 +1,9 @@
+/// <reference types="devdep"/>
+/// <reference types="otherdevdep"/>
+/// <reference types="other"/>
+
+import other from "other";
+import self from "no-import-of-dev-dependencies";
+
+import devdep from "devdep";
+import * as otherdevdep from "otherdevdep";

package/test/fixtures/types/no-import-of-dev-dependencies/package.json

@@ -0,0 +1,14 @@
+{
+    "name": "@types/no-import-of-dev-dependencies",
+    "version": "2.0.9999",
+    "owners": [],
+    "dependencies": {
+        "@types/foo": "*",
+        "other": "*"
+    },
+    "devDependencies": {
+        "@types/devdep": "*",
+        "@types/no-import-of-dev-dependencies": "workspace:.",
+        "otherdevdep": "*"
+    }
+}

package/test/fixtures/types/no-import-of-dev-dependencies/tsconfig.json

@@ -0,0 +1,20 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6",
+            "dom"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "no-import-of-dev-dependencies-tests.ts"
+    ]
+}

package/test/fixtures/types/no-relative-references/index.d.ts

@@ -0,0 +1,12 @@
+/// <reference path="../foo/index.d.ts" />
+/// <reference path="./v1/index.d.ts" />
+/// <reference path="../foo/v1/index.d.ts" />
+
+import * as foo from "../foo";
+import * as foo2 from "./v1";
+import * as foo3 from "../foo/v1";
+
+declare module "no-relative-references" {
+  import A = require("no-relative-references/blah"); // Okay; relative
+  import B = require("no-relative-references/v1"); // Bad; versioned subdir
+}

package/test/fixtures/types/no-relative-references/other/other.d.ts

@@ -0,0 +1,7 @@
+/// <reference path="../../foo/index.d.ts" />
+/// <reference path="../v1/index.d.ts" />
+/// <reference path="../../foo/v1/index.d.ts" />
+
+import * as foo from "../../foo";
+import * as foo2 from "../v1";
+import * as foo3 from "../../foo/v1";

package/test/fixtures/types/no-relative-references/package.json

@@ -0,0 +1,5 @@
+{
+    "name": "@types/no-relative-references",
+    "version": "2.0.9999",
+    "owners": []
+}

package/test/fixtures/types/no-relative-references/tsconfig.json

@@ -0,0 +1,20 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6",
+            "dom"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "no-relative-references-tests.ts"
+    ]
+}

package/test/fixtures/types/no-relative-references/v1/index.d.ts

@@ -0,0 +1,15 @@
+/// <reference path="../../foo/index.d.ts" />
+/// <reference path="../v1/index.d.ts" />
+/// <reference path="../../foo/v1/index.d.ts" />
+/// <reference path="../index.d.ts" />
+
+import * as foo from "../../foo";
+import * as foo2 from "../v1";
+import * as foo3 from "../../foo/v1";
+import * as va4 from "../index";
+
+declare module "no-relative-references" {
+  import A = require("no-relative-references/blah"); // Okay; relative
+  import B = require("no-relative-references/v1"); // Okay; no versioned dir here
+  import C = require("../index"); // Bad; parent dir
+}

package/test/fixtures/types/no-relative-references/v1/other/other.d.ts

@@ -0,0 +1,7 @@
+/// <reference path="../../../foo/index.d.ts" />
+/// <reference path="../../v1/index.d.ts" />
+/// <reference path="../../../foo/v1/index.d.ts" />
+
+import * as foo from "../../../foo";
+import * as foo2 from "../../v1";
+import * as foo3 from "../../../foo/v1";

package/test/fixtures/types/no-relative-references/v1/package.json

@@ -0,0 +1,5 @@
+{
+    "name": "@types/no-relative-references",
+    "version": "1.0.9999",
+    "owners": []
+}

package/test/fixtures/types/no-relative-references/v1/tsconfig.json

@@ -0,0 +1,20 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6",
+            "dom"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "no-relative-references-tests.ts"
+    ]
+}

package/test/fixtures/types/no-self-import/bad.d.ts

@@ -0,0 +1,8 @@
+import myself from "no-self-import";
+import abc from "no-self-import/abc.d.ts"
+
+import old1 from "./v11";
+import old2 from "./v11/index";
+import old3 from "./v11/subdir/file";
+import old4 from "./v0.1"
+import old5 from "./v0.1/index"