@definitelytyped/dtslint 0.0.166 → 0.0.167-next.1

package/test/dt-header.test.ts

@@ -0,0 +1,189 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+
+import * as dtHeader from "../src/rules/dt-header";
+
+const ruleTester = new ESLintUtils.RuleTester({
+  parser: "@typescript-eslint/parser",
+});
+
+ruleTester.run("dt-header", dtHeader, {
+  invalid: [
+    {
+      code: ``,
+      errors: [
+        {
+          column: 2,
+          data: {
+            expected: "/\\/\\/ Type definitions for (non-npm package )?/",
+          },
+          line: 1,
+          messageId: "parseError",
+        },
+      ],
+      filename: "types/blank/index.d.ts",
+    },
+    {
+      code: `
+      // ...
+      `,
+      errors: [
+        {
+          column: 1,
+          data: {
+            expected: "/\\/\\/ Type definitions for (non-npm package )?/",
+          },
+          line: 2,
+          messageId: "parseError",
+        },
+      ],
+      filename: "types/only-comment/index.d.ts",
+    },
+    {
+      code: `
+// Type definitions for dt-header 0.75
+// Project: https://github.com/bobby-headers/dt-header
+// Definitions by: Jane Doe <https://github.com/janedoe>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// Minimum TypeScript Version: 3.1
+      
+`,
+      errors: [
+        {
+          column: 1,
+          data: {
+            expected: "/\\/\\/ Type definitions for (non-npm package )?/",
+          },
+          line: 2,
+          messageId: "parseError",
+        },
+      ],
+      filename: "types/start-with-whitespace/index.d.ts",
+    },
+    {
+      code: `// Type definitions for dt-header 1.0
+// Project: https://github.com/bobby-headers/dt-header
+// Definitions by: Jane Doe <https://github.ORG/janedoe>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+`,
+      errors: [
+        {
+          column: 30,
+          data: {
+            expected: "/\\<https\\:\\/\\/github\\.com\\/([a-zA-Z\\d\\-]+)\\/?\\>/",
+          },
+          line: 3,
+          messageId: "parseError",
+        },
+      ],
+      filename: "types/bad-url-github-org/index.d.ts",
+    },
+    {
+      code: `// Type definitions for dt-header 1.0
+// Project: https://github.com/bobby-headers/dt-header
+// Definitions by: Jane Doe <https://github.com/jane doe>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+`,
+      errors: [
+        {
+          column: 30,
+          data: {
+            expected: "/\\<https\\:\\/\\/github\\.com\\/([a-zA-Z\\d\\-]+)\\/?\\>/",
+          },
+          line: 3,
+          messageId: "parseError",
+        },
+      ],
+      filename: "types/bad-url-space/index.d.ts",
+    },
+    {
+      code: `// Type definitions for dt-header 1.0
+// Project: https://github.com/not/important
+// Definitions by: My Self <https://github.com/me>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+      
+`,
+      errors: [
+        {
+          column: 1,
+          endColumn: 27,
+          line: 3,
+          messageId: "definitionsBy",
+        },
+      ],
+      filename: "types/bad-username/index.d.ts",
+    },
+    {
+      code: `// Type definitions for dt-header v1.0.3
+// Project: https://github.com/bobby-headers/dt-header
+// Definitions by: Jane Doe <https://github.com/janedoe>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+`,
+      errors: [
+        {
+          column: 26,
+          data: {
+            expected: "foo MAJOR.MINOR (patch version not allowed)",
+          },
+          line: 1,
+          messageId: "parseError",
+        },
+      ],
+      filename: "types/foo/index.d.ts",
+    },
+    {
+      code: `// Type definitions for
+`,
+      errors: [
+        {
+          column: 1,
+          endColumn: 24,
+          line: 1,
+          messageId: "typeDefinitionsFor",
+        },
+      ],
+      filename: "types/foo/notIndex.d.ts",
+    },
+  ],
+  valid: [
+    ``,
+    {
+      code: `// This isn't the main index
+`,
+      filename: "types/foo/bar/index.d.ts",
+    },
+    {
+      code: `// Type definitions for dt-header 0.75
+// Project: https://github.com/bobby-headers/dt-header
+// Definitions by: Jane Doe <https://github.com/janedoe>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// Minimum TypeScript Version: 3.1
+      
+`,
+      filename: "types/foo/v0.75/index.d.ts",
+    },
+    {
+      code: `// Type definitions for dt-header 1.0
+// Project: https://github.com/bobby-headers/dt-header
+// Definitions by: Jane Doe <https://github.com/janedoe>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// Minimum TypeScript Version: 3.1
+      
+`,
+      filename: "types/foo/v1/index.d.ts",
+    },
+    {
+      code: `// Type definitions for dt-header 2.0
+// Project: https://github.com/bobby-headers/dt-header
+// Definitions by: Jane Doe <https://github.com/janedoe>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// Minimum TypeScript Version: 3.1
+      
+`,
+      filename: "types/foo/index.d.ts",
+    },
+    {
+      code: ``,
+      filename: "types/foo/notIndex.d.ts",
+    },
+  ],
+});

package/test/export-just-namespace.test.ts

