Clean up expect type code for diagnostics

.changeset/tricky-cobras-boil.md

@@ -0,0 +1,5 @@
+---
+"@definitelytyped/eslint-plugin": patch
+---
+
+Clean up expect type code for diagnostics

packages/eslint-plugin/src/rules/expect.ts

@@ -1,4 +1,3 @@
-import { isDeclarationPath } from "@definitelytyped/utils";
 import { createRule, findTypesPackage, findUp } from "../util";
 import { ESLintUtils, TSESTree } from "@typescript-eslint/utils";
 import type * as ts from "typescript";
@@ -74,11 +73,6 @@ Then re-run.`,
   },
   defaultOptions: [{}],
   create(context) {
-    const inEditor = !context.options[0]?.versionsToTest?.length;
-    if (inEditor && (isDeclarationPath(context.filename) || !context.sourceCode.text.includes("$ExpectType"))) {
-      return {};
-    }
-
     const tsconfigPath = findUp(context.filename, (dir) => {
       const tsconfig = path.join(dir, "tsconfig.json");
       return fs.existsSync(tsconfig) ? tsconfig : undefined;
@@ -115,9 +109,11 @@ Then re-run.`,
         };
 
         let versionsToTest = context.options[0]?.versionsToTest;
+        let reportDiagnostics = true;
         if (!versionsToTest?.length) {
           // In the editor, just use the built-in install of TypeScript.
           versionsToTest = [{ versionName: "", path: require.resolve("typescript") }];
+          reportDiagnostics = false;
         }
 
         for (const version of versionsToTest) {
@@ -132,6 +128,7 @@ Then re-run.`,
             version.versionName,
             /*nextHigherVersion*/ undefined,
             dirPath,
+            reportDiagnostics,
           );
         }
 
@@ -212,6 +209,7 @@ function walk(
   versionName: string,
   nextHigherVersion: string | undefined,
   dirPath: string,
+  reportDiagnostics: boolean,
 ): void {
   const sourceFile = program.getSourceFile(fileName)!;
   if (!sourceFile) {
@@ -226,9 +224,7 @@ function walk(
 
   const checker = program.getTypeChecker();
 
-  if (versionName) {
-    // If we're using the built-in version of TS, then we're in the editor and tsserver will report diagnostics.
-
+  if (reportDiagnostics) {
     // Don't care about emit errors.
     const diagnostics = ts.getPreEmitDiagnostics(program, sourceFile);
     for (const diagnostic of diagnostics) {

packages/eslint-plugin/test/__file_snapshots__/types/expect-diagnostics-versioned/expect-diagnostics-tests.ts.lint

@@ -0,0 +1,16 @@
+types/expect-diagnostics-versioned/expect-diagnostics-tests.ts
+  5:7  error  TypeScript@x.y compile error: 
+Type 'number' is not assignable to type 'string'  @definitelytyped/expect
+
+✖ 1 problem (1 error, 0 warnings)
+
+==== types/expect-diagnostics-versioned/expect-diagnostics-tests.ts ====
+
+    // eslint-disable-next-line @definitelytyped/no-relative-import-in-test
+    import * as expect from ".";
+
+    // This should cause a diagnostic.
+    const blah: string = expect.foo;
+          ~~~~
+!!! @definitelytyped/expect: TypeScript@x.y compile error: 
+!!!                        : Type 'number' is not assignable to type 'string'.

packages/eslint-plugin/test/__file_snapshots__/types/expect-diagnostics-versioned/index.d.ts.lint

@@ -0,0 +1,15 @@
+types/expect-diagnostics-versioned/index.d.ts
+  4:22  error  TypeScript@x.y compile error: 
+Generic type 'Array<T>' requires 1 type argument(s)  @definitelytyped/expect
+
+✖ 1 problem (1 error, 0 warnings)
+
+==== types/expect-diagnostics-versioned/index.d.ts ====
+
+    export const foo = 1234;
+
+    // This should cause a diagnostic.
+    export const badSet: Array<string, number, number, number>;
+                         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+!!! @definitelytyped/expect: TypeScript@x.y compile error: 
+!!!                        : Generic type 'Array<T>' requires 1 type argument(s).

packages/eslint-plugin/test/__file_snapshots__/types/expect-diagnostics/expect-diagnostics-tests.ts.lint

@@ -0,0 +1,9 @@
+No errors
+
+==== types/expect-diagnostics/expect-diagnostics-tests.ts ====
+
+    // eslint-disable-next-line @definitelytyped/no-relative-import-in-test
+    import * as expect from ".";
+
+    // This should cause a diagnostic.
+    const blah: string = expect.foo;

packages/eslint-plugin/test/__file_snapshots__/types/expect-diagnostics/index.d.ts.lint

@@ -0,0 +1,8 @@
+No errors
+
+==== types/expect-diagnostics/index.d.ts ====
+
+    export const foo = 1234;
+
+    // This should cause a diagnostic.
+    export const badSet: Array<string, number, number, number>;

packages/eslint-plugin/test/fixtures/types/expect-diagnostics-versioned/.eslintrc.js

@@ -0,0 +1,10 @@
+module.exports = {
+  overrides: [
+    {
+      files: ["*.ts", "*.cts", "*.mts", "*.tsx"],
+      rules: {
+        "@definitelytyped/expect": ["error", { versionsToTest: [{ versionName: "x.y", path: "typescript" }] }],
+      },
+    },
+  ]
+};

packages/eslint-plugin/test/fixtures/types/expect-diagnostics-versioned/expect-diagnostics-tests.ts

@@ -0,0 +1,5 @@
+// eslint-disable-next-line @definitelytyped/no-relative-import-in-test
+import * as expect from ".";
+
+// This should cause a diagnostic.
+const blah: string = expect.foo;

packages/eslint-plugin/test/fixtures/types/expect-diagnostics-versioned/index.d.ts

@@ -0,0 +1,4 @@
+export const foo = 1234;
+
+// This should cause a diagnostic.
+export const badSet: Array<string, number, number, number>;

packages/eslint-plugin/test/fixtures/types/expect-diagnostics-versioned/package.json

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

packages/eslint-plugin/test/fixtures/types/expect-diagnostics-versioned/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",
+        "expect-diagnostics-tests.ts"
+    ]
+}

packages/eslint-plugin/test/fixtures/types/expect-diagnostics/expect-diagnostics-tests.ts

@@ -0,0 +1,5 @@
+// eslint-disable-next-line @definitelytyped/no-relative-import-in-test
+import * as expect from ".";
+
+// This should cause a diagnostic.
+const blah: string = expect.foo;

packages/eslint-plugin/test/fixtures/types/expect-diagnostics/index.d.ts

@@ -0,0 +1,4 @@
+export const foo = 1234;
+
+// This should cause a diagnostic.
+export const badSet: Array<string, number, number, number>;

packages/eslint-plugin/test/fixtures/types/expect-diagnostics/package.json

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

packages/eslint-plugin/test/fixtures/types/expect-diagnostics/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",
+        "expect-diagnostics-tests.ts"
+    ]
+}