@definitelytyped/dtslint 0.0.95 → 0.0.97

package/bin/src/rules/noRedundantJsdoc2Rule.js

@@ -0,0 +1,245 @@
+"use strict";
+// Fixes temporarily moved here until they are published by tslint.
+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 assert = require("assert");
+const Lint = __importStar(require("tslint"));
+const ts = __importStar(require("typescript"));
+class Rule extends Lint.Rules.AbstractRule {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    static FAILURE_STRING_REDUNDANT_TAG(tagName) {
+        return `JSDoc tag '@${tagName}' is redundant in TypeScript code.`;
+    }
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    static FAILURE_STRING_NO_COMMENT(tagName) {
+        return `'@${tagName}' is redundant in TypeScript code if it has no description.`;
+    }
+    apply(sourceFile) {
+        return this.applyWithFunction(sourceFile, walk);
+    }
+}
+exports.Rule = Rule;
+Rule.metadata = {
+    ruleName: "no-redundant-jsdoc",
+    description: "Forbids JSDoc which duplicates TypeScript functionality.",
+    optionsDescription: "Not configurable.",
+    options: null,
+    optionExamples: [true],
+    type: "style",
+    typescriptOnly: true
+};
+Rule.FAILURE_STRING_REDUNDANT_TYPE = "Type annotation in JSDoc is redundant in TypeScript code.";
+Rule.FAILURE_STRING_EMPTY = "JSDoc comment is empty.";
+function walk(ctx) {
+    const { sourceFile } = ctx;
+    // Intentionally exclude EndOfFileToken: it can have JSDoc, but it is only relevant in JavaScript files
+    return sourceFile.statements.forEach(function cb(node) {
+        if (node.kind !== ts.SyntaxKind.EndOfFileToken && ts.hasJSDocNodes(node)) {
+            for (const jd of node.jsDoc) {
+                const { tags } = jd;
+                if (tags === undefined || tags.length === 0) {
+                    if (jd.comment === undefined) {
+                        ctx.addFailureAtNode(jd, Rule.FAILURE_STRING_EMPTY, Lint.Replacement.deleteFromTo(jd.getStart(sourceFile), jd.getEnd()));
+                    }
+                }
+                else {
+                    for (const tag of tags) {
+                        checkTag(tag);
+                    }
+                }
+            }
+        }
+        return ts.forEachChild(node, cb);
+    });
+    function checkTag(tag) {
+        const jsdocSeeTag = ts.SyntaxKind.JSDocSeeTag || 0;
+        const jsdocDeprecatedTag = ts.SyntaxKind.JSDocDeprecatedTag || 0;
+        switch (tag.kind) {
+            case jsdocSeeTag:
+            case jsdocDeprecatedTag:
+            case ts.SyntaxKind.JSDocAuthorTag:
+                // @deprecated and @see always have meaning
+                break;
+            case ts.SyntaxKind.JSDocTag: {
+                const { tagName } = tag;
+                const { text } = tagName;
+                // Allow "default" in an ambient context (since you can't write an initializer in an ambient context)
+                if (redundantTags.has(text) && !(text === "default" && isInAmbientContext(tag))) {
+                    ctx.addFailureAtNode(tagName, Rule.FAILURE_STRING_REDUNDANT_TAG(text), removeTag(tag, sourceFile));
+                }
+                break;
+            }
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore (fallthrough)
+            case ts.SyntaxKind.JSDocTemplateTag:
+                if (tag.comment !== "") {
+                    break;
+                }
+            // falls through
+            case ts.SyntaxKind.JSDocPublicTag:
+            case ts.SyntaxKind.JSDocPrivateTag:
+            case ts.SyntaxKind.JSDocProtectedTag:
+            case ts.SyntaxKind.JSDocClassTag:
+            case ts.SyntaxKind.JSDocTypeTag:
+            case ts.SyntaxKind.JSDocTypedefTag:
+            case ts.SyntaxKind.JSDocReadonlyTag:
+            case ts.SyntaxKind.JSDocPropertyTag:
+            case ts.SyntaxKind.JSDocAugmentsTag:
+            case ts.SyntaxKind.JSDocImplementsTag:
+            case ts.SyntaxKind.JSDocCallbackTag:
+            case ts.SyntaxKind.JSDocThisTag:
+            case ts.SyntaxKind.JSDocEnumTag:
+                // Always redundant
+                ctx.addFailureAtNode(tag.tagName, Rule.FAILURE_STRING_REDUNDANT_TAG(tag.tagName.text), removeTag(tag, sourceFile));
+                break;
+            case ts.SyntaxKind.JSDocReturnTag:
+            case ts.SyntaxKind.JSDocParameterTag: {
+                const { typeExpression, comment } = tag;
+                const noComment = comment === "";
+                if (typeExpression !== undefined) {
+                    // If noComment, we will just completely remove it in the other fix
+                    const fix = noComment ? undefined : removeTypeExpression(typeExpression, sourceFile);
+                    ctx.addFailureAtNode(typeExpression, Rule.FAILURE_STRING_REDUNDANT_TYPE, fix);
+                }
+                if (noComment) {
+                    // Redundant if no documentation
+                    ctx.addFailureAtNode(tag.tagName, Rule.FAILURE_STRING_NO_COMMENT(tag.tagName.text), removeTag(tag, sourceFile));
+                }
+                break;
+            }
+            default:
+                throw new Error(`Unexpected tag kind: ${ts.SyntaxKind[tag.kind]}`);
+        }
+    }
+}
+function removeTag(tag, sourceFile) {
+    const { text } = sourceFile;
+    const jsdoc = tag.parent;
+    if (jsdoc.kind === ts.SyntaxKind.JSDocTypeLiteral) {
+        return undefined;
+    }
+    if (jsdoc.comment === undefined && jsdoc.tags.length === 1) {
+        // This is the only tag -- remove the whole comment
+        return Lint.Replacement.deleteFromTo(jsdoc.getStart(sourceFile), jsdoc.getEnd());
+    }
+    let start = tag.getStart(sourceFile);
+    assert(text[start] === "@");
+    start--;
+    while (ts.isWhiteSpaceSingleLine(text.charCodeAt(start))) {
+        start--;
+    }
+    if (text[start] !== "*") {
+        return undefined;
+    }
+    let end = tag.getEnd();
+    // For some tags, like `@param`, `end` will be the start of the next tag.
+    // For some tags, like `@name`, `end` will be before the start of the comment.
+    // And `@typedef` doesn't end until the last `@property` tag attached to it ends.
+    switch (tag.tagName.text) {
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore (fallthrough)
+        case "param": {
+            const { isBracketed, isNameFirst, typeExpression } = tag;
+            if (!isBracketed && !(isNameFirst && typeExpression !== undefined)) {
+                break;
+            }
+            // falls through
+        }
+        // eslint-disable-next-line no-fallthrough
+        case "name":
+        case "return":
+        case "returns":
+        case "interface":
+        case "default":
+        case "memberof":
+        case "memberOf":
+        case "method":
+        case "type":
+        case "class":
+        case "property":
+        case "function":
+            end--; // Might end with "\n" (test with just `@return` with no comment or type)
+            // For some reason, for "@name", "end" is before the start of the comment part of the tag.
+            // Also for "param" if the name is optional  as in `@param {number} [x]`
+            while (!ts.isLineBreak(text.charCodeAt(end))) {
+                end++;
+            }
+            end++;
+    }
+    while (ts.isWhiteSpaceSingleLine(text.charCodeAt(end))) {
+        end++;
+    }
+    if (text[end] !== "*") {
+        return undefined;
+    }
+    return Lint.Replacement.deleteFromTo(start, end);
+}
+function removeTypeExpression(typeExpression, sourceFile) {
+    const start = typeExpression.getStart(sourceFile);
+    let end = typeExpression.getEnd();
+    const { text } = sourceFile;
+    if (text[start] !== "{" || text[end - 1] !== "}") {
+        // TypeScript parser messed up -- give up
+        return undefined;
+    }
+    if (ts.isWhiteSpaceSingleLine(text.charCodeAt(end))) {
+        end++;
+    }
+    return Lint.Replacement.deleteFromTo(start, end);
+}
+// TODO: improve once https://github.com/Microsoft/TypeScript/pull/17831 is in
+function isInAmbientContext(node) {
+    return ts.isSourceFile(node)
+        ? node.isDeclarationFile
+        : Lint.hasModifier(node.modifiers, ts.SyntaxKind.DeclareKeyword) || isInAmbientContext(node.parent);
+}
+const redundantTags = new Set([
+    "abstract",
+    "access",
+    "class",
+    "constant",
+    "constructs",
+    "default",
+    "enum",
+    "export",
+    "exports",
+    "function",
+    "global",
+    "inherits",
+    "interface",
+    "instance",
+    "member",
+    "method",
+    "memberof",
+    "memberOf",
+    "mixes",
+    "mixin",
+    "module",
+    "name",
+    "namespace",
+    "override",
+    "property",
+    "requires",
+    "static",
+    "this"
+]);
+//# sourceMappingURL=noRedundantJsdoc2Rule.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"noRedundantJsdoc2Rule.js","sourceRoot":"","sources":["../../../src/rules/noRedundantJsdoc2Rule.ts"],"names":[],"mappings":";AAAA,mEAAmE;;;;;;;;;;;;;;;;;;;;;;AAEnE,iCAAkC;AAClC,6CAA+B;AAC/B,+CAAiC;AAEjC,MAAa,IAAK,SAAQ,IAAI,CAAC,KAAK,CAAC,YAAY;IAY/C,gEAAgE;IAChE,MAAM,CAAC,4BAA4B,CAAC,OAAe;QACjD,OAAO,eAAe,OAAO,oCAAoC,CAAC;IACpE,CAAC;IACD,gEAAgE;IAChE,MAAM,CAAC,yBAAyB,CAAC,OAAe;QAC9C,OAAO,KAAK,OAAO,6DAA6D,CAAC;IACnF,CAAC;IAED,KAAK,CAAC,UAAyB;QAC7B,OAAO,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IAClD,CAAC;;AAvBH,oBAwBC;AAvBQ,aAAQ,GAAuB;IACpC,QAAQ,EAAE,oBAAoB;IAC9B,WAAW,EAAE,0DAA0D;IACvE,kBAAkB,EAAE,mBAAmB;IACvC,OAAO,EAAE,IAAI;IACb,cAAc,EAAE,CAAC,IAAI,CAAC;IACtB,IAAI,EAAE,OAAO;IACb,cAAc,EAAE,IAAI;CACrB,CAAC;AACc,kCAA6B,GAAG,2DAA2D,CAAC;AAC5F,yBAAoB,GAAG,yBAAyB,CAAC;AAenE,SAAS,IAAI,CAAC,GAA2B;IACvC,MAAM,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC;IAC3B,uGAAuG;IACvG,OAAO,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,IAAa;QAC5D,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,cAAc,IAAK,EAAU,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE;YACjF,KAAK,MAAM,EAAE,IAAK,IAAY,CAAC,KAAK,EAAE;gBACpC,MAAM,EAAE,IAAI,EAAE,GAAG,EAAc,CAAC;gBAChC,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;oBAC3C,IAAI,EAAE,CAAC,OAAO,KAAK,SAAS,EAAE;wBAC5B,GAAG,CAAC,gBAAgB,CAClB,EAAE,EACF,IAAI,CAAC,oBAAoB,EACzB,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC,CACpE,CAAC;qBACH;iBACF;qBAAM;oBACL,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;wBACtB,QAAQ,CAAC,GAAG,CAAC,CAAC;qBACf;iBACF;aACF;SACF;QACD,OAAO,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;IAEH,SAAS,QAAQ,CAAC,GAAgB;QAChC,MAAM,WAAW,GAAI,EAAE,CAAC,UAAkB,CAAC,WAAW,IAAI,CAAC,CAAC;QAC5D,MAAM,kBAAkB,GAAI,EAAE,CAAC,UAAkB,CAAC,kBAAkB,IAAI,CAAC,CAAC;QAC1E,QAAQ,GAAG,CAAC,IAAI,EAAE;YAChB,KAAK,WAAW,CAAC;YACjB,KAAK,kBAAkB,CAAC;YACxB,KAAK,EAAE,CAAC,UAAU,CAAC,cAAc;gBAC/B,2CAA2C;gBAC3C,MAAM;YACR,KAAK,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;gBAC3B,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,CAAC;gBACxB,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;gBACzB,qGAAqG;gBACrG,IAAI,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,IAAI,kBAAkB,CAAC,GAAG,CAAC,CAAC,EAAE;oBAC/E,GAAG,CAAC,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC;iBACpG;gBACD,MAAM;aACP;YAED,6DAA6D;YAC7D,2BAA2B;YAC3B,KAAK,EAAE,CAAC,UAAU,CAAC,gBAAgB;gBACjC,IAAI,GAAG,CAAC,OAAO,KAAK,EAAE,EAAE;oBACtB,MAAM;iBACP;YACH,gBAAgB;YAEhB,KAAK,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC;YAClC,KAAK,EAAE,CAAC,UAAU,CAAC,eAAe,CAAC;YACnC,KAAK,EAAE,CAAC,UAAU,CAAC,iBAAiB,CAAC;YACrC,KAAK,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC;YACjC,KAAK,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC;YAChC,KAAK,EAAE,CAAC,UAAU,CAAC,eAAe,CAAC;YACnC,KAAK,EAAE,CAAC,UAAU,CAAC,gBAAgB,CAAC;YACpC,KAAK,EAAE,CAAC,UAAU,CAAC,gBAAgB,CAAC;YACpC,KAAK,EAAE,CAAC,UAAU,CAAC,gBAAgB,CAAC;YACpC,KAAK,EAAE,CAAC,UAAU,CAAC,kBAAkB,CAAC;YACtC,KAAK,EAAE,CAAC,UAAU,CAAC,gBAAgB,CAAC;YACpC,KAAK,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC;YAChC,KAAK,EAAE,CAAC,UAAU,CAAC,YAAY;gBAC7B,mBAAmB;gBACnB,GAAG,CAAC,gBAAgB,CAClB,GAAG,CAAC,OAAO,EACX,IAAI,CAAC,4BAA4B,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,EACnD,SAAS,CAAC,GAAG,EAAE,UAAU,CAAC,CAC3B,CAAC;gBACF,MAAM;YAER,KAAK,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC;YAClC,KAAK,EAAE,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;gBACpC,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,GAAG,GAA+C,CAAC;gBACpF,MAAM,SAAS,GAAG,OAAO,KAAK,EAAE,CAAC;gBACjC,IAAI,cAAc,KAAK,SAAS,EAAE;oBAChC,mEAAmE;oBACnE,MAAM,GAAG,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,oBAAoB,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;oBACrF,GAAG,CAAC,gBAAgB,CAAC,cAAc,EAAE,IAAI,CAAC,6BAA6B,EAAE,GAAG,CAAC,CAAC;iBAC/E;gBACD,IAAI,SAAS,EAAE;oBACb,gCAAgC;oBAChC,GAAG,CAAC,gBAAgB,CAClB,GAAG,CAAC,OAAO,EACX,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,EAChD,SAAS,CAAC,GAAG,EAAE,UAAU,CAAC,CAC3B,CAAC;iBACH;gBACD,MAAM;aACP;YAED;gBACE,MAAM,IAAI,KAAK,CAAC,wBAAwB,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SACtE;IACH,CAAC;AACH,CAAC;AAED,SAAS,SAAS,CAAC,GAAgB,EAAE,UAAyB;IAC5D,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;IAC5B,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC;IACzB,IAAI,KAAK,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE;QACjD,OAAO,SAAS,CAAC;KAClB;IAED,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,CAAC,IAAK,CAAC,MAAM,KAAK,CAAC,EAAE;QAC3D,mDAAmD;QACnD,OAAO,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;KAClF;IAED,IAAI,KAAK,GAAG,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IACrC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC;IAC5B,KAAK,EAAE,CAAC;IACR,OAAO,EAAE,CAAC,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE;QACxD,KAAK,EAAE,CAAC;KACT;IACD,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,EAAE;QACvB,OAAO,SAAS,CAAC;KAClB;IAED,IAAI,GAAG,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC;IAEvB,yEAAyE;IACzE,8EAA8E;IAC9E,iFAAiF;IACjF,QAAQ,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE;QACxB,6DAA6D;QAC7D,2BAA2B;QAC3B,KAAK,OAAO,CAAC,CAAC;YACZ,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE,GAAG,GAA2B,CAAC;YACjF,IAAI,CAAC,WAAW,IAAI,CAAC,CAAC,WAAW,IAAI,cAAc,KAAK,SAAS,CAAC,EAAE;gBAClE,MAAM;aACP;YACD,gBAAgB;SACjB;QACD,0CAA0C;QAC1C,KAAK,MAAM,CAAC;QACZ,KAAK,QAAQ,CAAC;QACd,KAAK,SAAS,CAAC;QACf,KAAK,WAAW,CAAC;QACjB,KAAK,SAAS,CAAC;QACf,KAAK,UAAU,CAAC;QAChB,KAAK,UAAU,CAAC;QAChB,KAAK,QAAQ,CAAC;QACd,KAAK,MAAM,CAAC;QACZ,KAAK,OAAO,CAAC;QACb,KAAK,UAAU,CAAC;QAChB,KAAK,UAAU;YACb,GAAG,EAAE,CAAC,CAAC,yEAAyE;YAChF,0FAA0F;YAC1F,wEAAwE;YACxE,OAAO,CAAC,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE;gBAC5C,GAAG,EAAE,CAAC;aACP;YACD,GAAG,EAAE,CAAC;KACT;IACD,OAAO,EAAE,CAAC,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE;QACtD,GAAG,EAAE,CAAC;KACP;IACD,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,EAAE;QACrB,OAAO,SAAS,CAAC;KAClB;IAED,OAAO,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AACnD,CAAC;AAED,SAAS,oBAAoB,CAC3B,cAAsC,EACtC,UAAyB;IAEzB,MAAM,KAAK,GAAG,cAAc,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IAClD,IAAI,GAAG,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC;IAClC,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;IAC5B,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE;QAChD,yCAAyC;QACzC,OAAO,SAAS,CAAC;KAClB;IACD,IAAI,EAAE,CAAC,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE;QACnD,GAAG,EAAE,CAAC;KACP;IACD,OAAO,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AACnD,CAAC;AAED,8EAA8E;AAC9E,SAAS,kBAAkB,CAAC,IAAa;IACvC,OAAO,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC;QAC1B,CAAC,CAAC,IAAI,CAAC,iBAAiB;QACxB,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,kBAAkB,CAAC,IAAI,CAAC,MAAO,CAAC,CAAC;AACzG,CAAC;AAED,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC;IAC5B,UAAU;IACV,QAAQ;IACR,OAAO;IACP,UAAU;IACV,YAAY;IACZ,SAAS;IACT,MAAM;IACN,QAAQ;IACR,SAAS;IACT,UAAU;IACV,QAAQ;IACR,UAAU;IACV,WAAW;IACX,UAAU;IACV,QAAQ;IACR,QAAQ;IACR,UAAU;IACV,UAAU;IACV,OAAO;IACP,OAAO;IACP,QAAQ;IACR,MAAM;IACN,WAAW;IACX,UAAU;IACV,UAAU;IACV,UAAU;IACV,QAAQ;IACR,MAAM;CACP,CAAC,CAAC"}

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