@@ -0,0 +1,70 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+
+import * as exportJustNamespace from "../src/rules/export-just-namespace";
+
+const ruleTester = new ESLintUtils.RuleTester({
+  parser: "@typescript-eslint/parser",
+});
+
+ruleTester.run("export-just-namespace", exportJustNamespace, {
+  invalid: [
+    {
+      code: `
+export = Stuff;
+namespace Stuff {}
+`,
+      errors: [
+        {
+          line: 2,
+          messageId: "useTheBody",
+        },
+      ],
+    },
+    {
+      code: `
+namespace Stuff {}
+export = Stuff;
+`,
+      errors: [
+        {
+          line: 3,
+          messageId: "useTheBody",
+        },
+      ],
+    },
+    {
+      code: `
+namespace Stuff {}
+const other = "code";
+export = Stuff;
+`,
+      errors: [
+        {
+          line: 4,
+          messageId: "useTheBody",
+        },
+      ],
+    },
+  ],
+  valid: [
+    `export const value = 3;`,
+    `export default class Hello {}`,
+    'import * as fs from "fs";',
+    "const value = 123;",
+    `export = stuff;`,
+    `export = createStuff();`,
+    `
+class Stuff {}
+namespace Stuff {}
+export = Stuff;
+`,
+    `export = First
+namespace First {}
+declare function First()
+`,
+    `declare namespace Second {}
+export = Second
+declare function Second<U, S>(s: U): S
+`,
+  ],
+});

package/test/no-any-union.test.ts

@@ -0,0 +1,22 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+
+import * as noAnyUnion from "../src/rules/no-any-union";
+
+const ruleTester = new ESLintUtils.RuleTester({
+  parser: "@typescript-eslint/parser",
+});
+
+ruleTester.run("no-any-union", noAnyUnion, {
+  invalid: [
+    {
+      code: `export const y: string | any;`,
+      errors: [
+        {
+          line: 1,
+          messageId: "anyUnion",
+        },
+      ],
+    },
+  ],
+  valid: [`export const x: any;`],
+});

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

@@ -0,0 +1,66 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+
+import * as noBadReference from "../src/rules/no-bad-reference";
+
+const ruleTester = new ESLintUtils.RuleTester({
+  parser: "@typescript-eslint/parser",
+});
+
+ruleTester.run("no-bad-reference", noBadReference, {
+  invalid: [
+    {
+      code: `/// <reference path="../other" />`,
+      errors: [
+        {
+          column: 20,
+          endColumn: 28,
+          line: 1,
+          messageId: "referencePathTest",
+        },
+      ],
+      filename: "types.ts",
+    },
+    {
+      code: `/// <reference path="other" />`,
+      errors: [
+        {
+          column: 20,
+          endColumn: 25,
+          line: 1,
+          messageId: "referencePathTest",
+        },
+      ],
+      filename: "types.ts",
+    },
+    {
+      code: `/// <reference path="../other" />`,
+      errors: [
+        {
+          column: 20,
+          endColumn: 28,
+          line: 1,
+          messageId: "referencePathPackage",
+        },
+      ],
+      filename: "types.d.ts",
+    },
+  ],
+  valid: [
+    ``,
+    `// unrelated comment`,
+    `/// similar (reference path) comment`,
+    {
+      code: `/// <reference path="other" />`,
+      filename: "types.d.ts",
+    },
+    {
+      code: `/// <reference path="./other" />`,
+      filename: "types.d.ts",
+    },
+    {
+      code: `/// <reference path="other" />
+/// <reference path="other2" />`,
+      filename: "types.d.ts",
+    },
+  ],
+});

package/test/no-const-enum.test.ts

@@ -0,0 +1,22 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+
+import * as noConstEnum from "../src/rules/no-const-enum";
+
+const ruleTester = new ESLintUtils.RuleTester({
+  parser: "@typescript-eslint/parser",
+});
+
+ruleTester.run("no-const-enum", noConstEnum, {
+  invalid: [
+    {
+      code: ` const enum E { } `,
+      errors: [
+        {
+          line: 1,
+          messageId: "constEnum",
+        },
+      ],
+    },
+  ],
+  valid: [` enum F {}`],
+});

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

@@ -0,0 +1,66 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+
+import * as noDeadReference from "../src/rules/no-dead-reference";
+
+const ruleTester = new ESLintUtils.RuleTester({
+  parser: "@typescript-eslint/parser",
+});
+
+ruleTester.run("no-dead-reference", noDeadReference, {
+  invalid: [
+    {
+      code: `
+export class C { }
+/// <reference types="terms" />
+`,
+      errors: [
+        {
+          line: 3,
+          messageId: "referenceAtTop",
+        },
+      ],
+    },
+    {
+      code: `
+export class C { }
+/// <reference types="terms" />
+/// <reference types="multiple" />
+`,
+      errors: [
+        {
+          line: 3,
+          messageId: "referenceAtTop",
+        },
+        {
+          line: 4,
+          messageId: "referenceAtTop",
+        },
+      ],
+    },
+    {
+      code: `
+export class C { }
+/// <reference types="terms" />
+export class D { }
+/// <reference types="multiple" />
+export class E { }
+`,
+      errors: [
+        {
+          line: 3,
+          messageId: "referenceAtTop",
+        },
+        {
+          line: 5,
+          messageId: "referenceAtTop",
+        },
+      ],
+    },
+  ],
+  valid: [
+    `
+/// <reference types="tones" />
+export class K {}
+`,
+  ],
+});

