@definitelytyped/dtslint 0.0.95 → 0.0.97

package/README.md

@@ -154,7 +154,7 @@ npm run watch
 ## Test
 
 Use `npm run test` to run all tests.
-To run a single test: `node node_modules/tslint/bin/tslint --rules-dir bin/rules --test test/expect`.
+To run a single test: `node node_modules/tslint/bin/tslint --rules-dir bin/src/rules --test test/expect`.
 
 ## Publish
 

package/bin/src/checks.d.ts

@@ -0,0 +1,7 @@
+import { TypeScriptVersion } from "@definitelytyped/typescript-versions";
+export declare function checkPackageJson(dirPath: string, typesVersions: readonly TypeScriptVersion[]): Promise<void>;
+export interface DefinitelyTypedInfo {
+    /** "../" or "../../" or "../../../". This should use '/' even on windows. */
+    readonly relativeBaseUrl: string;
+}
+export declare function checkTsconfig(dirPath: string, dt: DefinitelyTypedInfo | undefined): Promise<void>;

package/bin/src/checks.js

@@ -0,0 +1,133 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkTsconfig = exports.checkPackageJson = void 0;
+const header_parser_1 = require("@definitelytyped/header-parser");
+const assert = require("assert");
+const fs_extra_1 = require("fs-extra");
+const path_1 = require("path");
+const util_1 = require("./util");
+async function checkPackageJson(dirPath, typesVersions) {
+    const pkgJsonPath = path_1.join(dirPath, "package.json");
+    const needsTypesVersions = typesVersions.length !== 0;
+    if (!(await fs_extra_1.pathExists(pkgJsonPath))) {
+        if (needsTypesVersions) {
+            throw new Error(`${dirPath}: Must have 'package.json' for "typesVersions"`);
+        }
+        return;
+    }
+    const pkgJson = (await util_1.readJson(pkgJsonPath));
+    if (pkgJson.private !== true) {
+        throw new Error(`${pkgJsonPath} should set \`"private": true\``);
+    }
+    if (needsTypesVersions) {
+        assert.strictEqual(pkgJson.types, "index", `"types" in '${pkgJsonPath}' should be "index".`);
+        const expected = header_parser_1.makeTypesVersionsForPackageJson(typesVersions);
+        assert.deepEqual(pkgJson.typesVersions, expected, `"typesVersions" in '${pkgJsonPath}' is not set right. Should be: ${JSON.stringify(expected, undefined, 4)}`);
+    }
+    for (const key in pkgJson) {
+        // tslint:disable-line forin
+        switch (key) {
+            case "private":
+            case "dependencies":
+            case "license":
+            case "imports":
+            case "exports":
+            case "type":
+                // "private"/"typesVersions"/"types" checked above, "dependencies" / "license" checked by types-publisher,
+                break;
+            case "typesVersions":
+            case "types":
+                if (!needsTypesVersions) {
+                    throw new Error(`${pkgJsonPath} doesn't need to set "${key}" when no 'ts3.x' directories exist.`);
+                }
+                break;
+            default:
+                throw new Error(`${pkgJsonPath} should not include field ${key}`);
+        }
+    }
+}
+exports.checkPackageJson = checkPackageJson;
+async function checkTsconfig(dirPath, dt) {
+    const options = await util_1.getCompilerOptions(dirPath);
+    if (dt) {
+        const { relativeBaseUrl } = dt;
+        const mustHave = {
+            module: "commonjs",
+            noEmit: true,
+            forceConsistentCasingInFileNames: true,
+            baseUrl: relativeBaseUrl,
+            typeRoots: [relativeBaseUrl],
+            types: []
+        };
+        for (const key of Object.getOwnPropertyNames(mustHave)) {
+            const expected = mustHave[key];
+            const actual = options[key];
+            if (!deepEquals(expected, actual)) {
+                throw new Error(`Expected compilerOptions[${JSON.stringify(key)}] === ${JSON.stringify(expected)}`);
+            }
+        }
+        for (const key in options) {
+            // tslint:disable-line forin
+            switch (key) {
+                case "lib":
+                case "noImplicitAny":
+                case "noImplicitThis":
+                case "strict":
+                case "strictNullChecks":
+                case "noUncheckedIndexedAccess":
+                case "strictFunctionTypes":
+                case "esModuleInterop":
+                case "allowSyntheticDefaultImports":
+                    // Allow any value
+                    break;
+                case "target":
+                case "paths":
+                case "jsx":
+                case "jsxFactory":
+                case "experimentalDecorators":
+                case "noUnusedLocals":
+                case "noUnusedParameters":
+                    // OK. "paths" checked further by types-publisher
+                    break;
+                default:
+                    if (!(key in mustHave)) {
+                        throw new Error(`Unexpected compiler option ${key}`);
+                    }
+            }
+        }
+    }
+    if (!("lib" in options)) {
+        throw new Error('Must specify "lib", usually to `"lib": ["es6"]` or `"lib": ["es6", "dom"]`.');
+    }
+    if ("strict" in options) {
+        if (options.strict !== true) {
+            throw new Error('When "strict" is present, it must be set to `true`.');
+        }
+        for (const key of ["noImplicitAny", "noImplicitThis", "strictNullChecks", "strictFunctionTypes"]) {
+            if (key in options) {
+                throw new TypeError(`Expected "${key}" to not be set when "strict" is \`true\`.`);
+            }
+        }
+    }
+    else {
+        for (const key of ["noImplicitAny", "noImplicitThis", "strictNullChecks", "strictFunctionTypes"]) {
+            if (!(key in options)) {
+                throw new Error(`Expected \`"${key}": true\` or \`"${key}": false\`.`);
+            }
+        }
+    }
+    if (options.types && options.types.length) {
+        throw new Error('Use `/// <reference types="..." />` directives in source files and ensure ' +
+            'that the "types" field in your tsconfig is an empty array.');
+    }
+}
+exports.checkTsconfig = checkTsconfig;
+function deepEquals(expected, actual) {
+    if (expected instanceof Array) {
+        return (actual instanceof Array && actual.length === expected.length && expected.every((e, i) => deepEquals(e, actual[i])));
+    }
+    else {
+        return expected === actual;
+    }
+}
+//# sourceMappingURL=checks.js.map

