@definitelytyped/eslint-plugin 0.0.191 → 0.0.193

package/test/__file_snapshots__/types/strict-export-declare-modifiers/bad5.d.ts.lint

@@ -0,0 +1,11 @@
+types/strict-export-declare-modifiers/bad5.d.ts
+  1:11  error  All declarations in this module are exported automatically. Prefer to explicitly write 'export' for clarity. If you have a good reason not to export this declaration, add 'export {}' to the module to shut off automatic exporting  @definitelytyped/strict-export-declare-modifiers
+
+✖ 1 problem (1 error, 0 warnings)
+
+==== types/strict-export-declare-modifiers/bad5.d.ts ====
+
+    interface I { i: any }
+              ~
+!!! @definitelytyped/strict-export-declare-modifiers: All declarations in this module are exported automatically. Prefer to explicitly write 'export' for clarity. If you have a good reason not to export this declaration, add 'export {}' to the module to shut off automatic exporting.
+    export namespace M {}

package/test/__file_snapshots__/types/strict-export-declare-modifiers/bad6.d.ts.lint

@@ -0,0 +1,14 @@
+types/strict-export-declare-modifiers/bad6.d.ts
+  1:1   error  'declare' keyword is redundant here                                                                                                                                                                                                   @definitelytyped/strict-export-declare-modifiers
+  1:18  error  All declarations in this module are exported automatically. Prefer to explicitly write 'export' for clarity. If you have a good reason not to export this declaration, add 'export {}' to the module to shut off automatic exporting  @definitelytyped/strict-export-declare-modifiers
+
+✖ 2 problems (2 errors, 0 warnings)
+
+==== types/strict-export-declare-modifiers/bad6.d.ts ====
+
+    declare function g(): void;
+    ~~~~~~~
+!!! @definitelytyped/strict-export-declare-modifiers: 'declare' keyword is redundant here.
+                     ~
+!!! @definitelytyped/strict-export-declare-modifiers: All declarations in this module are exported automatically. Prefer to explicitly write 'export' for clarity. If you have a good reason not to export this declaration, add 'export {}' to the module to shut off automatic exporting.
+    export namespace M {}

package/test/__file_snapshots__/types/strict-export-declare-modifiers/bad7.d.ts.lint

@@ -0,0 +1,14 @@
+types/strict-export-declare-modifiers/bad7.d.ts
+  1:1   error  'declare' keyword is redundant here                                                                                                                                                                                                   @definitelytyped/strict-export-declare-modifiers
+  1:19  error  All declarations in this module are exported automatically. Prefer to explicitly write 'export' for clarity. If you have a good reason not to export this declaration, add 'export {}' to the module to shut off automatic exporting  @definitelytyped/strict-export-declare-modifiers
+
+✖ 2 problems (2 errors, 0 warnings)
+
+==== types/strict-export-declare-modifiers/bad7.d.ts ====
+
+    declare namespace N {}
+    ~~~~~~~
+!!! @definitelytyped/strict-export-declare-modifiers: 'declare' keyword is redundant here.
+                      ~
+!!! @definitelytyped/strict-export-declare-modifiers: All declarations in this module are exported automatically. Prefer to explicitly write 'export' for clarity. If you have a good reason not to export this declaration, add 'export {}' to the module to shut off automatic exporting.
+    export namespace M {}

package/test/__file_snapshots__/types/strict-export-declare-modifiers/good1.ts.lint

@@ -0,0 +1,5 @@
+No errors
+
+==== types/strict-export-declare-modifiers/good1.ts ====
+
+    export declare class C {}

package/test/__file_snapshots__/types/strict-export-declare-modifiers/good2.d.ts.lint

@@ -0,0 +1,5 @@
+No errors
+
+==== types/strict-export-declare-modifiers/good2.d.ts ====
+
+    export function f() {}

package/test/__file_snapshots__/types/strict-export-declare-modifiers/good3.d.ts.lint

