tslint.json

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
{
    "extends": [
        "tslint:recommended",
        "tslint-eslint-rules"
    ],
    "rules": {
        "arrow-return-shorthand": true,
        "callable-types": true,
        "class-name": true,
        "comment-format": [
            true,
            "check-space"
        ],
        "curly": true,
        "deprecation": {
            "severity": "warn"
        },
        "eofline": true,
        // Custom - Check file header.
        "file-header": [
            true,
            "Copyright \\(c\\) Microsoft Corporation"
        ],
        "forin": true,
        "import-blacklist": [
            true,
            "rxjs/Rx"
        ],
        "import-spacing": true,
        "indent": [
            true,
            "spaces"
        ],
        "interface-over-type-literal": true,
        "label-position": true,
        "max-line-length": [
            true,
            200
        ],
        "member-access": false,
        "member-ordering": [
            true,
            {
                "order": [
                    "static-field",
                    "instance-field",
                    "static-method",
                    "instance-method"
                ]
            }
        ],
        "no-arg": true,
        "no-bitwise": true,
        // Custom - Disallow any type of assignment in conditionals.
        "no-conditional-assignment": true,
        // Custom - Disallow one or more blank lines in a row.
        "no-consecutive-blank-lines": true,
        "no-console": [
            true,
            "debug",
            "info",
            // Custom - Do not use console.log(...) method.
            "log",
            "time",
            "timeEnd",
            "trace"
        ],
        "no-construct": true,
        "no-debugger": true,
        "no-duplicate-super": true,
        // Custom - Disallow duplicate variable declarations in the same block scope.
        "no-duplicate-variable": true,
        "no-empty": false,
        "no-empty-interface": true,
        "no-eval": true,
        // Custom - Disallow iterating over an array with a for-in loop.
        "no-for-in-array": true,
        // Custom - Disable "no-implicit-dependencies" rule (otherwise, importing from e.g., "@esinsights/core" will be flagged).
        "no-implicit-dependencies": false,
        "no-inferrable-types": [
            true,
            "ignore-params"
        ],
        // Custom - Disallow irregular whitespace within a file, including strings and comments.
        "no-irregular-whitespace": true,
        "no-misused-new": true,
        "no-non-null-assertion": true,
        "no-redundant-jsdoc": true,
        "no-shadowed-variable": true,
        "no-string-literal": false,
        "no-string-throw": true,
        // Custom - Disable submodules for "no-submodule-imports" rule (otherwise, importing from e.g., "@esinsights/core/diagnostics" will be flagged).
        "no-submodule-imports": false,
        "no-switch-case-fall-through": true,
        "no-trailing-whitespace": true,
        "no-unnecessary-initializer": true,
        "no-unused-expression": true,
        // Custom - Disallow unused imports, variables, functions and private class members.
        "no-unused-variable": true,
        "no-use-before-declare": true,
        "no-var-keyword": true,
        // Custom - Enforce consistent object literal property quote style.
        "object-literal-key-quotes": [
            true,
            "consistent-as-needed"
        ],
        "object-literal-sort-keys": false,
        "one-line": [
            true,
            "check-open-brace",
            "check-catch",
            "check-else",
            "check-whitespace"
        ],
        // Custom - Disallow multiple variable definitions in the same declaration statement.
        "one-variable-per-declaration": [
            true,
            "ignore-for-loop"
        ],
        "prefer-const": true,
        "quotemark": [
            true,
            "single",
            // Custom - Allow to use the other quotemark in case escaping is required.
            "avoid-escape"
        ],
        "radix": true,
        "semicolon": [
            true,
            "always"
        ],
        // Custom - Custom trailing-comma rule.
        "trailing-comma": [
            true,
            {
                "multiline": {
                    "arrays": "always",
                    "exports": "never",
                    "functions": "never",
                    "imports": "never",
                    "objects": "always",
                    "typeLiterals": "always"
                },
                "singleline": "never"
            }
        ],
        "triple-equals": [
            true,
            "allow-null-check"
        ],
        "typedef-whitespace": [
            true,
            {
                "call-signature": "nospace",
                "index-signature": "nospace",
                "parameter": "nospace",
                "property-declaration": "nospace",
                "variable-declaration": "nospace"
            }
        ],
        "unified-signatures": true,
        // Custom - Enforce use of the isNan() function to check for NaN references.
        "use-isnan": true,
        // Custom (Override) - Check variable names for various errors.
        "variable-name": [
            true,
            "ban-keywords",
            "check-format"
        ],
        "whitespace": [
            true,
            "check-branch",
            "check-decl",
            "check-operator",
            "check-separator",
            "check-type"
        ]
    }
}