package/bin/src/checks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"checks.js","sourceRoot":"","sources":["../../src/checks.ts"],"names":[],"mappings":";;;AAAA,kEAAiF;AAEjF,iCAAkC;AAClC,uCAAsC;AACtC,+BAAyC;AAEzC,iCAAsD;AAE/C,KAAK,UAAU,gBAAgB,CAAC,OAAe,EAAE,aAA2C;IACjG,MAAM,WAAW,GAAG,WAAS,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;IACvD,MAAM,kBAAkB,GAAG,aAAa,CAAC,MAAM,KAAK,CAAC,CAAC;IACtD,IAAI,CAAC,CAAC,MAAM,qBAAU,CAAC,WAAW,CAAC,CAAC,EAAE;QACpC,IAAI,kBAAkB,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,gDAAgD,CAAC,CAAC;SAC7E;QACD,OAAO;KACR;IAED,MAAM,OAAO,GAAG,CAAC,MAAM,eAAQ,CAAC,WAAW,CAAC,CAA4B,CAAC;IAEzE,IAAK,OAAe,CAAC,OAAO,KAAK,IAAI,EAAE;QACrC,MAAM,IAAI,KAAK,CAAC,GAAG,WAAW,iCAAiC,CAAC,CAAC;KAClE;IAED,IAAI,kBAAkB,EAAE;QACtB,MAAM,CAAC,WAAW,CAAE,OAAe,CAAC,KAAK,EAAE,OAAO,EAAE,eAAe,WAAW,sBAAsB,CAAC,CAAC;QACtG,MAAM,QAAQ,GAAG,+CAA+B,CAAC,aAAa,CAAC,CAAC;QAChE,MAAM,CAAC,SAAS,CACb,OAAe,CAAC,aAAa,EAC9B,QAAQ,EACR,uBAAuB,WAAW,kCAAkC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,CAC7G,CAAC;KACH;IAED,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE;QACzB,4BAA4B;QAC5B,QAAQ,GAAG,EAAE;YACX,KAAK,SAAS,CAAC;YACf,KAAK,cAAc,CAAC;YACpB,KAAK,SAAS,CAAC;YACf,KAAK,SAAS,CAAC;YACf,KAAK,SAAS,CAAC;YACf,KAAK,MAAM;gBACT,0GAA0G;gBAC1G,MAAM;YACR,KAAK,eAAe,CAAC;YACrB,KAAK,OAAO;gBACV,IAAI,CAAC,kBAAkB,EAAE;oBACvB,MAAM,IAAI,KAAK,CAAC,GAAG,WAAW,yBAAyB,GAAG,sCAAsC,CAAC,CAAC;iBACnG;gBACD,MAAM;YACR;gBACE,MAAM,IAAI,KAAK,CAAC,GAAG,WAAW,6BAA6B,GAAG,EAAE,CAAC,CAAC;SACrE;KACF;AACH,CAAC;AA/CD,4CA+CC;AAMM,KAAK,UAAU,aAAa,CAAC,OAAe,EAAE,EAAmC;IACtF,MAAM,OAAO,GAAG,MAAM,yBAAkB,CAAC,OAAO,CAAC,CAAC;IAElD,IAAI,EAAE,EAAE;QACN,MAAM,EAAE,eAAe,EAAE,GAAG,EAAE,CAAC;QAE/B,MAAM,QAAQ,GAAG;YACf,MAAM,EAAE,UAAU;YAClB,MAAM,EAAE,IAAI;YACZ,gCAAgC,EAAE,IAAI;YACtC,OAAO,EAAE,eAAe;YACxB,SAAS,EAAE,CAAC,eAAe,CAAC;YAC5B,KAAK,EAAE,EAAE;SACV,CAAC;QAEF,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAA8B,EAAE;YACnF,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC/B,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;YAC5B,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE;gBACjC,MAAM,IAAI,KAAK,CAAC,4BAA4B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;aACrG;SACF;QAED,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE;YACzB,4BAA4B;YAC5B,QAAQ,GAAG,EAAE;gBACX,KAAK,KAAK,CAAC;gBACX,KAAK,eAAe,CAAC;gBACrB,KAAK,gBAAgB,CAAC;gBACtB,KAAK,QAAQ,CAAC;gBACd,KAAK,kBAAkB,CAAC;gBACxB,KAAK,0BAA0B,CAAC;gBAChC,KAAK,qBAAqB,CAAC;gBAC3B,KAAK,iBAAiB,CAAC;gBACvB,KAAK,8BAA8B;oBACjC,kBAAkB;oBAClB,MAAM;gBACR,KAAK,QAAQ,CAAC;gBACd,KAAK,OAAO,CAAC;gBACb,KAAK,KAAK,CAAC;gBACX,KAAK,YAAY,CAAC;gBAClB,KAAK,wBAAwB,CAAC;gBAC9B,KAAK,gBAAgB,CAAC;gBACtB,KAAK,oBAAoB;oBACvB,iDAAiD;oBACjD,MAAM;gBACR;oBACE,IAAI,CAAC,CAAC,GAAG,IAAI,QAAQ,CAAC,EAAE;wBACtB,MAAM,IAAI,KAAK,CAAC,8BAA8B,GAAG,EAAE,CAAC,CAAC;qBACtD;aACJ;SACF;KACF;IAED,IAAI,CAAC,CAAC,KAAK,IAAI,OAAO,CAAC,EAAE;QACvB,MAAM,IAAI,KAAK,CAAC,6EAA6E,CAAC,CAAC;KAChG;IAED,IAAI,QAAQ,IAAI,OAAO,EAAE;QACvB,IAAI,OAAO,CAAC,MAAM,KAAK,IAAI,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;SACxE;QAED,KAAK,MAAM,GAAG,IAAI,CAAC,eAAe,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,qBAAqB,CAAC,EAAE;YAChG,IAAI,GAAG,IAAI,OAAO,EAAE;gBAClB,MAAM,IAAI,SAAS,CAAC,aAAa,GAAG,4CAA4C,CAAC,CAAC;aACnF;SACF;KACF;SAAM;QACL,KAAK,MAAM,GAAG,IAAI,CAAC,eAAe,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,qBAAqB,CAAC,EAAE;YAChG,IAAI,CAAC,CAAC,GAAG,IAAI,OAAO,CAAC,EAAE;gBACrB,MAAM,IAAI,KAAK,CAAC,eAAe,GAAG,mBAAmB,GAAG,aAAa,CAAC,CAAC;aACxE;SACF;KACF;IAED,IAAI,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE;QACzC,MAAM,IAAI,KAAK,CACb,4EAA4E;YAC1E,4DAA4D,CAC/D,CAAC;KACH;AACH,CAAC;AAlFD,sCAkFC;AAED,SAAS,UAAU,CAAC,QAAiB,EAAE,MAAe;IACpD,IAAI,QAAQ,YAAY,KAAK,EAAE;QAC7B,OAAO,CACL,MAAM,YAAY,KAAK,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CACnH,CAAC;KACH;SAAM;QACL,OAAO,QAAQ,KAAK,MAAM,CAAC;KAC5B;AACH,CAAC"}

package/bin/src/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/bin/src/index.js