@@ -0,0 +1,5 @@
+No errors
+
+==== types/strict-export-declare-modifiers/good3.d.ts ====
+
+    declare function g(): void;

package/test/__file_snapshots__/types/strict-export-declare-modifiers/good4.d.ts.lint

@@ -0,0 +1,5 @@
+No errors
+
+==== types/strict-export-declare-modifiers/good4.d.ts ====
+
+    declare namespace N {}

package/test/__file_snapshots__/types/strict-export-declare-modifiers/good5.d.ts.lint

@@ -0,0 +1,5 @@
+No errors
+
+==== types/strict-export-declare-modifiers/good5.d.ts ====
+
+    interface J { j: any }

package/test/__file_snapshots__/types/strict-export-declare-modifiers/good6.ts.lint

@@ -0,0 +1,7 @@
+No errors
+
+==== types/strict-export-declare-modifiers/good6.ts ====
+
+    namespace N {
+        export const x: number;
+    }

package/test/__file_snapshots__/types/strict-export-declare-modifiers/good7.d.ts.lint

@@ -0,0 +1,6 @@
+No errors
+
+==== types/strict-export-declare-modifiers/good7.d.ts ====
+
+    declare class Foo2 {}
+    export { Foo2 as Bar2 }

package/test/__file_snapshots__/types/strict-export-declare-modifiers/good8.d.ts.lint

@@ -0,0 +1,9 @@
+No errors
+
+==== types/strict-export-declare-modifiers/good8.d.ts ====
+
+    import * as foo from "foo";
+    import foo = require("foo");
+    export { foo };
+    export { foo } from "foo";
+    export as namespace Foo;

package/test/__file_snapshots__/types/strict-export-declare-modifiers/good9.d.ts.lint

@@ -0,0 +1,7 @@
+No errors
+
+==== types/strict-export-declare-modifiers/good9.d.ts ====
+
+    import * as bar from "bar";
+    import bar = require("bar");
+    export as namespace Bar;

package/test/__file_snapshots__/types/strict-export-declare-modifiers/strict-export-declare-modifiers-tests.ts.lint

@@ -0,0 +1,10 @@
+types/strict-export-declare-modifiers/strict-export-declare-modifiers-tests.ts
+  1:1  error  File has no content  @definitelytyped/no-useless-files
+
+✖ 1 problem (1 error, 0 warnings)
+
+==== types/strict-export-declare-modifiers/strict-export-declare-modifiers-tests.ts ====
+
+    
+    ~
+!!! @definitelytyped/no-useless-files: File has no content.

package/test/eslint.test.ts