@@ -0,0 +1,11 @@
+import * as Lint from "tslint";
+import * as ts from "typescript";
+export declare class Rule extends Lint.Rules.TypedRule {
+    static metadata: Lint.IRuleMetadata;
+    applyWithProgram(sourceFile: ts.SourceFile, program: ts.Program): Lint.RuleFailure[];
+}
+declare module "typescript" {
+    interface SourceFile {
+        imports: readonly ts.StringLiteral[];
+    }
+}

package/bin/src/rules/noRelativeImportInTestRule.js

@@ -0,0 +1,60 @@
+"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.TypedRule {
+    applyWithProgram(sourceFile, program) {
+        if (sourceFile.isDeclarationFile) {
+            return [];
+        }
+        return this.applyWithFunction(sourceFile, ctx => walk(ctx, program.getTypeChecker()));
+    }
+}
+exports.Rule = Rule;
+Rule.metadata = {
+    ruleName: "no-relative-import-in-test",
+    description: "Forbids test (non-declaration) files to use relative imports.",
+    optionsDescription: "Not configurable.",
+    options: null,
+    type: "functionality",
+    typescriptOnly: false
+};
+const failureMessage = util_1.failure(Rule.metadata.ruleName, "Test file should not use a relative import. Use a global import as if this were a user of the package.");
+function walk(ctx, checker) {
+    const { sourceFile } = ctx;
+    for (const i of sourceFile.imports) {
+        if (i.text.startsWith(".")) {
+            const moduleSymbol = checker.getSymbolAtLocation(i);
+            if (!moduleSymbol || !moduleSymbol.declarations) {
+                continue;
+            }
+            for (const decl of moduleSymbol.declarations) {
+                if (decl.kind === ts.SyntaxKind.SourceFile && decl.isDeclarationFile) {
+                    ctx.addFailureAtNode(i, failureMessage);
+                }
+            }
+        }
+    }
+}
+//# sourceMappingURL=noRelativeImportInTestRule.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"noRelativeImportInTestRule.js","sourceRoot":"","sources":["../../../src/rules/noRelativeImportInTestRule.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA+B;AAC/B,+CAAiC;AAEjC,kCAAkC;AAElC,MAAa,IAAK,SAAQ,IAAI,CAAC,KAAK,CAAC,SAAS;IAU5C,gBAAgB,CAAC,UAAyB,EAAE,OAAmB;QAC7D,IAAI,UAAU,CAAC,iBAAiB,EAAE;YAChC,OAAO,EAAE,CAAC;SACX;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;IACxF,CAAC;;AAhBH,oBAiBC;AAhBQ,aAAQ,GAAuB;IACpC,QAAQ,EAAE,4BAA4B;IACtC,WAAW,EAAE,+DAA+D;IAC5E,kBAAkB,EAAE,mBAAmB;IACvC,OAAO,EAAE,IAAI;IACb,IAAI,EAAE,eAAe;IACrB,cAAc,EAAE,KAAK;CACtB,CAAC;AAWJ,MAAM,cAAc,GAAG,cAAO,CAC5B,IAAI,CAAC,QAAQ,CAAC,QAAQ,EACtB,wGAAwG,CACzG,CAAC;AAEF,SAAS,IAAI,CAAC,GAA2B,EAAE,OAAuB;IAChE,MAAM,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC;IAE3B,KAAK,MAAM,CAAC,IAAI,UAAU,CAAC,OAAO,EAAE;QAClC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC1B,MAAM,YAAY,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;YACpD,IAAI,CAAC,YAAY,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE;gBAC/C,SAAS;aACV;YAED,KAAK,MAAM,IAAI,IAAI,YAAY,CAAC,YAAY,EAAE;gBAC5C,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,UAAU,CAAC,UAAU,IAAK,IAAsB,CAAC,iBAAiB,EAAE;oBACvF,GAAG,CAAC,gBAAgB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;iBACzC;aACF;SACF;KACF;AACH,CAAC"}

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

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