@@ -0,0 +1,233 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const header_parser_1 = require("@definitelytyped/header-parser");
+const typescript_versions_1 = require("@definitelytyped/typescript-versions");
+const assert = require("assert");
+const fs_extra_1 = require("fs-extra");
+const path_1 = require("path");
+const utils_1 = require("@definitelytyped/utils");
+const checks_1 = require("./checks");
+const lint_1 = require("./lint");
+const util_1 = require("./util");
+async function main() {
+    const args = process.argv.slice(2);
+    let dirPath = process.cwd();
+    let onlyTestTsNext = false;
+    let expectOnly = false;
+    let shouldListen = false;
+    let lookingForTsLocal = false;
+    let tsLocal;
+    for (const arg of args) {
+        if (lookingForTsLocal) {
+            if (arg.startsWith("--")) {
+                throw new Error("Looking for local path for TS, but got " + arg);
+            }
+            tsLocal = path_1.resolve(arg);
+            lookingForTsLocal = false;
+            continue;
+        }
+        switch (arg) {
+            case "--installAll":
+                console.log("Cleaning old installs and installing for all TypeScript versions...");
+                console.log("Working...");
+                await utils_1.cleanTypeScriptInstalls();
+                await utils_1.installAllTypeScriptVersions();
+                return;
+            case "--localTs":
+                lookingForTsLocal = true;
+                break;
+            case "--version":
+                console.log(require("../package.json").version);
+                return;
+            case "--expectOnly":
+                expectOnly = true;
+                break;
+            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 = path_1.join(dirPath, path);
+            }
+        }
+    }
+    if (lookingForTsLocal) {
+        throw new Error("Path for --localTs was not provided.");
+    }
+    if (shouldListen) {
+        listen(dirPath, tsLocal, onlyTestTsNext);
+    }
+    else {
+        await installTypeScriptAsNeeded(tsLocal, onlyTestTsNext);
+        await runTests(dirPath, onlyTestTsNext, expectOnly, tsLocal);
+    }
+}
+async function installTypeScriptAsNeeded(tsLocal, onlyTestTsNext) {
+    if (tsLocal)
+        return;
+    if (onlyTestTsNext) {
+        return utils_1.installTypeScriptNext();
+    }
+    return utils_1.installAllTypeScriptVersions();
+}
+function usage() {
+    console.error("Usage: dtslint [--version] [--installAll] [--onlyTestTsNext] [--expectOnly] [--localTs path]");
+    console.error("Args:");
+    console.error("  --version        Print version and exit.");
+    console.error("  --installAll     Cleans and installs all TypeScript versions.");
+    console.error("  --expectOnly     Run only the ExpectType lint rule.");
+    console.error("  --onlyTestTsNext Only run with `typescript@next`, not with the minimum version.");
+    console.error("  --localTs path   Run with *path* as the latest version of TS.");
+    console.error("");
+    console.error("onlyTestTsNext and localTs are (1) mutually exclusive and (2) test a single version of TS");
+}
+function listen(dirPath, tsLocal, alwaysOnlyTestTsNext) {
+    // Don't await this here to ensure that messages sent during installation aren't dropped.
+    const installationPromise = installTypeScriptAsNeeded(tsLocal, alwaysOnlyTestTsNext);
+    process.on("message", async (message) => {
+        const { path, onlyTestTsNext, expectOnly } = message;
+        await installationPromise;
+        runTests(path_1.join(dirPath, path), onlyTestTsNext, !!expectOnly, tsLocal)
+            .catch(e => e.stack)
+            .then(maybeError => {
+            process.send({ path, status: maybeError === undefined ? "OK" : maybeError });
+        })
+            .catch(e => console.error(e.stack));
+    });
+}
+async function runTests(dirPath, onlyTestTsNext, expectOnly, tsLocal) {
+    const isOlderVersion = /^v(0\.)?\d+$/.test(path_1.basename(dirPath));
+    const indexText = await fs_extra_1.readFile(path_1.join(dirPath, "index.d.ts"), "utf-8");
+    // If this *is* on DefinitelyTyped, types-publisher will fail if it can't parse the header.
+    const dt = indexText.includes("// Type definitions for");
+    if (dt) {
+        // Someone may have copied text from DefinitelyTyped to their type definition and included a header,
+        // so assert that we're really on DefinitelyTyped.
+        assertPathIsInDefinitelyTyped(dirPath);
+        assertPathIsNotBanned(dirPath);
+    }
+    const typesVersions = await util_1.mapDefinedAsync(await fs_extra_1.readdir(dirPath), async (name) => {
+        if (name === "tsconfig.json" || name === "tslint.json" || name === "tsutils") {
+            return undefined;
+        }
+        const version = util_1.withoutPrefix(name, "ts");
+        if (version === undefined || !(await fs_extra_1.stat(path_1.join(dirPath, name))).isDirectory()) {
+            return undefined;
+        }
+        if (!typescript_versions_1.TypeScriptVersion.isTypeScriptVersion(version)) {
+            throw new Error(`There is an entry named ${name}, but ${version} is not a valid TypeScript version.`);
+        }
+        if (!typescript_versions_1.TypeScriptVersion.isRedirectable(version)) {
+            throw new Error(`At ${dirPath}/${name}: TypeScript version directories only available starting with ts3.1.`);
+        }
+        return version;
+    });
+    if (dt) {
+        await checks_1.checkPackageJson(dirPath, typesVersions);
+    }
+    const minVersion = maxVersion(getMinimumTypeScriptVersionFromComment(indexText), typescript_versions_1.TypeScriptVersion.lowest);
+    if (onlyTestTsNext || tsLocal) {
+        const tsVersion = tsLocal ? "local" : typescript_versions_1.TypeScriptVersion.latest;
+        await testTypesVersion(dirPath, tsVersion, tsVersion, isOlderVersion, dt, expectOnly, tsLocal, /*isLatest*/ true);
+    }
+    else {
+        // For example, typesVersions of [3.2, 3.5, 3.6] will have
+        // associated ts3.2, ts3.5, ts3.6 directories, for
+        // <=3.2, <=3.5, <=3.6 respectively; the root level is for 3.7 and above.
+        // so this code needs to generate ranges [lowest-3.2, 3.3-3.5, 3.6-3.6, 3.7-latest]
+        const lows = [typescript_versions_1.TypeScriptVersion.lowest, ...typesVersions.map(next)];
+        const his = [...typesVersions, typescript_versions_1.TypeScriptVersion.latest];
+        assert.strictEqual(lows.length, his.length);
+        for (let i = 0; i < lows.length; i++) {
+            const low = maxVersion(minVersion, lows[i]);
+            const hi = his[i];
+            assert(parseFloat(hi) >= parseFloat(low), `'// Minimum TypeScript Version: ${minVersion}' in header skips ts${hi} folder.`);
+            const isLatest = hi === typescript_versions_1.TypeScriptVersion.latest;
+            const versionPath = isLatest ? dirPath : path_1.join(dirPath, `ts${hi}`);
+            if (lows.length > 1) {
+                console.log("testing from", low, "to", hi, "in", versionPath);
+            }
+            await testTypesVersion(versionPath, low, hi, isOlderVersion, dt, expectOnly, undefined, isLatest);
+        }
+    }
+}
+function maxVersion(v1, v2) {
+    if (!v1)
+        return v2;
+    if (!v2)
+        return v1;
+    if (parseFloat(v1) >= parseFloat(v2))
+        return v1;
+    return v2;
+}
+function next(v) {
+    const index = typescript_versions_1.TypeScriptVersion.supported.indexOf(v);
+    assert.notStrictEqual(index, -1);
+    assert(index < typescript_versions_1.TypeScriptVersion.supported.length);
+    return typescript_versions_1.TypeScriptVersion.supported[index + 1];
+}
+async function testTypesVersion(dirPath, lowVersion, hiVersion, isOlderVersion, dt, expectOnly, tsLocal, isLatest) {
+    await lint_1.checkTslintJson(dirPath, dt);
+    await checks_1.checkTsconfig(dirPath, dt ? { relativeBaseUrl: ".." + (isOlderVersion ? "/.." : "") + (isLatest ? "" : "/..") + "/" } : undefined);
+    const err = await lint_1.lint(dirPath, lowVersion, hiVersion, isLatest, expectOnly, tsLocal);
+    if (err) {
+        throw new Error(err);
+    }
+}
+function assertPathIsInDefinitelyTyped(dirPath) {
+    const parent = path_1.dirname(dirPath);
+    const types = /^v\d+(\.\d+)?$/.test(path_1.basename(dirPath)) ? path_1.dirname(parent) : parent;
+    // TODO: It's not clear whether this assertion makes sense, and it's broken on Azure Pipelines
+    // Re-enable it later if it makes sense.
+    // const dt = dirname(types);
+    // if (basename(dt) !== "DefinitelyTyped" || basename(types) !== "types") {
+    if (path_1.basename(types) !== "types") {
+        throw new Error("Since this type definition includes a header (a comment starting with `// Type definitions for`), " +
+            "assumed this was a DefinitelyTyped package.\n" +
+            "But it is not in a `DefinitelyTyped/types/xxx` directory: " +
+            dirPath);
+    }
+}
+function assertPathIsNotBanned(dirPath) {
+    const basedir = path_1.basename(dirPath);
+    if (/(^|\W)download($|\W)/.test(basedir) &&
+        basedir !== "download" &&
+        basedir !== "downloadjs" &&
+        basedir !== "s3-download-stream") {
+        // Since npm won't release their banned-words list, we'll have to manually add to this list.
+        throw new Error(`${dirPath}: Contains the word 'download', which is banned by npm.`);
+    }
+}
+function getMinimumTypeScriptVersionFromComment(text) {
+    const match = text.match(/\/\/ (?:Minimum )?TypeScript Version: /);
+    if (!match) {
+        return undefined;
+    }
+    let line = text.slice(match.index, text.indexOf("\n", match.index));
+    if (line.endsWith("\r")) {
+        line = line.slice(0, line.length - 1);
+    }
+    return header_parser_1.parseTypeScriptVersionLine(line);
+}
+if (!module.parent) {
+    main().catch(err => {
+        console.error(err.stack);
+        process.exit(1);
+    });
+}
+//# sourceMappingURL=index.js.map

