Add tests

Author: Andy Hanson

.gitignore

@@ -1,4 +1,3 @@
-.vscode
 bin
 node_modules
 typescript-installs

.vscode/launch.json

@@ -0,0 +1,13 @@
+{
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Launch Program",
+            "program": "${workspaceRoot}/test/test.js",
+            "outFiles": ["${workspaceRoot}/bin"]
+        }
+    ]
+}

package.json

@@ -20,7 +20,8 @@
   "scripts": {
     "watch": "tsc --watch",
     "build": "tsc",
-    "lint": "tslint --project tsconfig.json --type-check --format stylish"
+    "lint": "tslint --project tsconfig.json --type-check --format stylish",
+    "test": "node test/test.js"
   },
   "dependencies": {
     "fs-promise": "^2.0.0",

src/index.ts

@@ -129,7 +129,11 @@ async function test(dirPath: string, options: Options, version: TypeScriptVersio
 
 export interface TestError { message: string; }
 
-async function testWithVersion(dirPath: string, options: Options, version: TypeScriptVersion | "next"): Promise<TestError | undefined> {
+async function testWithVersion(
+		dirPath: string,
+		options: Options,
+		version: TypeScriptVersion | "next",
+		): Promise<TestError | undefined> {
 	await install(version);
 	if (options.noLint) {
 		// Special for old DefinitelyTyped packages that aren't linted yet.

src/lint.ts

@@ -32,7 +32,11 @@ export async function lintWithVersion(
 	return result.failures.length ? { message: result.output } : undefined;
 }
 
-async function getLintConfig(configuration: Configuration, configPath: string, options: Options): Promise<IConfigurationFile> {
+async function getLintConfig(
+		configuration: Configuration,
+		configPath: string,
+		options: Options,
+		): Promise<IConfigurationFile> {
 	if (!await exists(configPath)) {
 		if (options.dt) {
 			throw new Error('On DefinitelyTyped, must include `tslint.json` containing `{ "extends": "../tslint.json" }`');

src/rules/noBadReferenceRule.ts

@@ -14,7 +14,7 @@ export class Rule extends Lint.Rules.AbstractRule {
 	static FAILURE_STRING =
 		"Don't use <reference path> to reference another package. Use an import or <reference types> instead.";
 	static FAILURE_STRING_REFERENCE_IN_TEST =
-		"Don't use <reference path> in test files. Use <reference types> or include the file in 'tsconfig.json'";
+		"Don't use <reference path> in test files. Use <reference types> or include the file in 'tsconfig.json'.";
 
 	apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
 		return this.applyWithFunction(sourceFile, walk);
@@ -26,10 +26,10 @@ function walk(ctx: Lint.WalkContext<void>): void {
 	for (const ref of sourceFile.referencedFiles) {
 		if (sourceFile.isDeclarationFile) {
 			if (ref.fileName.startsWith("..")) {
-				ctx.addFailureAt(ref.pos, ref.end, Rule.FAILURE_STRING);
+				ctx.addFailure(ref.pos, ref.end, Rule.FAILURE_STRING);
 			}
 		} else {
-			ctx.addFailureAt(ref.pos, ref.end, Rule.FAILURE_STRING_REFERENCE_IN_TEST);
+			ctx.addFailure(ref.pos, ref.end, Rule.FAILURE_STRING_REFERENCE_IN_TEST);
 		}
 	}
 }

src/rules/noDeadReferenceRule.ts

@@ -20,18 +20,26 @@ export class Rule extends Lint.Rules.AbstractRule {
 }
 
 function walk(ctx: Lint.WalkContext<void>): void {
-	const { sourceFile } = ctx;
-	if (!sourceFile.statements.length) {
+	const { sourceFile: { statements, text } } = ctx;
+	if (!statements.length) {
 		return;
 	}
 
 	// 'm' flag makes it multiline, so `^` matches the beginning of any line.
 	// 'g' flag lets us set rgx.lastIndex
-	const rgx = /^\s*\/\/\/ <reference/mg;
+	const rgx = /^\s*(\/\/\/ <reference)/mg;
+
 	// Start search at the first statement. (`/// <reference>` before that is OK.)
-	rgx.lastIndex =  sourceFile.statements[0].getStart();
-	const match = rgx.exec(sourceFile.text);
-	if (match !== null) {
-		ctx.addFailureAt(match.index, 0, Rule.FAILURE_STRING);
+	rgx.lastIndex = statements[0].getStart();
+
+	while (true) {
+		const match = rgx.exec(text);
+		if (match === null) {
+			break;
+		}
+
+		const length = match[1].length;
+		const start = match.index + match[0].length - length;
+		ctx.addFailureAt(start, length, Rule.FAILURE_STRING);
 	}
 }

src/rules/noPaddingRule.ts

@@ -2,7 +2,7 @@ import * as Lint from "tslint";
 import * as ts from "typescript";
 
 export class Rule extends Lint.Rules.AbstractRule {
-	public static metadata: Lint.IRuleMetadata = {
+	static metadata: Lint.IRuleMetadata = {
 		ruleName: "no-padding",
 		description: "Forbids unnecessary 'export' or 'declare' modifiers in declaration files.",
 		optionsDescription: "Not configurable.",

src/rules/noRedundantModifiersRule.ts

@@ -2,7 +2,7 @@ import * as Lint from "tslint";
 import * as ts from "typescript";
 
 export class Rule extends Lint.Rules.AbstractRule {
-	public static metadata: Lint.IRuleMetadata = {
+	static metadata: Lint.IRuleMetadata = {
 		ruleName: "no-redundant-modifiers",
 		description: "Forbids unnecessary 'export' or 'declare' modifiers in declaration files.",
 		optionsDescription: "Not configurable.",
@@ -37,8 +37,10 @@ function walk(ctx: Lint.WalkContext<void>): void {
 					// Types do not need 'declare'.
 					switch (node.kind) {
 						case ts.SyntaxKind.InterfaceDeclaration:
-						case ts.SyntaxKind.TypeAliasDeclaration:
-							ctx.addFailureAtNode(node, "'declare' keyword is redundant here.");
+						case ts.SyntaxKind.TypeAliasDeclaration: {
+							const { name } = node as ts.TypeAliasDeclaration | ts.InterfaceDeclaration;
+							ctx.addFailureAtNode(name, "'declare' keyword is redundant here.");
+						}
 					}
 				}
 			}

src/rules/noRelativeImportInTestRule.ts

@@ -2,7 +2,7 @@ import * as Lint from "tslint";
 import * as ts from "typescript";
 
 export class Rule extends Lint.Rules.TypedRule {
-	public static metadata: Lint.IRuleMetadata = {
+	static metadata: Lint.IRuleMetadata = {
 		ruleName: "no-relative-import-in-test",
 		description: "Forbids test (non-declaration) files to use relative imports.",
 		optionsDescription: "Not configurable.",

src/rules/noUselessFilesRule.ts

@@ -5,7 +5,7 @@ import * as ts from "typescript";
 // Remove when that PR is in.
 
 export class Rule extends Lint.Rules.AbstractRule {
-	public static metadata: Lint.IRuleMetadata = {
+	static metadata: Lint.IRuleMetadata = {
 		ruleName: "no-useless-files",
 		description: "Forbids files with no content.",
 		optionsDescription: "Not configurable.",
@@ -14,9 +14,9 @@ export class Rule extends Lint.Rules.AbstractRule {
 		typescriptOnly: false,
 	};
 
-	public static FAILURE_STRING = "File has no content.";
+	static FAILURE_STRING = "File has no content.";
 
-	public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
+	apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
 		if (sourceFile.statements.length) {
 			return [];
 		}

src/rules/noVarRule.ts

@@ -4,7 +4,7 @@ import * as ts from "typescript";
 // TODO: pull request to update tslint's `no-var-keyword`
 
 export class Rule extends Lint.Rules.AbstractRule {
-	public static metadata: Lint.IRuleMetadata = {
+	static metadata: Lint.IRuleMetadata = {
 		ruleName: "no-var",
 		description: "Forbids 'var'.",
 		optionsDescription: "Not configurable.",
@@ -13,9 +13,9 @@ export class Rule extends Lint.Rules.AbstractRule {
 		typescriptOnly: false,
 	};
 
-	public static FAILURE_STRING = "Do not use 'var'.";
+	static FAILURE_STRING = "Do not use 'var'.";
 
-	public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
+	apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
 		return this.applyWithFunction(sourceFile, walk);
 	}
 }

src/rules/preferDeclareFunctionRule.ts

@@ -2,7 +2,7 @@ import * as Lint from "tslint";
 import * as ts from "typescript";
 
 export class Rule extends Lint.Rules.AbstractRule {
-	public static metadata: Lint.IRuleMetadata = {
+	static metadata: Lint.IRuleMetadata = {
 		ruleName: "prefer-declare-function",
 		description: "Forbids `export const x = () => void`.",
 		optionsDescription: "Not configurable.",
@@ -11,9 +11,9 @@ export class Rule extends Lint.Rules.AbstractRule {
 		typescriptOnly: true,
 	};
 
-	public static FAILURE_STRING = "Use a function declaration instead of a variable of function type.";
+	static FAILURE_STRING = "Use a function declaration instead of a variable of function type.";
 
-	public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
+	apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
 		return this.applyWithFunction(sourceFile, walk);
 	}
 }

src/rules/trimFileRule.ts

@@ -2,7 +2,7 @@ import * as Lint from "tslint";
 import * as ts from "typescript";
 
 export class Rule extends Lint.Rules.AbstractRule {
-	public static metadata: Lint.IRuleMetadata = {
+	static metadata: Lint.IRuleMetadata = {
 		ruleName: "trim-file",
 		description: "Forbids leading/trailing blank lines in a file. Allows file to end in '\n'.",
 		optionsDescription: "Not configurable.",
@@ -11,10 +11,11 @@ export class Rule extends Lint.Rules.AbstractRule {
 		typescriptOnly: false,
 	};
 
-	public static FAILURE_STRING_LEADING = "File should not begin with a blank line.";
-	public static FAILURE_STRING_TRAILING = "File should not end with a blank line. (Ending in '\\n' OK, ending in '\\n\\n' not OK.)";
+	static FAILURE_STRING_LEADING = "File should not begin with a blank line.";
+	static FAILURE_STRING_TRAILING =
+		"File should not end with a blank line. (Ending in '\\n' OK, ending in '\\n\\n' not OK.)";
 
-	public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
+	apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
 		return this.applyWithFunction(sourceFile, walk);
 	}
 }
@@ -26,6 +27,6 @@ function walk(ctx: Lint.WalkContext<void>): void {
 	}
 
 	if (text.endsWith("\n\n") || text.endsWith("\r\n\r\n")) {
-		ctx.addFailureAt(text.length - 1, 1, Rule.FAILURE_STRING_TRAILING);
+		ctx.addFailureAt(text.length - 2, 1, Rule.FAILURE_STRING_TRAILING);
 	}
 }

test/dt-header/correct/index.d.ts.lint

@@ -0,0 +1,4 @@
+// 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

test/dt-header/correct/notIndex.d.ts.lint

@@ -0,0 +1,5 @@
+{
+  "rules": {
+    "dt-header": true
+  }
+}

test/dt-header/correct/tslint.json

@@ -0,0 +1,5 @@
+// Type definitions for dt-header v1.0.3
+                        ~ [Error parsing header. Expected: foo MAJOR.MINOR (patch version not allowed)]
+// Project: https://github.com/bobby-headers/dt-header
+// Definitions by: Jane Doe <https://github.com/janedoe>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

test/dt-header/wrong/index.d.ts.lint

@@ -0,0 +1,2 @@
+// Type definitions for
+~~~~~~~~~~~~~~~~~~~~~~~ [Header should only be in `index.d.ts`.]

test/dt-header/wrong/notIndex.d.ts.lint

@@ -0,0 +1,5 @@
+{
+  "rules": {
+    "dt-header": true
+  }
+}

test/dt-header/wrong/tslint.json

@@ -0,0 +1,5 @@
+namespace N {
+    export const x: number;
+}
+function N(): void;
+export = N;

test/export-just-namespace/ok.d.ts.lint

@@ -0,0 +1,5 @@
+namespace N {
+    export const x: number;
+}
+export = N;
+~~~~~~~~~~~ [Instead of `export =`-ing a namespace, use the body of the namespace as the module body.]

test/export-just-namespace/test.d.ts.lint

@@ -0,0 +1,5 @@
+{
+  "rules": {
+    "export-just-namespace": true
+  }
+}

test/export-just-namespace/tslint.json

@@ -0,0 +1,4 @@
+/// <reference path="../foo" />
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~  [Don't use <reference path> to reference another package. Use an import or <reference types> instead.]
+
+/// <reference path="foo" />

test/no-bad-reference/decl.d.ts.lint

@@ -0,0 +1,7 @@
+/// <reference path="../foo" />
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~  [0]
+
+/// <reference path="foo" />
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~  [0]
+
+[0]: Don't use <reference path> in test files. Use <reference types> or include the file in 'tsconfig.json'.

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

@@ -0,0 +1,5 @@
+{
+  "rules": {
+    "no-bad-reference": true
+  }
+}

test/no-bad-reference/tslint.json

@@ -0,0 +1,8 @@
+/// <reference types="foo" />
+import * as bar from "bar";
+/// <reference path="baz" />
+~~~~~~~~~~~~~~ [0]
+    /// <reference types="bang" />
+    ~~~~~~~~~~~~~~ [0]
+
+[0]: `/// <reference>` directive must be at top of file to take effect.

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

@@ -0,0 +1,5 @@
+{
+  "rules": {
+    "no-dead-reference": true
+  }
+}

test/no-dead-reference/tslint.json

@@ -0,0 +1,27 @@
+function f() {
+             ~ [Don't leave a blank line after '{']
+
+    return [
+           ~ [Don't leave a blank line after '[']
+
+        f(
+         ~ [Don't leave a blank line after '(']
+
+            0
+
+        )
+        ~ [Don't leave a blank line before ')']
+
+    ];
+    ~ [Don't leave a blank line before ']']
+
+}
+~ [Don't leave a blank line before '}']
+
+function f() {
+    return [
+        f(
+            0
+        )
+    ];
+}

test/no-padding/test.ts.lint

@@ -0,0 +1,5 @@
+{
+  "rules": {
+    "no-padding": true
+  }
+}

test/no-padding/tslint.json

@@ -0,0 +1,11 @@
+declare function f(): void;
+
+declare module "m" {}
+
+declare type T = number;
+             ~ [0]
+
+declare interface I {}
+                  ~ [0]
+
+[0]: 'declare' keyword is redundant here.

test/no-redundant-modifiers/testAmbient.d.ts.lint

@@ -0,0 +1,11 @@
+export declare function f(): void;
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ['export declare' is redundant, just use 'export'.]
+
+declare function g(): void;
+~~~~~~~~~~~~~~~~~~~~~~~~~~~  [Prefer 'export' to 'declare' in an external module.]
+
+export namespace N {
+    export function f(): void;
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~ ['export' keyword is redundant here.]
+    // TS compiler warns for 'declare' here.
+}

test/no-redundant-modifiers/testModule.d.ts.lint

@@ -0,0 +1,5 @@
+{
+  "rules": {
+    "no-redundant-modifiers": true
+  }
+}

test/no-redundant-modifiers/tslint.json

@@ -0,0 +1 @@
+import { x } from "./declarationFile.d";

test/no-relative-import-in-test/decl.d.ts.lint

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

test/no-relative-import-in-test/declarationFile.d.ts

@@ -0,0 +1,5 @@
+import { x } from "./declarationFile.d";
+                  ~~~~~~~~~~~~~~~~~~~~~ [0]
+import { y } from "./testFile";
+
+[0]: Test file should not use a relative import. Use a global import as if this were a user of the package.