package/bin/src/rules/noSelfImportRule.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.TypedRule {
+    applyWithProgram(sourceFile, program) {
+        if (!sourceFile.isDeclarationFile) {
+            return [];
+        }
+        const name = util_1.getCommonDirectoryName(program.getRootFileNames());
+        return this.applyWithFunction(sourceFile, ctx => walk(ctx, name));
+    }
+}
+exports.Rule = Rule;
+Rule.metadata = {
+    ruleName: "no-self-import",
+    description: "Forbids declaration files to import the current package using a global import.",
+    optionsDescription: "Not configurable.",
+    options: null,
+    type: "functionality",
+    typescriptOnly: false
+};
+const failureMessage = util_1.failure(Rule.metadata.ruleName, "Declaration file should not use a global import of itself. Use a relative import.");
+function walk(ctx, packageName) {
+    for (const i of ctx.sourceFile.imports) {
+        if (i.text === packageName || i.text.startsWith(packageName + "/")) {
+            ctx.addFailureAtNode(i, failureMessage);
+        }
+    }
+}
+//# sourceMappingURL=noSelfImportRule.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"noSelfImportRule.js","sourceRoot":"","sources":["../../../src/rules/noSelfImportRule.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA+B;AAG/B,kCAA0D;AAE1D,MAAa,IAAK,SAAQ,IAAI,CAAC,KAAK,CAAC,SAAS;IAU5C,gBAAgB,CAAC,UAAyB,EAAE,OAAmB;QAC7D,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE;YACjC,OAAO,EAAE,CAAC;SACX;QAED,MAAM,IAAI,GAAG,6BAAsB,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;QAChE,OAAO,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;IACpE,CAAC;;AAjBH,oBAkBC;AAjBQ,aAAQ,GAAuB;IACpC,QAAQ,EAAE,gBAAgB;IAC1B,WAAW,EAAE,gFAAgF;IAC7F,kBAAkB,EAAE,mBAAmB;IACvC,OAAO,EAAE,IAAI;IACb,IAAI,EAAE,eAAe;IACrB,cAAc,EAAE,KAAK;CACtB,CAAC;AAYJ,MAAM,cAAc,GAAG,cAAO,CAC5B,IAAI,CAAC,QAAQ,CAAC,QAAQ,EACtB,mFAAmF,CACpF,CAAC;AAEF,SAAS,IAAI,CAAC,GAA2B,EAAE,WAAmB;IAC5D,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,OAAO,EAAE;QACtC,IAAI,CAAC,CAAC,IAAI,KAAK,WAAW,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,GAAG,GAAG,CAAC,EAAE;YAClE,GAAG,CAAC,gBAAgB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;SACzC;KACF;AACH,CAAC"}