package/bin/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAEA,kEAA4E;AAC5E,8EAA+F;AAC/F,iCAAkC;AAClC,uCAAmD;AACnD,+BAAqE;AAErE,kDAAsH;AACtH,qCAA2D;AAC3D,iCAA0D;AAC1D,iCAAwD;AAExD,KAAK,UAAU,IAAI;IACjB,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACnC,IAAI,OAAO,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAC5B,IAAI,cAAc,GAAG,KAAK,CAAC;IAC3B,IAAI,UAAU,GAAG,KAAK,CAAC;IACvB,IAAI,YAAY,GAAG,KAAK,CAAC;IACzB,IAAI,iBAAiB,GAAG,KAAK,CAAC;IAC9B,IAAI,OAA2B,CAAC;IAEhC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACtB,IAAI,iBAAiB,EAAE;YACrB,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;gBACxB,MAAM,IAAI,KAAK,CAAC,yCAAyC,GAAG,GAAG,CAAC,CAAC;aAClE;YACD,OAAO,GAAG,cAAO,CAAC,GAAG,CAAC,CAAC;YACvB,iBAAiB,GAAG,KAAK,CAAC;YAC1B,SAAS;SACV;QACD,QAAQ,GAAG,EAAE;YACX,KAAK,cAAc;gBACjB,OAAO,CAAC,GAAG,CAAC,qEAAqE,CAAC,CAAC;gBACnF,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;gBAC1B,MAAM,+BAAuB,EAAE,CAAC;gBAChC,MAAM,oCAA4B,EAAE,CAAC;gBACrC,OAAO;YACT,KAAK,WAAW;gBACd,iBAAiB,GAAG,IAAI,CAAC;gBACzB,MAAM;YACR,KAAK,WAAW;gBACd,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC,CAAC;gBAChD,OAAO;YACT,KAAK,cAAc;gBACjB,UAAU,GAAG,IAAI,CAAC;gBAClB,MAAM;YACR,KAAK,kBAAkB;gBACrB,cAAc,GAAG,IAAI,CAAC;gBACtB,MAAM;YACR,mCAAmC;YACnC,6EAA6E;YAC7E,KAAK,UAAU;gBACb,YAAY,GAAG,IAAI,CAAC;gBACpB,MAAM;YACR,OAAO,CAAC,CAAC;gBACP,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;oBACxB,OAAO,CAAC,KAAK,CAAC,mBAAmB,GAAG,GAAG,CAAC,CAAC;oBACzC,KAAK,EAAE,CAAC;oBACR,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;iBACjB;gBAED,MAAM,IAAI,GACR,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;oBAC/C,CAAC,CAAC,yCAAyC;wBACzC,0CAA0C;wBAC1C,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC;oBAClC,CAAC,CAAC,GAAG,CAAC;gBACV,OAAO,GAAG,WAAS,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;aACpC;SACF;KACF;IACD,IAAI,iBAAiB,EAAE;QACrB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;KACzD;IAED,IAAI,YAAY,EAAE;QAChB,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,cAAc,CAAC,CAAC;KAC1C;SAAM;QACL,MAAM,yBAAyB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QACzD,MAAM,QAAQ,CAAC,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;KAC9D;AACH,CAAC;AAED,KAAK,UAAU,yBAAyB,CAAC,OAA2B,EAAE,cAAuB;IAC3F,IAAI,OAAO;QAAE,OAAO;IACpB,IAAI,cAAc,EAAE;QAClB,OAAO,6BAAqB,EAAE,CAAC;KAChC;IACD,OAAO,oCAA4B,EAAE,CAAC;AACxC,CAAC;AAED,SAAS,KAAK;IACZ,OAAO,CAAC,KAAK,CAAC,8FAA8F,CAAC,CAAC;IAC9G,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACvB,OAAO,CAAC,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAC5D,OAAO,CAAC,KAAK,CAAC,iEAAiE,CAAC,CAAC;IACjF,OAAO,CAAC,KAAK,CAAC,uDAAuD,CAAC,CAAC;IACvE,OAAO,CAAC,KAAK,CAAC,mFAAmF,CAAC,CAAC;IACnG,OAAO,CAAC,KAAK,CAAC,iEAAiE,CAAC,CAAC;IACjF,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAClB,OAAO,CAAC,KAAK,CAAC,2FAA2F,CAAC,CAAC;AAC7G,CAAC;AAED,SAAS,MAAM,CAAC,OAAe,EAAE,OAA2B,EAAE,oBAA6B;IACzF,yFAAyF;IACzF,MAAM,mBAAmB,GAAG,yBAAyB,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;IACrF,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,OAAgB,EAAE,EAAE;QAC/C,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,OAI5C,CAAC;QAEF,MAAM,mBAAmB,CAAC;QAC1B,QAAQ,CAAC,WAAS,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,cAAc,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAAC;aACtE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;aACnB,IAAI,CAAC,UAAU,CAAC,EAAE;YACjB,OAAO,CAAC,IAAK,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC;QAChF,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,QAAQ,CACrB,OAAe,EACf,cAAuB,EACvB,UAAmB,EACnB,OAA2B;IAE3B,MAAM,cAAc,GAAG,cAAc,CAAC,IAAI,CAAC,eAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;IAE9D,MAAM,SAAS,GAAG,MAAM,mBAAQ,CAAC,WAAS,CAAC,OAAO,EAAE,YAAY,CAAC,EAAE,OAAO,CAAC,CAAC;IAC5E,2FAA2F;IAC3F,MAAM,EAAE,GAAG,SAAS,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;IACzD,IAAI,EAAE,EAAE;QACN,oGAAoG;QACpG,kDAAkD;QAClD,6BAA6B,CAAC,OAAO,CAAC,CAAC;QACvC,qBAAqB,CAAC,OAAO,CAAC,CAAC;KAChC;IAED,MAAM,aAAa,GAAG,MAAM,sBAAe,CAAC,MAAM,kBAAO,CAAC,OAAO,CAAC,EAAE,KAAK,EAAC,IAAI,EAAC,EAAE;QAC/E,IAAI,IAAI,KAAK,eAAe,IAAI,IAAI,KAAK,aAAa,IAAI,IAAI,KAAK,SAAS,EAAE;YAC5E,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,OAAO,GAAG,oBAAa,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC1C,IAAI,OAAO,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,eAAI,CAAC,WAAS,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE;YAClF,OAAO,SAAS,CAAC;SAClB;QAED,IAAI,CAAC,uCAAiB,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE;YACnD,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,SAAS,OAAO,qCAAqC,CAAC,CAAC;SACvG;QACD,IAAI,CAAC,uCAAiB,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE;YAC9C,MAAM,IAAI,KAAK,CAAC,MAAM,OAAO,IAAI,IAAI,sEAAsE,CAAC,CAAC;SAC9G;QACD,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC,CAAC;IAEH,IAAI,EAAE,EAAE;QACN,MAAM,yBAAgB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;KAChD;IAED,MAAM,UAAU,GAAG,UAAU,CAC3B,sCAAsC,CAAC,SAAS,CAAC,EACjD,uCAAiB,CAAC,MAAM,CACJ,CAAC;IACvB,IAAI,cAAc,IAAI,OAAO,EAAE;QAC7B,MAAM,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,uCAAiB,CAAC,MAAM,CAAC;QAC/D,MAAM,gBAAgB,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,cAAc,EAAE,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC;KACnH;SAAM;QACL,0DAA0D;QAC1D,kDAAkD;QAClD,yEAAyE;QACzE,mFAAmF;QACnF,MAAM,IAAI,GAAG,CAAC,uCAAiB,CAAC,MAAM,EAAE,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QACpE,MAAM,GAAG,GAAG,CAAC,GAAG,aAAa,EAAE,uCAAiB,CAAC,MAAM,CAAC,CAAC;QACzD,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;QAC5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACpC,MAAM,GAAG,GAAG,UAAU,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5C,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;YAClB,MAAM,CACJ,UAAU,CAAC,EAAE,CAAC,IAAI,UAAU,CAAC,GAAG,CAAC,EACjC,mCAAmC,UAAU,uBAAuB,EAAE,UAAU,CACjF,CAAC;YACF,MAAM,QAAQ,GAAG,EAAE,KAAK,uCAAiB,CAAC,MAAM,CAAC;YACjD,MAAM,WAAW,GAAG,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,WAAS,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;YACvE,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;gBACnB,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;aAC/D;YACD,MAAM,gBAAgB,CAAC,WAAW,EAAE,GAAG,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;SACnG;KACF;AACH,CAAC;AAID,SAAS,UAAU,CAAC,EAAoC,EAAE,EAAwB;IAChF,IAAI,CAAC,EAAE;QAAE,OAAO,EAAE,CAAC;IACnB,IAAI,CAAC,EAAE;QAAE,OAAO,EAAE,CAAC;IACnB,IAAI,UAAU,CAAC,EAAE,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC;QAAE,OAAO,EAAE,CAAC;IAChD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,IAAI,CAAC,CAAoB;IAChC,MAAM,KAAK,GAAG,uCAAiB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IACrD,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;IACjC,MAAM,CAAC,KAAK,GAAG,uCAAiB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IACnD,OAAO,uCAAiB,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;AAChD,CAAC;AAED,KAAK,UAAU,gBAAgB,CAC7B,OAAe,EACf,UAAqB,EACrB,SAAoB,EACpB,cAAuB,EACvB,EAAW,EACX,UAAmB,EACnB,OAA2B,EAC3B,QAAiB;IAEjB,MAAM,sBAAe,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IACnC,MAAM,sBAAa,CACjB,OAAO,EACP,EAAE,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,IAAI,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,SAAS,CAC3G,CAAC;IACF,MAAM,GAAG,GAAG,MAAM,WAAI,CAAC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IACtF,IAAI,GAAG,EAAE;QACP,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;KACtB;AACH,CAAC;AAED,SAAS,6BAA6B,CAAC,OAAe;IACpD,MAAM,MAAM,GAAG,cAAO,CAAC,OAAO,CAAC,CAAC;IAChC,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CAAC,eAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,cAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IAClF,8FAA8F;IAC9F,wCAAwC;IACxC,6BAA6B;IAC7B,2EAA2E;IAC3E,IAAI,eAAQ,CAAC,KAAK,CAAC,KAAK,OAAO,EAAE;QAC/B,MAAM,IAAI,KAAK,CACb,oGAAoG;YAClG,+CAA+C;YAC/C,4DAA4D;YAC5D,OAAO,CACV,CAAC;KACH;AACH,CAAC;AAED,SAAS,qBAAqB,CAAC,OAAe;IAC5C,MAAM,OAAO,GAAG,eAAQ,CAAC,OAAO,CAAC,CAAC;IAClC,IACE,sBAAsB,CAAC,IAAI,CAAC,OAAO,CAAC;QACpC,OAAO,KAAK,UAAU;QACtB,OAAO,KAAK,YAAY;QACxB,OAAO,KAAK,oBAAoB,EAChC;QACA,4FAA4F;QAC5F,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,yDAAyD,CAAC,CAAC;KACtF;AACH,CAAC;AAED,SAAS,sCAAsC,CAAC,IAAY;IAC1D,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAC;IACnE,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,SAAS,CAAC;KAClB;IAED,IAAI,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;IACpE,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;QACvB,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;KACvC;IACD,OAAO,0CAA0B,CAAC,IAAI,CAAC,CAAC;AAC1C,CAAC;AAED,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;IAClB,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;QACjB,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACzB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;CACJ"}