@@ -0,0 +1,134 @@
+import { ESLint, Linter } from "eslint";
+import path from "path";
+import stripAnsi from "strip-ansi";
+import { globSync } from "glob";
+import { fixtureRoot } from "./util";
+import { toMatchFile } from "jest-file-snapshot";
+import * as plugin from "../src/index";
+import fs from "fs";
+
+expect.extend({ toMatchFile });
+const snapshotDir = path.join(__dirname, "__file_snapshots__");
+
+const allFixtures = globSync(["**/*.ts", "**/*.cts", "**/*.mts", "**/*.tsx"], { cwd: fixtureRoot });
+
+function getLintSnapshotPath(fixture: string): string {
+  return path.join(snapshotDir, `${fixture}.lint`);
+}
+
+function getAllLintSnapshots() {
+  return new Set(globSync("**/*.lint", { cwd: snapshotDir, absolute: true }));
+}
+
+function getAllExpectedLintSnapshots() {
+  return new Set(allFixtures.map(getLintSnapshotPath));
+}
+
+let eslint: ESLint;
+
+beforeAll(() => {
+  eslint = new ESLint({
+    cwd: fixtureRoot,
+    plugins: { [plugin.meta.name]: plugin },
+  });
+});
+
+afterAll(() => {
+  eslint = undefined as any;
+});
+
+// Force one test per fixture so we can see when a file has no errors.
+for (const fixture of allFixtures) {
+  describe(`fixture ${fixture}`, () => {
+    it("should lint", async () => {
+      const results = await eslint.lintFiles([fixture]);
+      for (const result of results) {
+        result.filePath = path.relative(fixtureRoot, result.filePath);
+      }
+      const formatter = await eslint.loadFormatter("stylish");
+      const formatted = await formatter.format(results);
+      const resultText = stripAnsi(formatted).trim() || "No errors";
+      expect(resultText).not.toContain("Parsing error");
+      const newOutput = formatResultsWithInlineErrors(results);
+      expect(resultText + "\n\n" + newOutput).toMatchFile(getLintSnapshotPath(fixture));
+    });
+  });
+}
+
+function formatResultsWithInlineErrors(results: ESLint.LintResult[]): string {
+  const output: string[] = [];
+
+  function pushMessage(message: Linter.LintMessage): void {
+    const ruleId = message.ruleId;
+    if (!ruleId) {
+      throw new Error("Expected ruleId");
+    }
+    const lines = message.message.split(/\r?\n/);
+    for (let i = 0; i < lines.length; i++) {
+      const line = lines[i];
+      const prefix = `!!! ${i === 0 ? ruleId : " ".repeat(ruleId.length)}: `;
+      output.push(prefix + line);
+    }
+  }
+
+  const indent = "    ";
+
+  for (const result of results) {
+    output.push(`==== ${result.filePath} ====`);
+    output.push("");
+
+    const sourceText = fs.readFileSync(path.join(fixtureRoot, result.filePath), "utf-8");
+
+    const lines = sourceText.split(/\r?\n/);
+
+    for (let i = 0; i < lines.length; i++) {
+      const line = lines[i];
+      output.push(indent + line);
+
+      for (const message of result.messages) {
+        const startLine = message.line - 1;
+        const endLine = message.endLine === undefined ? startLine : message.endLine - 1;
+        const startColumn = message.column - 1;
+        const endColumn = message.endColumn === undefined ? startColumn : message.endColumn - 1;
+        if (i < startLine || i > endLine) {
+          continue;
+        }
+        if (i === startLine) {
+          const squiggle = "~".repeat(Math.max(1, endColumn - startColumn));
+          output.push(indent + " ".repeat(startColumn) + squiggle);
+          pushMessage(message);
+        } else {
+          const squiggle = "~".repeat(Math.max(1, line.length - startColumn));
+          output.push(indent + squiggle);
+        }
+      }
+    }
+
+    output.push("");
+  }
+
+  return output.join("\n").trim() + "\n";
+}
+
+// Similar to https://github.com/storybookjs/storybook/blob/df357020e010f49e7c325942f0c891e6702527d6/code/addons/storyshots-core/src/api/integrityTestTemplate.ts
+describe("lint snapshots", () => {
+  it("abandoned snapshots", () => {
+    const expectedSnapshots = getAllExpectedLintSnapshots();
+    const actualSnapshots = getAllLintSnapshots();
+    const abandonedSnapshots = [...actualSnapshots].filter((s) => !expectedSnapshots.has(s));
+
+    if (abandonedSnapshots.length === 0) {
+      return;
+    }
+
+    // https://github.com/jestjs/jest/issues/8732#issuecomment-516445064
+    if (expect.getState().snapshotState._updateSnapshot === "all") {
+      for (const abandoned of abandonedSnapshots) {
+        fs.rmSync(abandoned);
+      }
+      return;
+    }
+
+    expect(abandonedSnapshots).toHaveLength(0);
+  });
+});

package/test/fixtures/.eslintrc.cjs

@@ -0,0 +1,4 @@
+module.exports = {
+    root: true,
+    extends: ["plugin:@definitelytyped/all"],
+};

package/test/fixtures/types/export-just-namespace/bad1.d.ts

@@ -0,0 +1,2 @@
+export = Stuff;
+namespace Stuff {}

package/test/fixtures/types/export-just-namespace/bad2.d.ts