package/test/no-declare-current-package.test.ts

@@ -0,0 +1,61 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+
+import * as noDeclareCurrentPackage from "../src/rules/no-declare-current-package";
+
+const ruleTester = new ESLintUtils.RuleTester({
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: 2018,
+    tsconfigRootDir: __dirname,
+    project: "./tsconfig.no-declare-current-package.json",
+  },
+});
+
+ruleTester.run("no-declare-current-package", noDeclareCurrentPackage, {
+  invalid: [
+    {
+      filename: "index.d.ts",
+      code: `module "test" { }`,
+      errors: [
+        {
+          line: 1,
+          messageId: "noDeclareCurrentPackage",
+        },
+      ],
+    },
+  ],
+  valid: [
+    {
+      filename: "index.d.ts",
+      code: `module "foo" { }
+module "foo/bar/baz" { }
+`,
+    },
+  ],
+});
+// needed because you can only test one non-file.ts file per tsconfig
+// (and tsconfig is required for typed-based rules)
+const ruleTester2 = new ESLintUtils.RuleTester({
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: 2018,
+    tsconfigRootDir: __dirname,
+    project: "./tsconfig.no-declare-current-package2.json",
+  },
+});
+
+ruleTester2.run("no-declare-current-package", noDeclareCurrentPackage, {
+  invalid: [
+    {
+      filename: "deep/import.d.ts",
+      code: `module "test/deep/import" { }`,
+      errors: [
+        {
+          line: 1,
+          messageId: "noDeclareCurrentPackage",
+        },
+      ],
+    },
+  ],
+  valid: [],
+});

package/test/no-import-default-of-export-equals.test.ts

@@ -0,0 +1,49 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+
+import * as noImportDefaultOfExportEquals from "../src/rules/no-import-default-of-export-equals";
+
+const ruleTester = new ESLintUtils.RuleTester({
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: 2018,
+    tsconfigRootDir: __dirname,
+    project: "./tsconfig.no-import-default-of-export-equals.json",
+  },
+});
+
+ruleTester.run("no-import-default-of-export-equals", noImportDefaultOfExportEquals, {
+  invalid: [
+    {
+      filename: "index.d.ts",
+      code: `declare module "a" {
+    interface I {}
+    export = I;
+}
+
+declare module "b" {
+import a from "a";
+}`,
+      errors: [
+        {
+          line: 7,
+          messageId: "noImportDefaultOfExportEquals",
+          data: { moduleName: "a", importName: "a" },
+        },
+      ],
+    },
+  ],
+  valid: [
+    {
+      filename: "index.d.ts",
+      code: `declare module "a" {
+    interface I {}
+    export default I;
+}
+
+declare module "b" {
+    import a from "a";
+}
+`,
+    },
+  ],
+});

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

@@ -0,0 +1,47 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+import path from "path";
+
+import * as dtHeader from "../src/rules/no-self-import";
+
+const ruleTester = new ESLintUtils.RuleTester({
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: "./tsconfig.no-self-import.json",
+  },
+});
+
+ruleTester.run("no-self-import", dtHeader, {
+  invalid: [
+    {
+      code: `import myself from "this-package";`,
+      errors: [
+        {
+          line: 1,
+          messageId: "useRelativeImport",
+        },
+      ],
+      filename: "this-package/index.d.ts",
+    },
+    {
+      code: `import abc from "this-package/abc.d.ts";`,
+      errors: [
+        {
+          line: 1,
+          messageId: "useRelativeImport",
+        },
+      ],
+      filename: "this-package/index.d.ts",
+    },
+  ],
+  valid: [
+    {
+      code: `import other from "other-package";`,
+      filename: "this-package/index.d.ts",
+    },
+    {
+      code: `import other from "other-package/this-package";`,
+      filename: "this-package/index.d.ts",
+    },
+  ],
+});

package/test/no-single-element-tuple-type.test.ts

@@ -0,0 +1,28 @@
+import { ESLintUtils } from "@typescript-eslint/utils";
+
+import * as noDeclareCurrentPackage from "../src/rules/no-single-element-tuple-type";
+
+const ruleTester = new ESLintUtils.RuleTester({
+  parser: "@typescript-eslint/parser",
+});
+
+ruleTester.run("no-single-element-tuple-type", noDeclareCurrentPackage, {
+  invalid: [
+    {
+      code: `type Test<T> = [T];`,
+      errors: [
+        {
+          line: 1,
+          messageId: "singleElementTupleType",
+        },
+      ],
+    },
+  ],
+  valid: [
+    `type Test = number[];`,
+    `type Test<T> = T;`,
+    `type Test<T> = T[];`,
+    `type Test<T> = [T, number];`,
+    `type Test<T> = [T, T];`,
+  ],
+});