package/bin/src/lint.d.ts

@@ -0,0 +1,6 @@
+import { TypeScriptVersion } from "@definitelytyped/typescript-versions";
+import * as TsType from "typescript";
+export declare function lint(dirPath: string, minVersion: TsVersion, maxVersion: TsVersion, isLatest: boolean, expectOnly: boolean, tsLocal: string | undefined): Promise<string | undefined>;
+export declare function isExternalDependency(file: TsType.SourceFile, dirPath: string, program: TsType.Program): boolean;
+export declare function checkTslintJson(dirPath: string, dt: boolean): Promise<void>;
+export declare type TsVersion = TypeScriptVersion | "local";

package/bin/src/lint.js

@@ -0,0 +1,194 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkTslintJson = exports.isExternalDependency = exports.lint = void 0;
+const typescript_versions_1 = require("@definitelytyped/typescript-versions");
+const utils_1 = require("@definitelytyped/utils");
+const assert = require("assert");
+const fs_extra_1 = require("fs-extra");
+const path_1 = require("path");
+const tslint_1 = require("tslint");
+const expectRule_1 = require("./rules/expectRule");
+const util_1 = require("./util");
+async function lint(dirPath, minVersion, maxVersion, isLatest, expectOnly, tsLocal) {
+    const tsconfigPath = path_1.join(dirPath, "tsconfig.json");
+    const lintProgram = tslint_1.Linter.createProgram(tsconfigPath);
+    for (const version of [maxVersion, minVersion]) {
+        const errors = testDependencies(version, dirPath, lintProgram, tsLocal);
+        if (errors) {
+            return errors;
+        }
+    }
+    const lintOptions = {
+        fix: false,
+        formatter: "stylish"
+    };
+    const linter = new tslint_1.Linter(lintOptions, lintProgram);
+    const configPath = expectOnly ? path_1.join(__dirname, "..", "dtslint-expect-only.json") : getConfigPath(dirPath);
+    const config = await getLintConfig(configPath, tsconfigPath, minVersion, maxVersion, tsLocal);
+    for (const file of lintProgram.getSourceFiles()) {
+        if (lintProgram.isSourceFileDefaultLibrary(file)) {
+            continue;
+        }
+        const { fileName, text } = file;
+        if (!fileName.includes("node_modules")) {
+            const err = testNoTsIgnore(text) || testNoTslintDisables(text);
+            if (err) {
+                const { pos, message } = err;
+                const place = file.getLineAndCharacterOfPosition(pos);
+                return `At ${fileName}:${JSON.stringify(place)}: ${message}`;
+            }
+        }
+        // External dependencies should have been handled by `testDependencies`;
+        // typesVersions should be handled in a separate lint
+        if (!isExternalDependency(file, dirPath, lintProgram) && (!isLatest || !isTypesVersionPath(fileName, dirPath))) {
+            linter.lint(fileName, text, config);
+        }
+    }
+    const result = linter.getResult();
+    return result.failures.length ? result.output : undefined;
+}
+exports.lint = lint;
+function testDependencies(version, dirPath, lintProgram, tsLocal) {
+    const tsconfigPath = path_1.join(dirPath, "tsconfig.json");
+    assert(version !== "local" || tsLocal);
+    const ts = require(utils_1.typeScriptPath(version, tsLocal));
+    const program = expectRule_1.getProgram(tsconfigPath, ts, version, lintProgram);
+    const diagnostics = ts
+        .getPreEmitDiagnostics(program)
+        .filter(d => !d.file || isExternalDependency(d.file, dirPath, program));
+    if (!diagnostics.length) {
+        return undefined;
+    }
+    const showDiags = ts.formatDiagnostics(diagnostics, {
+        getCanonicalFileName: f => f,
+        getCurrentDirectory: () => dirPath,
+        getNewLine: () => "\n"
+    });
+    const message = `Errors in typescript@${version} for external dependencies:\n${showDiags}`;
+    // Add an edge-case for someone needing to `npm install` in react when they first edit a DT module which depends on it - #226
+    const cannotFindDepsDiags = diagnostics.find(d => d.code === 2307 && d.messageText.toString().includes("Cannot find module"));
+    if (cannotFindDepsDiags && cannotFindDepsDiags.file) {
+        const path = cannotFindDepsDiags.file.fileName;
+        const typesFolder = path_1.dirname(path);
+        return `
+A module look-up failed, this often occurs when you need to run \`npm install\` on a dependent module before you can lint.
+
+Before you debug, first try running:
+
+   npm install --prefix ${typesFolder}
+
+Then re-run. Full error logs are below.
+
+${message}`;
+    }
+    else {
+        return message;
+    }
+}
+function isExternalDependency(file, dirPath, program) {
+    return !startsWithDirectory(file.fileName, dirPath) || program.isSourceFileFromExternalLibrary(file);
+}
+exports.isExternalDependency = isExternalDependency;
+function normalizePath(file) {
+    // replaces '\' with '/' and forces all DOS drive letters to be upper-case
+    return path_1.normalize(file)
+        .replace(/\\/g, "/")
+        .replace(/^[a-z](?=:)/, c => c.toUpperCase());
+}
+function isTypesVersionPath(fileName, dirPath) {
+    const normalFileName = normalizePath(fileName);
+    const normalDirPath = normalizePath(dirPath);
+    const subdirPath = util_1.withoutPrefix(normalFileName, normalDirPath);
+    return subdirPath && /^\/ts\d+\.\d/.test(subdirPath);
+}
+function startsWithDirectory(filePath, dirPath) {
+    const normalFilePath = normalizePath(filePath);
+    const normalDirPath = normalizePath(dirPath).replace(/\/$/, "");
+    return normalFilePath.startsWith(normalDirPath + "/") || normalFilePath.startsWith(normalDirPath + "\\");
+}
+function testNoTsIgnore(text) {
+    const tsIgnore = "ts-ignore";
+    const pos = text.indexOf(tsIgnore);
+    return pos === -1 ? undefined : { pos, message: "'ts-ignore' is forbidden." };
+}
+function testNoTslintDisables(text) {
+    const tslintDisable = "tslint:disable";
+    let lastIndex = 0;
+    // eslint-disable-next-line no-constant-condition
+    while (true) {
+        const pos = text.indexOf(tslintDisable, lastIndex);
+        if (pos === -1) {
+            return undefined;
+        }
+        const end = pos + tslintDisable.length;
+        const nextChar = text.charAt(end);
+        if (nextChar !== "-" && nextChar !== ":") {
+            const message = "'tslint:disable' is forbidden. " +
+                "('tslint:disable:rulename', tslint:disable-line' and 'tslint:disable-next-line' are allowed.)";
+            return { pos, message };
+        }
+        lastIndex = end;
+    }
+}
+async function checkTslintJson(dirPath, dt) {
+    const configPath = getConfigPath(dirPath);
+    const shouldExtend = `dtslint/${dt ? "dt" : "dtslint"}.json`;
+    const validateExtends = (extend) => extend === shouldExtend || (!dt && Array.isArray(extend) && extend.some(val => val === shouldExtend));
+    if (!(await fs_extra_1.pathExists(configPath))) {
+        if (dt) {
+            throw new Error(`On DefinitelyTyped, must include \`tslint.json\` containing \`{ "extends": "${shouldExtend}" }\`.\n` +
+                "This was inferred as a DefinitelyTyped package because it contains a `// Type definitions for` header.");
+        }
+        return;
+    }
+    const tslintJson = await util_1.readJson(configPath);
+    if (!validateExtends(tslintJson.extends)) {
+        throw new Error(`If 'tslint.json' is present, it should extend "${shouldExtend}"`);
+    }
+}
+exports.checkTslintJson = checkTslintJson;
+function getConfigPath(dirPath) {
+    return path_1.join(dirPath, "tslint.json");
+}
+async function getLintConfig(expectedConfigPath, tsconfigPath, minVersion, maxVersion, tsLocal) {
+    const configExists = await fs_extra_1.pathExists(expectedConfigPath);
+    const configPath = configExists ? expectedConfigPath : path_1.join(__dirname, "..", "dtslint.json");
+    // Second param to `findConfiguration` doesn't matter, since config path is provided.
+    const config = tslint_1.Configuration.findConfiguration(configPath, "").results;
+    if (!config) {
+        throw new Error(`Could not load config at ${configPath}`);
+    }
+    const expectRule = config.rules.get("expect");
+    if (!expectRule || expectRule.ruleSeverity !== "error") {
+        throw new Error("'expect' rule should be enabled, else compile errors are ignored");
+    }
+    if (expectRule) {
+        const versionsToTest = range(minVersion, maxVersion).map(versionName => ({
+            versionName,
+            path: utils_1.typeScriptPath(versionName, tsLocal)
+        }));
+        const expectOptions = { tsconfigPath, versionsToTest };
+        expectRule.ruleArguments = [expectOptions];
+    }
+    return config;
+}
+function range(minVersion, maxVersion) {
+    if (minVersion === "local") {
+        assert(maxVersion === "local");
+        return ["local"];
+    }
+    if (minVersion === typescript_versions_1.TypeScriptVersion.latest) {
+        assert(maxVersion === typescript_versions_1.TypeScriptVersion.latest);
+        return [typescript_versions_1.TypeScriptVersion.latest];
+    }
+    assert(maxVersion !== "local");
+    const minIdx = typescript_versions_1.TypeScriptVersion.shipped.indexOf(minVersion);
+    assert(minIdx >= 0);
+    if (maxVersion === typescript_versions_1.TypeScriptVersion.latest) {
+        return [...typescript_versions_1.TypeScriptVersion.shipped.slice(minIdx), typescript_versions_1.TypeScriptVersion.latest];
+    }
+    const maxIdx = typescript_versions_1.TypeScriptVersion.shipped.indexOf(maxVersion);
+    assert(maxIdx >= minIdx);
+    return typescript_versions_1.TypeScriptVersion.shipped.slice(minIdx, maxIdx + 1);
+}
+//# sourceMappingURL=lint.js.map

