@definitelytyped/dtslint 0.0.95-next.1 → 0.0.97-next.0

package/bin/src/rules/strictExportDeclareModifiersRule.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[];
+}

package/bin/src/rules/strictExportDeclareModifiersRule.js

@@ -0,0 +1,162 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Rule = void 0;
+const Lint = __importStar(require("tslint"));
+const ts = __importStar(require("typescript"));
+const util_1 = require("../util");
+class Rule extends Lint.Rules.AbstractRule {
+    apply(sourceFile) {
+        return this.applyWithFunction(sourceFile, walk);
+    }
+}
+exports.Rule = Rule;
+Rule.metadata = {
+    ruleName: "strict-export-declare-modifiers",
+    description: "Enforces strict rules about where the 'export' and 'declare' modifiers may appear.",
+    optionsDescription: "Not configurable.",
+    options: null,
+    type: "style",
+    typescriptOnly: true
+};
+function walk(ctx) {
+    const { sourceFile } = ctx;
+    const isExternal = sourceFile.isDeclarationFile &&
+        !sourceFile.statements.some(s => s.kind === ts.SyntaxKind.ExportAssignment ||
+            (s.kind === ts.SyntaxKind.ExportDeclaration && !!s.exportClause)) &&
+        ts.isExternalModule(sourceFile);
+    for (const node of sourceFile.statements) {
+        if (isExternal) {
+            checkInExternalModule(node, isAutomaticExport(sourceFile));
+        }
+        else {
+            checkInOther(node, sourceFile.isDeclarationFile);
+        }
+        if (isModuleDeclaration(node) && (sourceFile.isDeclarationFile || isDeclare(node))) {
+            checkModule(node);
+        }
+    }
+    function checkInExternalModule(node, autoExportEnabled) {
+        // Ignore certain node kinds (these can't have 'export' or 'default' modifiers)
+        switch (node.kind) {
+            case ts.SyntaxKind.ImportDeclaration:
+            case ts.SyntaxKind.ImportEqualsDeclaration:
+            case ts.SyntaxKind.ExportDeclaration:
+            case ts.SyntaxKind.NamespaceExportDeclaration:
+                return;
+        }
+        // `declare global` and `declare module "foo"` OK. `declare namespace N` not OK, should be `export namespace`.
+        if (!isDeclareGlobalOrExternalModuleDeclaration(node)) {
+            if (isDeclare(node)) {
+                fail(mod(node, ts.SyntaxKind.DeclareKeyword), "'declare' keyword is redundant here.");
+            }
+            if (autoExportEnabled && !isExport(node)) {
+                fail(node.name || node, "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.");
+            }
+        }
+    }
+    function checkInOther(node, inDeclarationFile) {
+        // Compiler will enforce presence of 'declare' where necessary. But types do not need 'declare'.
+        if (isDeclare(node)) {
+            if ((isExport(node) && inDeclarationFile) ||
+                node.kind === ts.SyntaxKind.InterfaceDeclaration ||
+                node.kind === ts.SyntaxKind.TypeAliasDeclaration) {
+                fail(mod(node, ts.SyntaxKind.DeclareKeyword), "'declare' keyword is redundant here.");
+            }
+        }
+    }
+    function fail(node, reason) {
+        ctx.addFailureAtNode(node, util_1.failure(Rule.metadata.ruleName, reason));
+    }
+    function mod(node, kind) {
+        return node.modifiers.find(m => m.kind === kind);
+    }
+    function checkModule(moduleDeclaration) {
+        const body = moduleDeclaration.body;
+        if (!body) {
+            return;
+        }
+        switch (body.kind) {
+            case ts.SyntaxKind.ModuleDeclaration:
+                checkModule(body);
+                break;
+            case ts.SyntaxKind.ModuleBlock:
+                checkBlock(body, isAutomaticExport(moduleDeclaration));
+                break;
+        }
+    }
+    function checkBlock(block, autoExportEnabled) {
+        for (const s of block.statements) {
+            // Compiler will error for 'declare' here anyway, so just check for 'export'.
+            if (isExport(s) && autoExportEnabled && !isDefault(s)) {
+                fail(mod(s, ts.SyntaxKind.ExportKeyword), "'export' keyword is redundant here because " +
+                    "all declarations in this module are exported automatically. " +
+                    "If you have a good reason to export some declarations and not others, " +
+                    "add 'export {}' to the module to shut off automatic exporting.");
+            }
+            if (isModuleDeclaration(s)) {
+                checkModule(s);
+            }
+        }
+    }
+}
+function isDeclareGlobalOrExternalModuleDeclaration(node) {
+    return (isModuleDeclaration(node) &&
+        (node.name.kind === ts.SyntaxKind.StringLiteral ||
+            (node.name.kind === ts.SyntaxKind.Identifier && node.name.text === "global")));
+}
+function isModuleDeclaration(node) {
+    return node.kind === ts.SyntaxKind.ModuleDeclaration;
+}
+function isDeclare(node) {
+    return Lint.hasModifier(node.modifiers, ts.SyntaxKind.DeclareKeyword);
+}
+function isExport(node) {
+    return Lint.hasModifier(node.modifiers, ts.SyntaxKind.ExportKeyword);
+}
+function isDefault(node) {
+    return Lint.hasModifier(node.modifiers, ts.SyntaxKind.DefaultKeyword);
+}
+// tslint:disable-next-line:max-line-length
+// Copied from https://github.com/Microsoft/TypeScript/blob/dd9b8cab34a3e389e924d768eb656cf50656f582/src/compiler/binder.ts#L1571-L1581
+function hasExportDeclarations(node) {
+    const body = node.kind === ts.SyntaxKind.SourceFile ? node : node.body;
+    if (body && (body.kind === ts.SyntaxKind.SourceFile || body.kind === ts.SyntaxKind.ModuleBlock)) {
+        for (const stat of body.statements) {
+            if (stat.kind === ts.SyntaxKind.ExportDeclaration || stat.kind === ts.SyntaxKind.ExportAssignment) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function isAutomaticExport(node) {
+    // We'd like to just test ts.NodeFlags.ExportContext, but we don't run the
+    // binder, so that flag won't be set, so duplicate the logic instead. :(
+    //
+    // ts.NodeFlags.Ambient is @internal, but all modules that get here should
+    // be ambient.
+    return !hasExportDeclarations(node);
+}
+//# sourceMappingURL=strictExportDeclareModifiersRule.js.map

package/bin/src/rules/strictExportDeclareModifiersRule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"strictExportDeclareModifiersRule.js","sourceRoot":"","sources":["../../../src/rules/strictExportDeclareModifiersRule.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA+B;AAC/B,+CAAiC;AAEjC,kCAAkC;AAElC,MAAa,IAAK,SAAQ,IAAI,CAAC,KAAK,CAAC,YAAY;IAU/C,KAAK,CAAC,UAAyB;QAC7B,OAAO,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IAClD,CAAC;;AAZH,oBAaC;AAZQ,aAAQ,GAAuB;IACpC,QAAQ,EAAE,iCAAiC;IAC3C,WAAW,EAAE,oFAAoF;IACjG,kBAAkB,EAAE,mBAAmB;IACvC,OAAO,EAAE,IAAI;IACb,IAAI,EAAE,OAAO;IACb,cAAc,EAAE,IAAI;CACrB,CAAC;AAOJ,SAAS,IAAI,CAAC,GAA2B;IACvC,MAAM,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC;IAC3B,MAAM,UAAU,GACd,UAAU,CAAC,iBAAiB;QAC5B,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,CACzB,CAAC,CAAC,EAAE,CACF,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,gBAAgB;YACzC,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,iBAAiB,IAAI,CAAC,CAAE,CAA0B,CAAC,YAAY,CAAC,CAC7F;QACD,EAAE,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;IAElC,KAAK,MAAM,IAAI,IAAI,UAAU,CAAC,UAAU,EAAE;QACxC,IAAI,UAAU,EAAE;YACd,qBAAqB,CAAC,IAAI,EAAE,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC;SAC5D;aAAM;YACL,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,iBAAiB,CAAC,CAAC;SAClD;QAED,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,iBAAiB,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE;YAClF,WAAW,CAAC,IAAI,CAAC,CAAC;SACnB;KACF;IAED,SAAS,qBAAqB,CAAC,IAAkB,EAAE,iBAA0B;QAC3E,+EAA+E;QAC/E,QAAQ,IAAI,CAAC,IAAI,EAAE;YACjB,KAAK,EAAE,CAAC,UAAU,CAAC,iBAAiB,CAAC;YACrC,KAAK,EAAE,CAAC,UAAU,CAAC,uBAAuB,CAAC;YAC3C,KAAK,EAAE,CAAC,UAAU,CAAC,iBAAiB,CAAC;YACrC,KAAK,EAAE,CAAC,UAAU,CAAC,0BAA0B;gBAC3C,OAAO;SACV;QAED,8GAA8G;QAC9G,IAAI,CAAC,0CAA0C,CAAC,IAAI,CAAC,EAAE;YACrD,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE;gBACnB,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,sCAAsC,CAAC,CAAC;aACvF;YACD,IAAI,iBAAiB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBACxC,IAAI,CACD,IAAgC,CAAC,IAAI,IAAI,IAAI,EAC9C,8DAA8D;oBAC5D,mDAAmD;oBACnD,4DAA4D;oBAC5D,gEAAgE,CACnE,CAAC;aACH;SACF;IACH,CAAC;IAED,SAAS,YAAY,CAAC,IAAkB,EAAE,iBAA0B;QAClE,gGAAgG;QAChG,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE;YACnB,IACE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,iBAAiB,CAAC;gBACrC,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,oBAAoB;gBAChD,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,oBAAoB,EAChD;gBACA,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,sCAAsC,CAAC,CAAC;aACvF;SACF;IACH,CAAC;IAED,SAAS,IAAI,CAAC,IAAa,EAAE,MAAc;QACzC,GAAG,CAAC,gBAAgB,CAAC,IAAI,EAAE,cAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;IACtE,CAAC;IAED,SAAS,GAAG,CAAC,IAAkB,EAAE,IAAmB;QAClD,OAAO,IAAI,CAAC,SAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAE,CAAC;IACrD,CAAC;IAED,SAAS,WAAW,CAAC,iBAAuC;QAC1D,MAAM,IAAI,GAAG,iBAAiB,CAAC,IAAI,CAAC;QACpC,IAAI,CAAC,IAAI,EAAE;YACT,OAAO;SACR;QAED,QAAQ,IAAI,CAAC,IAAI,EAAE;YACjB,KAAK,EAAE,CAAC,UAAU,CAAC,iBAAiB;gBAClC,WAAW,CAAC,IAAI,CAAC,CAAC;gBAClB,MAAM;YACR,KAAK,EAAE,CAAC,UAAU,CAAC,WAAW;gBAC5B,UAAU,CAAC,IAAI,EAAE,iBAAiB,CAAC,iBAAiB,CAAC,CAAC,CAAC;gBACvD,MAAM;SACT;IACH,CAAC;IAED,SAAS,UAAU,CAAC,KAAqB,EAAE,iBAA0B;QACnE,KAAK,MAAM,CAAC,IAAI,KAAK,CAAC,UAAU,EAAE;YAChC,6EAA6E;YAC7E,IAAI,QAAQ,CAAC,CAAC,CAAC,IAAI,iBAAiB,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE;gBACrD,IAAI,CACF,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EACnC,6CAA6C;oBAC3C,8DAA8D;oBAC9D,wEAAwE;oBACxE,gEAAgE,CACnE,CAAC;aACH;YAED,IAAI,mBAAmB,CAAC,CAAC,CAAC,EAAE;gBAC1B,WAAW,CAAC,CAAC,CAAC,CAAC;aAChB;SACF;IACH,CAAC;AACH,CAAC;AAED,SAAS,0CAA0C,CAAC,IAAa;IAC/D,OAAO,CACL,mBAAmB,CAAC,IAAI,CAAC;QACzB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,aAAa;YAC7C,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,UAAU,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAChF,CAAC;AACJ,CAAC;AAED,SAAS,mBAAmB,CAAC,IAAa;IACxC,OAAO,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,iBAAiB,CAAC;AACvD,CAAC;AAED,SAAS,SAAS,CAAC,IAAa;IAC9B,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;AACxE,CAAC;AAED,SAAS,QAAQ,CAAC,IAAa;IAC7B,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AACvE,CAAC;AAED,SAAS,SAAS,CAAC,IAAa;IAC9B,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;AACxE,CAAC;AAED,2CAA2C;AAC3C,uIAAuI;AACvI,SAAS,qBAAqB,CAAC,IAA0C;IACvE,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;IACvE,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,UAAU,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE;QAC/F,KAAK,MAAM,IAAI,IAAK,IAAqB,CAAC,UAAU,EAAE;YACpD,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,iBAAiB,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE;gBACjG,OAAO,IAAI,CAAC;aACb;SACF;KACF;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,iBAAiB,CAAC,IAA0C;IACnE,0EAA0E;IAC1E,wEAAwE;IACxE,EAAE;IACF,0EAA0E;IAC1E,cAAc;IACd,OAAO,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;AACtC,CAAC"}

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

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

package/bin/src/rules/trimFileRule.js

@@ -0,0 +1,51 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Rule = void 0;
+const Lint = __importStar(require("tslint"));
+const util_1 = require("../util");
+class Rule extends Lint.Rules.AbstractRule {
+    apply(sourceFile) {
+        return this.applyWithFunction(sourceFile, walk);
+    }
+}
+exports.Rule = Rule;
+Rule.metadata = {
+    ruleName: "trim-file",
+    description: "Forbids leading/trailing blank lines in a file. Allows file to end in '\n'.",
+    optionsDescription: "Not configurable.",
+    options: null,
+    type: "style",
+    typescriptOnly: false
+};
+Rule.FAILURE_STRING_LEADING = util_1.failure(Rule.metadata.ruleName, "File should not begin with a blank line.");
+Rule.FAILURE_STRING_TRAILING = util_1.failure(Rule.metadata.ruleName, "File should not end with a blank line. (Ending in one newline OK, ending in two newlines not OK.)");
+function walk(ctx) {
+    const { sourceFile: { text } } = ctx;
+    if (text.startsWith("\r") || text.startsWith("\n")) {
+        ctx.addFailureAt(0, 0, Rule.FAILURE_STRING_LEADING);
+    }
+    if (text.endsWith("\n\n") || text.endsWith("\r\n\r\n")) {
+        const start = text.endsWith("\r\n") ? text.length - 2 : text.length - 1;
+        ctx.addFailureAt(start, 0, Rule.FAILURE_STRING_TRAILING);
+    }
+}
+//# sourceMappingURL=trimFileRule.js.map

package/bin/src/rules/trimFileRule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"trimFileRule.js","sourceRoot":"","sources":["../../../src/rules/trimFileRule.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA+B;AAG/B,kCAAkC;AAElC,MAAa,IAAK,SAAQ,IAAI,CAAC,KAAK,CAAC,YAAY;IAgB/C,KAAK,CAAC,UAAyB;QAC7B,OAAO,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IAClD,CAAC;;AAlBH,oBAmBC;AAlBQ,aAAQ,GAAuB;IACpC,QAAQ,EAAE,WAAW;IACrB,WAAW,EAAE,6EAA6E;IAC1F,kBAAkB,EAAE,mBAAmB;IACvC,OAAO,EAAE,IAAI;IACb,IAAI,EAAE,OAAO;IACb,cAAc,EAAE,KAAK;CACtB,CAAC;AAEK,2BAAsB,GAAG,cAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,0CAA0C,CAAC,CAAC;AACrG,4BAAuB,GAAG,cAAO,CACtC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EACtB,mGAAmG,CACpG,CAAC;AAOJ,SAAS,IAAI,CAAC,GAA2B;IACvC,MAAM,EACJ,UAAU,EAAE,EAAE,IAAI,EAAE,EACrB,GAAG,GAAG,CAAC;IACR,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;QAClD,GAAG,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC;KACrD;IAED,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;QACtD,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;QACxE,GAAG,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC;KAC1D;AACH,CAAC"}

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

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

package/bin/src/rules/voidReturnRule.js

@@ -0,0 +1,85 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Rule = void 0;
+const Lint = __importStar(require("tslint"));
+const ts = __importStar(require("typescript"));
+const util_1 = require("../util");
+class Rule extends Lint.Rules.AbstractRule {
+    apply(sourceFile) {
+        return this.applyWithFunction(sourceFile, walk);
+    }
+}
+exports.Rule = Rule;
+Rule.metadata = {
+    ruleName: "void-return",
+    description: "`void` may only be used as a return type.",
+    rationale: "style",
+    optionsDescription: "Not configurable.",
+    options: null,
+    type: "style",
+    typescriptOnly: true
+};
+Rule.FAILURE_STRING = util_1.failure(Rule.metadata.ruleName, "Use the `void` type for return types only. Otherwise, use `undefined`.");
+function walk(ctx) {
+    ctx.sourceFile.forEachChild(function cb(node) {
+        if (node.kind === ts.SyntaxKind.VoidKeyword && !mayContainVoid(node.parent) && !isReturnType(node)) {
+            ctx.addFailureAtNode(node, Rule.FAILURE_STRING);
+        }
+        else {
+            node.forEachChild(cb);
+        }
+    });
+}
+function mayContainVoid({ kind }) {
+    switch (kind) {
+        case ts.SyntaxKind.TypeReference:
+        case ts.SyntaxKind.ExpressionWithTypeArguments:
+        case ts.SyntaxKind.NewExpression:
+        case ts.SyntaxKind.CallExpression:
+        case ts.SyntaxKind.TypeParameter: // Allow f<T = void>
+            return true;
+        default:
+            return false;
+    }
+}
+function isReturnType(node) {
+    let parent = node.parent;
+    if (parent.kind === ts.SyntaxKind.UnionType) {
+        [node, parent] = [parent, parent.parent];
+    }
+    return isSignatureDeclaration(parent) && parent.type === node;
+}
+function isSignatureDeclaration(node) {
+    switch (node.kind) {
+        case ts.SyntaxKind.ArrowFunction:
+        case ts.SyntaxKind.CallSignature:
+        case ts.SyntaxKind.FunctionDeclaration:
+        case ts.SyntaxKind.FunctionExpression:
+        case ts.SyntaxKind.FunctionType:
+        case ts.SyntaxKind.MethodDeclaration:
+        case ts.SyntaxKind.MethodSignature:
+            return true;
+        default:
+            return false;
+    }
+}
+//# sourceMappingURL=voidReturnRule.js.map

package/bin/src/rules/voidReturnRule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"voidReturnRule.js","sourceRoot":"","sources":["../../../src/rules/voidReturnRule.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA+B;AAC/B,+CAAiC;AAEjC,kCAAkC;AAElC,MAAa,IAAK,SAAQ,IAAI,CAAC,KAAK,CAAC,YAAY;IAgB/C,KAAK,CAAC,UAAyB;QAC7B,OAAO,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IAClD,CAAC;;AAlBH,oBAmBC;AAlBQ,aAAQ,GAAuB;IACpC,QAAQ,EAAE,aAAa;IACvB,WAAW,EAAE,2CAA2C;IACxD,SAAS,EAAE,OAAO;IAClB,kBAAkB,EAAE,mBAAmB;IACvC,OAAO,EAAE,IAAI;IACb,IAAI,EAAE,OAAO;IACb,cAAc,EAAE,IAAI;CACrB,CAAC;AAEK,mBAAc,GAAG,cAAO,CAC7B,IAAI,CAAC,QAAQ,CAAC,QAAQ,EACtB,wEAAwE,CACzE,CAAC;AAOJ,SAAS,IAAI,CAAC,GAA2B;IACvC,GAAG,CAAC,UAAU,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC,IAAI;QAC1C,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,WAAW,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,MAAO,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE;YACnG,GAAG,CAAC,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;SACjD;aAAM;YACL,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;SACvB;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,cAAc,CAAC,EAAE,IAAI,EAAW;IACvC,QAAQ,IAAI,EAAE;QACZ,KAAK,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC;QACjC,KAAK,EAAE,CAAC,UAAU,CAAC,2BAA2B,CAAC;QAC/C,KAAK,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC;QACjC,KAAK,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC;QAClC,KAAK,EAAE,CAAC,UAAU,CAAC,aAAa,EAAE,oBAAoB;YACpD,OAAO,IAAI,CAAC;QACd;YACE,OAAO,KAAK,CAAC;KAChB;AACH,CAAC;AAED,SAAS,YAAY,CAAC,IAAa;IACjC,IAAI,MAAM,GAAG,IAAI,CAAC,MAAO,CAAC;IAC1B,IAAI,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,SAAS,EAAE;QAC3C,CAAC,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,MAAO,CAAC,CAAC;KAC3C;IACD,OAAO,sBAAsB,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC;AAChE,CAAC;AAED,SAAS,sBAAsB,CAAC,IAAa;IAC3C,QAAQ,IAAI,CAAC,IAAI,EAAE;QACjB,KAAK,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC;QACjC,KAAK,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC;QACjC,KAAK,EAAE,CAAC,UAAU,CAAC,mBAAmB,CAAC;QACvC,KAAK,EAAE,CAAC,UAAU,CAAC,kBAAkB,CAAC;QACtC,KAAK,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC;QAChC,KAAK,EAAE,CAAC,UAAU,CAAC,iBAAiB,CAAC;QACrC,KAAK,EAAE,CAAC,UAAU,CAAC,eAAe;YAChC,OAAO,IAAI,CAAC;QACd;YACE,OAAO,KAAK,CAAC;KAChB;AACH,CAAC"}

package/bin/src/suggestions.d.ts

@@ -0,0 +1,12 @@
+import { WalkContext } from "tslint";
+export interface Suggestion {
+    fileName: string;
+    ruleName: string;
+    message: string;
+    start?: number;
+    width?: number;
+}
+/**
+ *  A rule should call this function to provide a suggestion instead of a lint failure.
+ */
+export declare function addSuggestion<T>(ctx: WalkContext<T>, message: string, start?: number, width?: number): void;

package/bin/src/suggestions.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addSuggestion = void 0;
+const fs = require("fs");
+const os = require("os");
+const path = require("path");
+const suggestionsDir = path.join(os.homedir(), ".dts", "suggestions");
+// Packages for which suggestions were already added in this run of dtslint.
+const existingPackages = new Set();
+/**
+ *  A rule should call this function to provide a suggestion instead of a lint failure.
+ */
+function addSuggestion(ctx, message, start, width) {
+    const suggestion = {
+        fileName: ctx.sourceFile.fileName,
+        ruleName: ctx.ruleName,
+        message,
+        start,
+        width
+    };
+    const packageName = dtPackageName(ctx.sourceFile.fileName);
+    if (!packageName) {
+        return;
+    }
+    let flag = "a";
+    if (!existingPackages.has(packageName)) {
+        flag = "w";
+        existingPackages.add(packageName);
+    }
+    try {
+        if (!fs.existsSync(suggestionsDir)) {
+            fs.mkdirSync(suggestionsDir, { recursive: true });
+        }
+        fs.writeFileSync(path.join(suggestionsDir, packageName + ".txt"), flag === "a" ? "\n" + formatSuggestion(suggestion) : formatSuggestion(suggestion), { flag, encoding: "utf8" });
+    }
+    catch (e) {
+        console.log(`Could not write suggestions for package ${packageName}. ${e.message || ""}`);
+    }
+}
+exports.addSuggestion = addSuggestion;
+const dtPath = path.join("DefinitelyTyped", "types");
+function dtPackageName(filePath) {
+    const dtIndex = filePath.indexOf(dtPath);
+    if (dtIndex === -1) {
+        return undefined;
+    }
+    const basePath = filePath.substr(dtIndex + dtPath.length);
+    const dirs = basePath.split(path.sep).filter(dir => dir !== "");
+    if (dirs.length === 0) {
+        return undefined;
+    }
+    const packageName = dirs[0];
+    // Check if this is an old version of a package.
+    if (dirs.length > 1 && /^v\d+(\.\d+)?$/.test(dirs[1])) {
+        return packageName + dirs[1];
+    }
+    return packageName;
+}
+function formatSuggestion(suggestion) {
+    return JSON.stringify(suggestion, /*replacer*/ undefined, 0);
+}
+//# sourceMappingURL=suggestions.js.map

package/bin/src/suggestions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"suggestions.js","sourceRoot":"","sources":["../../src/suggestions.ts"],"names":[],"mappings":";;;AAAA,yBAA0B;AAC1B,yBAA0B;AAC1B,6BAA8B;AAG9B,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;AAUtE,4EAA4E;AAC5E,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAE,CAAC;AAEnC;;GAEG;AACH,SAAgB,aAAa,CAAI,GAAmB,EAAE,OAAe,EAAE,KAAc,EAAE,KAAc;IACnG,MAAM,UAAU,GAAe;QAC7B,QAAQ,EAAE,GAAG,CAAC,UAAU,CAAC,QAAQ;QACjC,QAAQ,EAAE,GAAG,CAAC,QAAQ;QACtB,OAAO;QACP,KAAK;QACL,KAAK;KACN,CAAC;IAEF,MAAM,WAAW,GAAG,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC3D,IAAI,CAAC,WAAW,EAAE;QAChB,OAAO;KACR;IACD,IAAI,IAAI,GAAG,GAAG,CAAC;IACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE;QACtC,IAAI,GAAG,GAAG,CAAC;QACX,gBAAgB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;KACnC;IACD,IAAI;QACF,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE;YAClC,EAAE,CAAC,SAAS,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;SACnD;QACD,EAAE,CAAC,aAAa,CACd,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,WAAW,GAAG,MAAM,CAAC,EAC/C,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,EACjF,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,CAC3B,CAAC;KACH;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,CAAC,GAAG,CAAC,2CAA2C,WAAW,KAAM,CAAW,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC,CAAC;KACtG;AACH,CAAC;AA9BD,sCA8BC;AAED,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;AAErD,SAAS,aAAa,CAAC,QAAgB;IACrC,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACzC,IAAI,OAAO,KAAK,CAAC,CAAC,EAAE;QAClB,OAAO,SAAS,CAAC;KAClB;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IAC1D,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC;IAChE,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QACrB,OAAO,SAAS,CAAC;KAClB;IACD,MAAM,WAAW,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IAC5B,gDAAgD;IAChD,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;QACrD,OAAO,WAAW,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;KAC9B;IACD,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,SAAS,gBAAgB,CAAC,UAAsB;IAC9C,OAAO,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,YAAY,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC"}

package/bin/src/updateConfig.d.ts

@@ -0,0 +1 @@
+export {};

package/bin/src/updateConfig.js

@@ -0,0 +1,220 @@
+"use strict";
+// This is a stand-alone script that updates TSLint configurations for DefinitelyTyped packages.
+// It runs all rules specified in `dt.json`, and updates the existing configuration for a package
+// by adding rule exemptions only for the rules that caused a lint failure.
+// For example, if a configuration specifies `"no-trailing-whitespace": false` and this rule
+// no longer produces an error, then it will not be disabled in the new configuration.
+// If you update or create a rule and now it causes new failures in DT, you can update the `dt.json`
+// configuration with your rule, then register a disabler function for your rule
+// (check `disableRules` function below), then run this script with your rule as argument.
+Object.defineProperty(exports, "__esModule", { value: true });
+const cp = require("child_process");
+const fs = require("fs");
+const stringify = require("json-stable-stringify");
+const path = require("path");
+const tslint_1 = require("tslint");
+const yargs = require("yargs");
+const lint_1 = require("./lint");
+const npmNamingRule_1 = require("./rules/npmNamingRule");
+// Rule "expect" needs TypeScript version information, which this script doesn't collect.
+const ignoredRules = ["expect"];
+function main() {
+    const args = yargs
+        .usage(`\`$0 --dt=path-to-dt\` or \`$0 --package=path-to-dt-package\`
+'dt.json' is used as the base tslint config for running the linter.`)
+        .option("package", {
+        describe: "Path of DT package.",
+        type: "string",
+        conflicts: "dt"
+    })
+        .option("dt", {
+        describe: "Path of local DefinitelyTyped repository.",
+        type: "string",
+        conflicts: "package"
+    })
+        .option("rules", {
+        describe: "Names of the rules to be updated. Leave this empty to update all rules.",
+        type: "array",
+        string: true,
+        default: []
+    })
+        .check(arg => {
+        if (!arg.package && !arg.dt) {
+            throw new Error("You must provide either argument 'package' or 'dt'.");
+        }
+        const unsupportedRules = arg.rules.filter(rule => ignoredRules.includes(rule));
+        if (unsupportedRules.length > 0) {
+            throw new Error(`Rules ${unsupportedRules.join(", ")} are not supported at the moment.`);
+        }
+        return true;
+    }).argv;
+    if (args.package) {
+        updatePackage(args.package, dtConfig(args.rules));
+    }
+    else if (args.dt) {
+        updateAll(args.dt, dtConfig(args.rules));
+    }
+}
+const dtConfigPath = "dt.json";
+function dtConfig(updatedRules) {
+    const config = tslint_1.Configuration.findConfiguration(dtConfigPath).results;
+    if (!config) {
+        throw new Error(`Could not load config at ${dtConfigPath}.`);
+    }
+    // Disable ignored or non-updated rules.
+    for (const entry of config.rules.entries()) {
+        const [rule, ruleOpts] = entry;
+        if (ignoredRules.includes(rule) || (updatedRules.length > 0 && !updatedRules.includes(rule))) {
+            ruleOpts.ruleSeverity = "off";
+        }
+    }
+    return config;
+}
+function updateAll(dtPath, config) {
+    const packages = fs.readdirSync(path.join(dtPath, "types"));
+    for (const pkg of packages) {
+        updatePackage(path.join(dtPath, "types", pkg), config);
+    }
+}
+function updatePackage(pkgPath, baseConfig) {
+    installDependencies(pkgPath);
+    const packages = walkPackageDir(pkgPath);
+    const linterOpts = {
+        fix: false
+    };
+    for (const pkg of packages) {
+        const results = pkg.lint(linterOpts, baseConfig);
+        if (results.failures.length > 0) {
+            const disabledRules = disableRules(results.failures);
+            const newConfig = mergeConfigRules(pkg.config(), disabledRules, baseConfig);
+            pkg.updateConfig(newConfig);
+        }
+    }
+}
+function installDependencies(pkgPath) {
+    if (fs.existsSync(path.join(pkgPath, "package.json"))) {
+        cp.execSync("npm install --ignore-scripts --no-shrinkwrap --no-package-lock --no-bin-links", {
+            encoding: "utf8",
+            cwd: pkgPath
+        });
+    }
+}
+function mergeConfigRules(config, newRules, baseConfig) {
+    const activeRules = [];
+    baseConfig.rules.forEach((ruleOpts, ruleName) => {
+        if (ruleOpts.ruleSeverity !== "off") {
+            activeRules.push(ruleName);
+        }
+    });
+    const oldRules = config.rules || {};
+    let newRulesConfig = {};
+    for (const rule of Object.keys(oldRules)) {
+        if (activeRules.includes(rule)) {
+            continue;
+        }
+        newRulesConfig[rule] = oldRules[rule];
+    }
+    newRulesConfig = { ...newRulesConfig, ...newRules };
+    return { ...config, rules: newRulesConfig };
+}
+/**
+ * Represents a package from the linter's perspective.
+ * For example, `DefinitelyTyped/types/react` and `DefinitelyTyped/types/react/v15` are different
+ * packages.
+ */
+class LintPackage {
+    constructor(rootDir) {
+        this.rootDir = rootDir;
+        this.files = [];
+        this.program = tslint_1.Linter.createProgram(path.join(this.rootDir, "tsconfig.json"));
+    }
+    config() {
+        return tslint_1.Configuration.readConfigurationFile(path.join(this.rootDir, "tslint.json"));
+    }
+    addFile(filePath) {
+        const file = this.program.getSourceFile(filePath);
+        if (file) {
+            this.files.push(file);
+        }
+    }
+    lint(opts, config) {
+        const linter = new tslint_1.Linter(opts, this.program);
+        for (const file of this.files) {
+            if (ignoreFile(file, this.rootDir, this.program)) {
+                continue;
+            }
+            linter.lint(file.fileName, file.text, config);
+        }
+        return linter.getResult();
+    }
+    updateConfig(config) {
+        fs.writeFileSync(path.join(this.rootDir, "tslint.json"), stringify(config, { space: 4 }), {
+            encoding: "utf8",
+            flag: "w"
+        });
+    }
+}
+function ignoreFile(file, dirPath, program) {
+    return program.isSourceFileDefaultLibrary(file) || lint_1.isExternalDependency(file, path.resolve(dirPath), program);
+}
+function walkPackageDir(rootDir) {
+    const packages = [];
+    function walk(curPackage, dir) {
+        for (const ent of fs.readdirSync(dir, { encoding: "utf8", withFileTypes: true })) {
+            const entPath = path.join(dir, ent.name);
+            if (ent.isFile()) {
+                curPackage.addFile(entPath);
+            }
+            else if (ent.isDirectory() && ent.name !== "node_modules") {
+                if (isVersionDir(ent.name)) {
+                    const newPackage = new LintPackage(entPath);
+                    packages.push(newPackage);
+                    walk(newPackage, entPath);
+                }
+                else {
+                    walk(curPackage, entPath);
+                }
+            }
+        }
+    }
+    const lintPackage = new LintPackage(rootDir);
+    packages.push(lintPackage);
+    walk(lintPackage, rootDir);
+    return packages;
+}
+/**
+ * Returns true if directory name matches a TypeScript or package version directory.
+ * Examples: `ts3.5`, `v11`, `v0.6` are all version names.
+ */
+function isVersionDir(dirName) {
+    return /^ts\d+\.\d$/.test(dirName) || /^v\d+(\.\d+)?$/.test(dirName);
+}
+const defaultDisabler = () => {
+    return false;
+};
+function disableRules(allFailures) {
+    const ruleToFailures = new Map();
+    for (const failure of allFailures) {
+        const failureJson = failure.toJson();
+        if (ruleToFailures.has(failureJson.ruleName)) {
+            ruleToFailures.get(failureJson.ruleName).push(failureJson);
+        }
+        else {
+            ruleToFailures.set(failureJson.ruleName, [failureJson]);
+        }
+    }
+    const newRulesConfig = {};
+    ruleToFailures.forEach((failures, rule) => {
+        if (ignoredRules.includes(rule)) {
+            return;
+        }
+        const disabler = rule === "npm-naming" ? npmNamingRule_1.disabler : defaultDisabler;
+        const opts = disabler(failures);
+        newRulesConfig[rule] = opts;
+    });
+    return newRulesConfig;
+}
+if (!module.parent) {
+    main();
+}
+//# sourceMappingURL=updateConfig.js.map