package/bin/src/rules/noSingleDeclareModuleRule.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/noSingleDeclareModuleRule.js

@@ -0,0 +1,68 @@
+"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: "no-single-declare-module",
+    description: "Don't use an ambient module declaration if there's just one -- write it as a normal module.",
+    rationale: "Cuts down on nesting",
+    optionsDescription: "Not configurable.",
+    options: null,
+    type: "style",
+    typescriptOnly: true
+};
+Rule.FAILURE_STRING = util_1.failure(Rule.metadata.ruleName, "File has only 1 ambient module declaration. Move the contents outside the ambient module block, rename the file to match the ambient module name, and remove the block.");
+function walk(ctx) {
+    const { sourceFile } = ctx;
+    // If it's an external module, any module declarations inside are augmentations.
+    if (ts.isExternalModule(sourceFile)) {
+        return;
+    }
+    let moduleDecl;
+    for (const statement of sourceFile.statements) {
+        if (ts.isModuleDeclaration(statement) && ts.isStringLiteral(statement.name)) {
+            if (statement.name.text.indexOf("*") !== -1) {
+                // Ignore wildcard module declarations
+                return;
+            }
+            if (moduleDecl === undefined) {
+                moduleDecl = statement;
+            }
+            else {
+                // Has more than 1 declaration
+                return;
+            }
+        }
+    }
+    if (moduleDecl) {
+        ctx.addFailureAtNode(moduleDecl, Rule.FAILURE_STRING);
+    }
+}
+//# sourceMappingURL=noSingleDeclareModuleRule.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"noSingleDeclareModuleRule.js","sourceRoot":"","sources":["../../../src/rules/noSingleDeclareModuleRule.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,0BAA0B;IACpC,WAAW,EAAE,6FAA6F;IAC1G,SAAS,EAAE,sBAAsB;IACjC,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,yKAAyK,CAC1K,CAAC;AAOJ,SAAS,IAAI,CAAC,GAA2B;IACvC,MAAM,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC;IAE3B,gFAAgF;IAChF,IAAI,EAAE,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE;QACnC,OAAO;KACR;IAED,IAAI,UAA4C,CAAC;IACjD,KAAK,MAAM,SAAS,IAAI,UAAU,CAAC,UAAU,EAAE;QAC7C,IAAI,EAAE,CAAC,mBAAmB,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,eAAe,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE;YAC3E,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE;gBAC3C,sCAAsC;gBACtC,OAAO;aACR;YAED,IAAI,UAAU,KAAK,SAAS,EAAE;gBAC5B,UAAU,GAAG,SAAS,CAAC;aACxB;iBAAM;gBACL,8BAA8B;gBAC9B,OAAO;aACR;SACF;KACF;IAED,IAAI,UAAU,EAAE;QACd,GAAG,CAAC,gBAAgB,CAAC,UAAU,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;KACvD;AACH,CAAC"}