package/bin/src/lint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lint.js","sourceRoot":"","sources":["../../src/lint.ts"],"names":[],"mappings":";;;AAAA,8EAAyE;AACzE,kDAAwD;AACxD,iCAAkC;AAClC,uCAAsC;AACtC,+BAA6D;AAC7D,mCAA+D;AAK/D,mDAA0E;AAE1E,iCAAiD;AAE1C,KAAK,UAAU,IAAI,CACxB,OAAe,EACf,UAAqB,EACrB,UAAqB,EACrB,QAAiB,EACjB,UAAmB,EACnB,OAA2B;IAE3B,MAAM,YAAY,GAAG,WAAS,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IACzD,MAAM,WAAW,GAAG,eAAM,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;IAEvD,KAAK,MAAM,OAAO,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,EAAE;QAC9C,MAAM,MAAM,GAAG,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;QACxE,IAAI,MAAM,EAAE;YACV,OAAO,MAAM,CAAC;SACf;KACF;IAED,MAAM,WAAW,GAAmB;QAClC,GAAG,EAAE,KAAK;QACV,SAAS,EAAE,SAAS;KACrB,CAAC;IACF,MAAM,MAAM,GAAG,IAAI,eAAM,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;IACpD,MAAM,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,WAAS,CAAC,SAAS,EAAE,IAAI,EAAE,0BAA0B,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAChH,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,UAAU,EAAE,YAAY,EAAE,UAAU,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAE9F,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,cAAc,EAAE,EAAE;QAC/C,IAAI,WAAW,CAAC,0BAA0B,CAAC,IAAI,CAAC,EAAE;YAChD,SAAS;SACV;QAED,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QAChC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE;YACtC,MAAM,GAAG,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,oBAAoB,CAAC,IAAI,CAAC,CAAC;YAC/D,IAAI,GAAG,EAAE;gBACP,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,GAAG,CAAC;gBAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,CAAC;gBACtD,OAAO,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,OAAO,EAAE,CAAC;aAC9D;SACF;QAED,wEAAwE;QACxE,qDAAqD;QACrD,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC,QAAQ,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,EAAE;YAC9G,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;SACrC;KACF;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;IAClC,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AAC5D,CAAC;AAlDD,oBAkDC;AAED,SAAS,gBAAgB,CACvB,OAAkB,EAClB,OAAe,EACf,WAA2B,EAC3B,OAA2B;IAE3B,MAAM,YAAY,GAAG,WAAS,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IACzD,MAAM,CAAC,OAAO,KAAK,OAAO,IAAI,OAAO,CAAC,CAAC;IACvC,MAAM,EAAE,GAAkB,OAAO,CAAC,sBAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IACpE,MAAM,OAAO,GAAG,uBAAU,CAAC,YAAY,EAAE,EAAE,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IACnE,MAAM,WAAW,GAAG,EAAE;SACnB,qBAAqB,CAAC,OAAO,CAAC;SAC9B,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,oBAAoB,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IAC1E,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;QACvB,OAAO,SAAS,CAAC;KAClB;IAED,MAAM,SAAS,GAAG,EAAE,CAAC,iBAAiB,CAAC,WAAW,EAAE;QAClD,oBAAoB,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAC5B,mBAAmB,EAAE,GAAG,EAAE,CAAC,OAAO;QAClC,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI;KACvB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,wBAAwB,OAAO,gCAAgC,SAAS,EAAE,CAAC;IAE3F,6HAA6H;IAC7H,MAAM,mBAAmB,GAAG,WAAW,CAAC,IAAI,CAC1C,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAChF,CAAC;IACF,IAAI,mBAAmB,IAAI,mBAAmB,CAAC,IAAI,EAAE;QACnD,MAAM,IAAI,GAAG,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC;QAC/C,MAAM,WAAW,GAAG,cAAO,CAAC,IAAI,CAAC,CAAC;QAElC,OAAO;;;;;0BAKe,WAAW;;;;EAInC,OAAO,EAAE,CAAC;KACT;SAAM;QACL,OAAO,OAAO,CAAC;KAChB;AACH,CAAC;AAED,SAAgB,oBAAoB,CAAC,IAAuB,EAAE,OAAe,EAAE,OAAuB;IACpG,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,OAAO,CAAC,+BAA+B,CAAC,IAAI,CAAC,CAAC;AACvG,CAAC;AAFD,oDAEC;AAED,SAAS,aAAa,CAAC,IAAY;IACjC,0EAA0E;IAC1E,OAAO,gBAAS,CAAC,IAAI,CAAC;SACnB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,kBAAkB,CAAC,QAAgB,EAAE,OAAe;IAC3D,MAAM,cAAc,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC/C,MAAM,aAAa,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IAC7C,MAAM,UAAU,GAAG,oBAAa,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;IAChE,OAAO,UAAU,IAAI,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;AACvD,CAAC;AAED,SAAS,mBAAmB,CAAC,QAAgB,EAAE,OAAe;IAC5D,MAAM,cAAc,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC/C,MAAM,aAAa,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAChE,OAAO,cAAc,CAAC,UAAU,CAAC,aAAa,GAAG,GAAG,CAAC,IAAI,cAAc,CAAC,UAAU,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;AAC3G,CAAC;AAMD,SAAS,cAAc,CAAC,IAAY;IAClC,MAAM,QAAQ,GAAG,WAAW,CAAC;IAC7B,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACnC,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,2BAA2B,EAAE,CAAC;AAChF,CAAC;AACD,SAAS,oBAAoB,CAAC,IAAY;IACxC,MAAM,aAAa,GAAG,gBAAgB,CAAC;IACvC,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,iDAAiD;IACjD,OAAO,IAAI,EAAE;QACX,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QACnD,IAAI,GAAG,KAAK,CAAC,CAAC,EAAE;YACd,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,GAAG,GAAG,GAAG,GAAG,aAAa,CAAC,MAAM,CAAC;QACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,EAAE;YACxC,MAAM,OAAO,GACX,iCAAiC;gBACjC,+FAA+F,CAAC;YAClG,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC;SACzB;QACD,SAAS,GAAG,GAAG,CAAC;KACjB;AACH,CAAC;AAEM,KAAK,UAAU,eAAe,CAAC,OAAe,EAAE,EAAW;IAChE,MAAM,UAAU,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IAC1C,MAAM,YAAY,GAAG,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,OAAO,CAAC;IAC7D,MAAM,eAAe,GAAG,CAAC,MAAyB,EAAE,EAAE,CACpD,MAAM,KAAK,YAAY,IAAI,CAAC,CAAC,EAAE,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,YAAY,CAAC,CAAC,CAAC;IAExG,IAAI,CAAC,CAAC,MAAM,qBAAU,CAAC,UAAU,CAAC,CAAC,EAAE;QACnC,IAAI,EAAE,EAAE;YACN,MAAM,IAAI,KAAK,CACb,+EAA+E,YAAY,UAAU;gBACnG,wGAAwG,CAC3G,CAAC;SACH;QACD,OAAO;KACR;IAED,MAAM,UAAU,GAAG,MAAM,eAAQ,CAAC,UAAU,CAAC,CAAC;IAC9C,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;QACxC,MAAM,IAAI,KAAK,CAAC,kDAAkD,YAAY,GAAG,CAAC,CAAC;KACpF;AACH,CAAC;AApBD,0CAoBC;AAED,SAAS,aAAa,CAAC,OAAe;IACpC,OAAO,WAAS,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;AAC3C,CAAC;AAED,KAAK,UAAU,aAAa,CAC1B,kBAA0B,EAC1B,YAAoB,EACpB,UAAqB,EACrB,UAAqB,EACrB,OAA2B;IAE3B,MAAM,YAAY,GAAG,MAAM,qBAAU,CAAC,kBAAkB,CAAC,CAAC;IAC1D,MAAM,UAAU,GAAG,YAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,WAAS,CAAC,SAAS,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC;IAClG,qFAAqF;IACrF,MAAM,MAAM,GAAG,sBAAa,CAAC,iBAAiB,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC;IACvE,IAAI,CAAC,MAAM,EAAE;QACX,MAAM,IAAI,KAAK,CAAC,4BAA4B,UAAU,EAAE,CAAC,CAAC;KAC3D;IAED,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC9C,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,YAAY,KAAK,OAAO,EAAE;QACtD,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;KACrF;IACD,IAAI,UAAU,EAAE;QACd,MAAM,cAAc,GAAG,KAAK,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;YACvE,WAAW;YACX,IAAI,EAAE,sBAAc,CAAC,WAAW,EAAE,OAAO,CAAC;SAC3C,CAAC,CAAC,CAAC;QACJ,MAAM,aAAa,GAAkB,EAAE,YAAY,EAAE,cAAc,EAAE,CAAC;QACtE,UAAU,CAAC,aAAa,GAAG,CAAC,aAAa,CAAC,CAAC;KAC5C;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,KAAK,CAAC,UAAqB,EAAE,UAAqB;IACzD,IAAI,UAAU,KAAK,OAAO,EAAE;QAC1B,MAAM,CAAC,UAAU,KAAK,OAAO,CAAC,CAAC;QAC/B,OAAO,CAAC,OAAO,CAAC,CAAC;KAClB;IACD,IAAI,UAAU,KAAK,uCAAiB,CAAC,MAAM,EAAE;QAC3C,MAAM,CAAC,UAAU,KAAK,uCAAiB,CAAC,MAAM,CAAC,CAAC;QAChD,OAAO,CAAC,uCAAiB,CAAC,MAAM,CAAC,CAAC;KACnC;IACD,MAAM,CAAC,UAAU,KAAK,OAAO,CAAC,CAAC;IAE/B,MAAM,MAAM,GAAG,uCAAiB,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC7D,MAAM,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC;IACpB,IAAI,UAAU,KAAK,uCAAiB,CAAC,MAAM,EAAE;QAC3C,OAAO,CAAC,GAAG,uCAAiB,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,uCAAiB,CAAC,MAAM,CAAC,CAAC;KAC/E;IACD,MAAM,MAAM,GAAG,uCAAiB,CAAC,OAAO,CAAC,OAAO,CAAC,UAA+B,CAAC,CAAC;IAClF,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC;IACzB,OAAO,uCAAiB,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC;AAC7D,CAAC"}

package/bin/src/rules/dtHeaderRule.d.ts

@@ -0,0 +1,6 @@
+import * as Lint from "tslint";
+import * as ts from "typescript";
+export declare class Rule extends Lint.Rules.AbstractRule {
+    static metadata: Lint.IRuleMetadata;
+    apply(sourceFile: ts.SourceFile): Lint.RuleFailure[];
+}