@@ -0,0 +1,2 @@
+namespace Stuff {}
+export = Stuff;

package/test/fixtures/types/export-just-namespace/bad3.d.ts

@@ -0,0 +1,3 @@
+namespace Stuff {}
+const other = "code";
+export = Stuff;

package/test/fixtures/types/export-just-namespace/good1.d.ts

@@ -0,0 +1 @@
+export const value = 3;

package/test/fixtures/types/export-just-namespace/good2.d.ts

@@ -0,0 +1 @@
+export default class Hello {}

package/test/fixtures/types/export-just-namespace/good3.d.ts

@@ -0,0 +1 @@
+import * as fs from "fs";

package/test/fixtures/types/export-just-namespace/good4.d.ts

@@ -0,0 +1 @@
+const value = 123;

package/test/fixtures/types/export-just-namespace/good5.d.ts

@@ -0,0 +1 @@
+export = stuff;

package/test/fixtures/types/export-just-namespace/good6.d.ts

@@ -0,0 +1 @@
+export = createStuff();

package/test/fixtures/types/export-just-namespace/good7.d.ts

@@ -0,0 +1,3 @@
+class Stuff {}
+namespace Stuff {}
+export = Stuff;

package/test/fixtures/types/export-just-namespace/good8.d.ts

@@ -0,0 +1,3 @@
+export = First
+namespace First {}
+declare function First()

package/test/fixtures/types/export-just-namespace/good9.d.ts

@@ -0,0 +1,3 @@
+declare namespace Second {}
+export = Second
+declare function Second<U, S>(s: U): S

package/test/fixtures/types/export-just-namespace/package.json

@@ -0,0 +1,8 @@
+{
+    "name": "@types/export-just-namespace",
+    "version": "2.0.9999",
+    "owners": [],
+    "devDependencies": {
+        "@types/export-just-namespace": "workspace:."
+    }
+}

package/test/fixtures/types/export-just-namespace/tsconfig.json

@@ -0,0 +1,31 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6",
+            "dom"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "good1.d.ts",
+        "good2.d.ts",
+        "good3.d.ts",
+        "good4.d.ts",
+        "good5.d.ts",
+        "good6.d.ts",
+        "good7.d.ts",
+        "good8.d.ts",
+        "good9.d.ts",
+        "bad1.d.ts",
+        "bad2.d.ts",
+        "bad3.d.ts",
+        "export-just-namespace-tests.ts"
+    ]
+}

package/test/fixtures/types/no-any-union/bad.d.ts

@@ -0,0 +1 @@
+export const y: string | any;

package/test/fixtures/types/no-any-union/index.d.ts

@@ -0,0 +1 @@
+export const x: any;

package/test/fixtures/types/no-any-union/no-any-union-tests.ts

@@ -0,0 +1 @@
+export const z: string | any;

package/test/fixtures/types/no-any-union/package.json

@@ -0,0 +1,8 @@
+{
+    "name": "@types/no-any-union",
+    "version": "2.0.9999",
+    "owners": [],
+    "devDependencies": {
+        "@types/no-self-union": "workspace:."
+    }
+}

package/test/fixtures/types/no-any-union/tsconfig.json

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

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

@@ -15,6 +15,6 @@
     },
     "files": [
         "index.d.ts",
-        "no-relative-references-tests.ts"
+        "no-bad-reference-tests.ts"
     ]
 }

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

@@ -15,6 +15,6 @@
     },
     "files": [
         "index.d.ts",
-        "no-relative-references-tests.ts"
+        "no-bad-reference-tests.ts"
     ]
 }

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

@@ -15,6 +15,6 @@
     },
     "files": [
         "index.d.ts",
-        "no-relative-references-tests.ts"
+        "no-bad-reference-tests.ts"
     ]
 }

package/test/fixtures/types/no-const-enum/bad.d.ts

@@ -0,0 +1 @@
+const enum E { }

package/test/fixtures/types/no-const-enum/index.d.ts

@@ -0,0 +1 @@
+enum F {}

