Programmatic apis

.gitignore

@@ -1,3 +1,3 @@
-bin
 node_modules
 typescript-installs
+dist

package.json

@@ -7,8 +7,8 @@
     "dt.json",
     "dtslint.json"
   ],
-  "main": "bin",
-  "bin": "./bin/index.js",
+  "main": "dist",
+  "bin": "./dist/bin/index.js",
   "contributors": [
     "Andy Hanson <[email protected]> (https://github.com/andy-ms)",
     "Dan Vanderkam <[email protected]> (https://github.com/danvk)"

src/bin/index.ts

@@ -0,0 +1,89 @@
+#!/usr/bin/env node
+import { join as joinPaths } from "path";
+
+import { cleanInstalls, installAll, installNext, runTests } from "../";
+
+async function main(): Promise<void> {
+	const args = process.argv.slice(2);
+	let dirPath = process.cwd();
+	let onlyTestTsNext = false;
+	let shouldListen = false;
+
+	for (const arg of args) {
+		switch (arg) {
+			case "--installAll":
+				console.log("Cleaning old installs and installing for all TypeScript versions...");
+				await cleanInstalls();
+				await installAll();
+				return;
+
+			case "--version":
+				console.log(require("../package.json").version);
+				return;
+
+			case "--onlyTestTsNext":
+				onlyTestTsNext = true;
+				break;
+
+			// Only for use by types-publisher.
+			// Listens for { path, onlyTestTsNext } messages and ouputs { path, status }.
+			case "--listen":
+				shouldListen = true;
+				break;
+
+			default:
+				if (arg.startsWith("--")) {
+					console.error(`Unknown option '${arg}'`);
+					usage();
+					process.exit(1);
+				}
+
+				const path = arg.indexOf("@") === 0 && arg.indexOf("/") !== -1
+					// we have a scoped module, e.g. @bla/foo
+					// which should be converted to   bla__foo
+					? arg.substr(1).replace("/", "__")
+					: arg;
+				dirPath = joinPaths(dirPath, path);
+		}
+	}
+
+	if (shouldListen) {
+		listen(dirPath);
+		// Do this *after* to ensure messages sent during installation aren't dropped.
+		await installAll();
+	} else {
+		if (onlyTestTsNext) {
+			await installNext();
+		} else {
+			await installAll();
+		}
+		await runTests(dirPath, onlyTestTsNext);
+	}
+}
+
+function usage(): void {
+	console.error("Usage: dtslint [--version] [--installAll]");
+	console.error("Args:");
+	console.error("  --version        Print version and exit.");
+	console.error("  --installAll     Cleans and installs all TypeScript versions.");
+	console.error("  --onlyTestTsNext Only run with `typescript@next`, not with the minimum version.");
+}
+
+function listen(dirPath: string): void {
+	process.on("message", (message: {}) => {
+		const { path, onlyTestTsNext } = message as { path: string, onlyTestTsNext: boolean };
+		runTests(joinPaths(dirPath, path), onlyTestTsNext)
+			.catch(e => e.stack)
+			.then(maybeError => {
+				process.send!({ path, status: maybeError === undefined ? "OK" : maybeError });
+			})
+			.catch(e => console.error(e.stack));
+	});
+}
+
+if (!module.parent) {
+	main().catch(err => {
+		console.error(err.stack);
+		process.exit(1);
+	});
+}

src/index.ts

@@ -4,89 +4,12 @@ import { readdir, readFile, stat } from "fs-extra";
 import { basename, dirname, join as joinPaths } from "path";
 
 import { checkPackageJson, checkTsconfig } from "./checks";
-import { cleanInstalls, installAll, installNext } from "./installer";
 import { checkTslintJson, lint, TsVersion } from "./lint";
 import { assertDefined, last, mapDefinedAsync, withoutPrefix } from "./util";
 
-async function main(): Promise<void> {
-	const args = process.argv.slice(2);
-	let dirPath = process.cwd();
-	let onlyTestTsNext = false;
-	let shouldListen = false;
+export { cleanInstalls, installAll, installNext } from "./installer";
 
-	for (const arg of args) {
-		switch (arg) {
-			case "--installAll":
-				console.log("Cleaning old installs and installing for all TypeScript versions...");
-				await cleanInstalls();
-				await installAll();
-				return;
-
-			case "--version":
-				console.log(require("../package.json").version);
-				return;
-
-			case "--onlyTestTsNext":
-				onlyTestTsNext = true;
-				break;
-
-			// Only for use by types-publisher.
-			// Listens for { path, onlyTestTsNext } messages and ouputs { path, status }.
-			case "--listen":
-				shouldListen = true;
-				break;
-
-			default:
-				if (arg.startsWith("--")) {
-					console.error(`Unknown option '${arg}'`);
-					usage();
-					process.exit(1);
-				}
-
-				const path = arg.indexOf("@") === 0 && arg.indexOf("/") !== -1
-					// we have a scoped module, e.g. @bla/foo
-					// which should be converted to   bla__foo
-					? arg.substr(1).replace("/", "__")
-					: arg;
-				dirPath = joinPaths(dirPath, path);
-		}
-	}
-
-	if (shouldListen) {
-		listen(dirPath);
-		// Do this *after* to ensure messages sent during installation aren't dropped.
-		await installAll();
-	} else {
-		if (onlyTestTsNext) {
-			await installNext();
-		} else {
-			await installAll();
-		}
-		await runTests(dirPath, onlyTestTsNext);
-	}
-}
-
-function usage(): void {
-	console.error("Usage: dtslint [--version] [--installAll]");
-	console.error("Args:");
-	console.error("  --version        Print version and exit.");
-	console.error("  --installAll     Cleans and installs all TypeScript versions.");
-	console.error("  --onlyTestTsNext Only run with `typescript@next`, not with the minimum version.");
-}
-
-function listen(dirPath: string): void {
-	process.on("message", (message: {}) => {
-		const { path, onlyTestTsNext } = message as { path: string, onlyTestTsNext: boolean };
-		runTests(joinPaths(dirPath, path), onlyTestTsNext)
-			.catch(e => e.stack)
-			.then(maybeError => {
-				process.send!({ path, status: maybeError === undefined ? "OK" : maybeError });
-			})
-			.catch(e => console.error(e.stack));
-	});
-}
-
-async function runTests(dirPath: string, onlyTestTsNext: boolean): Promise<void> {
+export async function runTests(dirPath: string, onlyTestTsNext: boolean): Promise<void> {
 	const isOlderVersion = /^v\d+$/.test(basename(dirPath));
 
 	const indexText = await readFile(joinPaths(dirPath, "index.d.ts"), "utf-8");
@@ -194,10 +117,3 @@ function getTypeScriptVersionFromComment(text: string): TypeScriptVersion | unde
 	}
 	return parseTypeScriptVersionLine(line);
 }
-
-if (!module.parent) {
-	main().catch(err => {
-		console.error(err.stack);
-		process.exit(1);
-	});
-}

test/dt-header/correct/tslint.json

@@ -1,5 +1,5 @@
 {
-  "rulesDirectory": ["../../../bin/rules"],
+  "rulesDirectory": ["../../../dist/rules"],
   "rules": {
     "dt-header": true
   }

test/dt-header/wrong/tslint.json

@@ -1,5 +1,5 @@
 {
-  "rulesDirectory": ["../../../bin/rules"],
+  "rulesDirectory": ["../../../dist/rules"],
   "rules": {
     "dt-header": true
   }

test/expect/tslint.json

@@ -1,5 +1,5 @@
 {
-  "rulesDirectory": ["../../bin/rules"],
+  "rulesDirectory": ["../../dist/rules"],
   "rules": {
     "expect": true
   }

test/export-just-namespace/tslint.json

@@ -1,5 +1,5 @@
 {
-  "rulesDirectory": ["../../bin/rules"],
+  "rulesDirectory": ["../../dist/rules"],
   "rules": {
     "export-just-namespace": true
   }

test/no-any-union/tslint.json

@@ -1,5 +1,5 @@
 {
-    "rulesDirectory": ["../../bin/rules"],
+    "rulesDirectory": ["../../dist/rules"],
     "rules": {
       "no-any-union": true
     }

test/no-bad-reference/tslint.json

@@ -1,5 +1,5 @@
 {
-  "rulesDirectory": ["../../bin/rules"],
+  "rulesDirectory": ["../../dist/rules"],
   "rules": {
     "no-bad-reference": true
   }

test/no-const-enum/tslint.json

@@ -1,5 +1,5 @@
 {
-  "rulesDirectory": ["../../bin/rules"],
+  "rulesDirectory": ["../../dist/rules"],
   "rules": {
     "no-const-enum": true
   }

test/no-dead-reference/tslint.json

@@ -1,5 +1,5 @@
 {
-  "rulesDirectory": ["../../bin/rules"],
+  "rulesDirectory": ["../../dist/rules"],
   "rules": {
     "no-dead-reference": true
   }

test/no-import-default-of-export-equals/bad-ambient-modules/tslint.json

@@ -1,5 +1,5 @@
 {
-  "rulesDirectory": ["../../../bin/rules"],
+  "rulesDirectory": ["../../../dist/rules"],
   "rules": {
     "no-import-default-of-export-equals": true
   }

test/no-import-default-of-export-equals/bad-external-modules/tslint.json

@@ -1,7 +1,6 @@
 {
-    "rulesDirectory": ["../../../bin/rules"],
+    "rulesDirectory": ["../../../dist/rules"],
     "rules": {
       "no-import-default-of-export-equals": true
     }
   }
-

test/no-import-default-of-export-equals/good-ambient-modules/tslint.json

@@ -1,5 +1,5 @@
 {
-  "rulesDirectory": ["../../../bin/rules"],
+  "rulesDirectory": ["../../../dist/rules"],
   "rules": {
     "no-import-default-of-export-equals": true
   }

test/no-padding/tslint.json

@@ -1,5 +1,5 @@
 {
-  "rulesDirectory": ["../../bin/rules"],
+  "rulesDirectory": ["../../dist/rules"],
   "rules": {
     "no-padding": true
   }

test/no-redundant-undefined/tslint.json

@@ -1,5 +1,5 @@
 {
-  "rulesDirectory": ["../../bin/rules"],
+  "rulesDirectory": ["../../dist/rules"],
   "rules": {
     "no-redundant-undefined": true
   }

test/no-relative-import-in-test/tslint.json

@@ -1,5 +1,5 @@
 {
-  "rulesDirectory": ["../../bin/rules"],
+  "rulesDirectory": ["../../dist/rules"],
   "rules": {
     "no-relative-import-in-test": true
   }

test/no-single-declare-module/tslint.json

@@ -1,5 +1,5 @@
 {
-  "rulesDirectory": ["../../bin/rules"],
+  "rulesDirectory": ["../../dist/rules"],
   "rules": {
     "no-single-declare-module": true
   }

test/no-single-element-tuple-type/tslint.json

@@ -1,5 +1,5 @@
 {
-    "rulesDirectory": ["../../bin/rules"],
+    "rulesDirectory": ["../../dist/rules"],
     "rules": {
       "no-single-element-tuple-type": true
     }

test/no-unnecessary-generics/tslint.json

@@ -1,5 +1,5 @@
 {
-    "rulesDirectory": ["../../bin/rules"],
+    "rulesDirectory": ["../../dist/rules"],
     "rules": {
         "no-unnecessary-generics": true
     }

test/no-useless-files/tslint.json

@@ -1,5 +1,5 @@
 {
-  "rulesDirectory": ["../../bin/rules"],
+  "rulesDirectory": ["../../dist/rules"],
   "rules": {
     "no-useless-files": true
   }

test/prefer-declare-function/tslint.json

@@ -1,5 +1,5 @@
 {
-  "rulesDirectory": ["../../bin/rules"],
+  "rulesDirectory": ["../../dist/rules"],
   "rules": {
     "prefer-declare-function": true
   }

test/strict-export-declare-modifiers/tslint.json

@@ -1,5 +1,5 @@
 {
-  "rulesDirectory": ["../../bin/rules"],
+  "rulesDirectory": ["../../dist/rules"],
   "rules": {
     "strict-export-declare-modifiers": true
   }

test/trim-file/tslint.json

@@ -1,5 +1,5 @@
 {
-  "rulesDirectory": ["../../bin/rules"],
+  "rulesDirectory": ["../../dist/rules"],
   "rules": {
     "trim-file": true
   }

test/void-return/tslint.json

@@ -1,5 +1,5 @@
 {
-  "rulesDirectory": ["../../bin/rules"],
+  "rulesDirectory": ["../../dist/rules"],
   "rules": {
     "void-return": true
   }

tsconfig.json

@@ -3,7 +3,7 @@
 		"module": "commonjs",
 		"target": "es6",
 		"lib": ["es2017"],
-		"outDir": "bin",
+		"outDir": "dist",
 		"sourceMap": true,
 		"newLine": "lf",