package/bin/src/rules/noSingleElementTupleTypeRule.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/noSingleElementTupleTypeRule.js

@@ -0,0 +1,50 @@
+"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: "no-single-element-tuple-type",
+    description: "Forbids `[T]`, which should be `T[]`.",
+    optionsDescription: "Not configurable.",
+    options: null,
+    type: "functionality",
+    typescriptOnly: true
+};
+function walk(ctx) {
+    const { sourceFile } = ctx;
+    sourceFile.forEachChild(function cb(node) {
+        var _a;
+        if (ts.isTupleTypeNode(node) && ((_a = node.elements) !== null && _a !== void 0 ? _a : node.elementTypes).length === 1) {
+            ctx.addFailureAtNode(node, util_1.failure(Rule.metadata.ruleName, "Type [T] is a single-element tuple type. You probably meant T[]."));
+        }
+        node.forEachChild(cb);
+    });
+}
+//# sourceMappingURL=noSingleElementTupleTypeRule.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"noSingleElementTupleTypeRule.js","sourceRoot":"","sources":["../../../src/rules/noSingleElementTupleTypeRule.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,8BAA8B;IACxC,WAAW,EAAE,uCAAuC;IACpD,kBAAkB,EAAE,mBAAmB;IACvC,OAAO,EAAE,IAAI;IACb,IAAI,EAAE,eAAe;IACrB,cAAc,EAAE,IAAI;CACrB,CAAC;AAOJ,SAAS,IAAI,CAAC,GAA2B;IACvC,MAAM,EAAE,UAAU,EAAE,GAAG,GAAG,CAAC;IAC3B,UAAU,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC,IAAI;;QACtC,IAAI,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,MAAA,IAAI,CAAC,QAAQ,mCAAK,IAAY,CAAC,YAAY,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;YAC1F,GAAG,CAAC,gBAAgB,CAClB,IAAI,EACJ,cAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,kEAAkE,CAAC,CACpG,CAAC;SACH;QACD,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;AACL,CAAC"}

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

@@ -0,0 +1,8 @@
+import * as Lint from "tslint";
+import * as ts from "typescript";
+export declare class Rule extends Lint.Rules.TypedRule {
+    static metadata: Lint.IRuleMetadata;
+    static FAILURE_STRING(typeParameter: string): string;
+    static FAILURE_STRING_NEVER(typeParameter: string): string;
+    applyWithProgram(sourceFile: ts.SourceFile, program: ts.Program): Lint.RuleFailure[];
+}