package/test/fixtures/types/no-const-enum/package.json

@@ -0,0 +1,8 @@
+{
+    "name": "@types/no-const-enum",
+    "version": "2.0.9999",
+    "owners": [],
+    "devDependencies": {
+        "@types/no-self-union": "workspace:."
+    }
+}

package/test/fixtures/types/no-const-enum/tsconfig.json

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

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

@@ -0,0 +1,6 @@
+export class C { }
+/// <reference types="terms" />
+
+
+
+/// <reference types="blah" />

package/test/fixtures/types/no-dead-reference/bad2.d.ts

@@ -0,0 +1,3 @@
+export class C { }
+/// <reference types="terms" />
+/// <reference types="multiple" />

package/test/fixtures/types/no-dead-reference/bad3.d.ts

@@ -0,0 +1,5 @@
+export class C { }
+/// <reference types="terms" />
+export class D { }
+/// <reference types="multiple" />
+export class E { }

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

@@ -0,0 +1,2 @@
+/// <reference types="tones" />
+export class K {}

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

@@ -0,0 +1,8 @@
+{
+    "name": "@types/no-dead-reference",
+    "version": "2.0.9999",
+    "owners": [],
+    "devDependencies": {
+        "@types/no-self-union": "workspace:."
+    }
+}

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

@@ -0,0 +1,23 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6",
+            "dom"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "bad.d.ts",
+        "bad2.d.ts",
+        "bad3.d.ts",
+        "no-dead-reference-tests.ts"
+    ]
+}

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

@@ -15,6 +15,7 @@
     },
     "files": [
         "index.d.ts",
-        "no-import-of-dev-dependencies-tests.ts"
+        "test/deep/import.d.ts",
+        "no-declare-current-package-tests.ts"
     ]
 }

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

@@ -15,6 +15,6 @@
     },
     "files": [
         "index.d.ts",
-        "no-import-of-dev-dependencies-tests.ts"
+        "no-declare-current-package-other-tests.ts"
     ]
 }

package/test/fixtures/types/no-import-default-of-export-equals/bad.d.ts

@@ -0,0 +1,8 @@
+declare module "a" {
+    interface I { i: any }
+    export = I;
+}
+
+declare module "b" {
+    import a from "a";
+}

package/test/fixtures/types/no-import-default-of-export-equals/index.d.ts

@@ -0,0 +1,8 @@
+declare module "agood" {
+    interface I { i: any }
+    export default I;
+}
+
+declare module "bgood" {
+    import a from "agood";
+}

package/test/fixtures/types/no-import-default-of-export-equals/package.json

@@ -0,0 +1,8 @@
+{
+    "name": "@types/no-import-default-of-export-equals",
+    "version": "2.0.9999",
+    "owners": [],
+    "devDependencies": {
+        "@types/no-import-default-of-export-equals": "workspace:."
+    }
+}

package/test/fixtures/types/no-import-default-of-export-equals/tsconfig.json

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

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

@@ -3,3 +3,6 @@
 
 import devdep from "devdep";
 import * as otherdevdep from "otherdevdep";
+
+import devdep2 = require("devdep");
+import otherdevdep2 = require("otherdevdep");

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

@@ -2,3 +2,6 @@
 
 import other from "other";
 import self from "no-import-of-dev-dependencies";
+
+import other2 = require("other");
+import self2 = require("no-import-of-dev-dependencies");

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

@@ -7,3 +7,9 @@ import self from "no-import-of-dev-dependencies";
 
 import devdep from "devdep";
 import * as otherdevdep from "otherdevdep";
+
+import other2 = require("other");
+import self2 = require("no-import-of-dev-dependencies");
+
+import devdep2 = require("devdep");
+import otherdevdep2 = require("otherdevdep");

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

@@ -15,6 +15,7 @@
     },
     "files": [
         "index.d.ts",
+        "bad.d.ts",
         "no-import-of-dev-dependencies-tests.ts"
     ]
 }