tslint.json

/**
  * These rule settings are a broad, general recommendation for a good default
  * configuration, but should be tuned for personal or team preferences if needed.
  */

{
  "rules": {
    /**
      * Security Rules. The following rules should be turned on because they find security issues
      * or are recommended in the Microsoft Secure Development Lifecycle (SDL)
      */
    "no-banned-terms": true,
    "no-delete-expression": true,
    "no-disable-auto-sanitization": true,
    "no-duplicate-key": true,
    "no-eval": true,
    "no-exec-script": true,
    "no-function-constructor-with-string-args": true,
    "no-http-string": [false],
    "no-octal-literal": true,
    "no-reserved-keywords": true,
    "no-string-based-set-immediate": true,
    "no-string-based-set-interval": true,
    "no-string-based-set-timeout": true,
    "use-strict": [true, "check-module"],

    /**
      * Common Bugs and Correctness. The following rules should be turned on because they find
      * common bug patterns in the code or enforce type safety.
      */
    "forin": true,
    "label-position": true,
    "label-undefined": true,
    "no-any": false,
    "no-arg": false,
    "no-bitwise": true,
    "no-conditional-assignment": true,
    "no-console": [false, "debug", "info", "log", "time", "timeEnd", "trace"],
    "no-constant-condition": true,
    "no-control-regex": true,
    "no-debugger": true,
    "no-duplicate-case": true,
    "no-duplicate-variable": true,
    "no-empty": true,
    "no-increment-decrement": false,
    "no-invalid-regexp": true,
    "no-invalid-this": true,
    "no-regex-spaces": true,
    "no-sparse-arrays": true,
    "no-stateless-class": true,
    "no-string-literal": true,
    "no-unnecessary-bind": true,
    "no-unnecessary-override": true,
    "no-unsafe-finally": true,
    "no-unused-expression": true,
    "no-unused-new": true,
    "no-unused-variable": true,
    "no-use-before-declare": true,
    "no-with-statement": true,
    "promise-must-complete": true,
    "radix": true,
    "switch-default": true,
    "triple-equals": [true, "allow-null-check"],
    "use-isnan": true,
    "use-named-parameter": true,
    "valid-typeof": true,

    /**
      * Code Clarity. The following rules should be turned on because they make the code
      * generally more clear to the reader.
      */
    "arrow-parens": false, // for simple functions the parens on arrow functions are not needed
    "class-name": true,
    "comment-format": [true, "check-space", "check-uppercase"],
    "export-name": false,
    "function-name": true,
    "import-name": false,
    "interface-name": [true, "always-prefix"],
    "jsdoc-format": true,
    "max-file-line-count": true,
    "max-func-body-length": [true, 100, {"ignore-parameters-to-function-regex": "describe"}],
    "max-line-length": [true, 140],
    "member-access": true,
    "member-ordering": [true, { "order": "fields-first" }],
    "missing-jsdoc": false,
    "new-parens": true,
    "no-construct": true,
    "no-constructor-vars": true,
    "no-default-export": true,
    "no-empty-interfaces": true,
    "no-for-in": true,
    "no-function-expression": false,
    "no-inferrable-types": false, // turn no-inferrable-types off in order to make the code consistent in its use of type decorations
    "no-multiline-string": false, // multiline-strings often introduce unnecessary whitespace into the string literals
    "no-null-keyword": false, // turn no-null-keyword off and use undefined to mean not initialized and null to mean without a value
    "no-relative-imports": false,
    "no-require-imports": true,
    "no-shadowed-variable": true,
    "no-suspicious-comment": true,
    "no-typeof-undefined": true,
    "no-unnecessary-field-initialization": true,
    "no-unnecessary-local-variable": true,
    "no-var-keyword": true,
    "no-var-requires": true,
    "no-var-self": true,
    "object-literal-sort-keys": false, // turn object-literal-sort-keys off and sort keys in a meaningful manner
    "one-variable-per-declaration": true,
    "only-arrow-functions": false,  // there are many valid reasons to declare a function
    "ordered-imports": true,
    "prefer-array-literal": true,
    "prefer-const": false,
    "typedef": [true, "call-signature", "parameter", "property-declaration", "variable-declaration", "member-variable-declaration"],
    "underscore-consistent-invocation": true,
    "variable-name": true,

    /**
      * Whitespace related rules. The only recommended whitespace strategy is to pick a single format and
      * be consistent.
      */
    "align": [true, "parameters", "arguments", "statements"],
    "curly": true,
    "eofline": true,
    "indent": [true, "spaces"],
    "linebreak-style": true,
    "no-consecutive-blank-lines": true,
    "no-empty-line-after-opening-brace": false,
    "no-single-line-block-comment": true,
    "no-trailing-whitespace": true,
    "no-unnecessary-semicolons": true,
    "object-literal-key-quotes": [true, "as-needed"],
    "one-line": [true, "check-open-brace", "check-catch", "check-else", "check-whitespace"],
    "quotemark": [true, "single"],
    "semicolon": [true, "always"],
    "trailing-comma": [false], // forcing trailing commas for multi-line
                // lists results in lists that are easier to reorder and version control diffs that are more clear.
                // Many teams like to have multiline be 'always'. There is no clear consensus on this rule but the
    "typedef-whitespace": [true, { // forces a space before the colon in a type specifier
      "call-signature": "nospace",
      "index-signature": "nospace",
      "parameter": "nospace",
      "property-declaration": "nospace",
      "variable-declaration": "nospace"
    }],
    "whitespace": [true, "check-branch", "check-decl", "check-operator", "check-separator", "check-type"],

    /**
      * Controversial/Configurable rules.
      */
    "ban": false,                // only enable this if you have some code pattern that you want to ban
    "no-angle-bracket-type-assertion": false,  // pick either type-cast format and use it consistently
    "no-internal-module": false, // only enable this if you are not using internal modules
    "no-mergeable-namespace": false,  // your project may require mergeable namespaces
    "no-namespace": false,       // only enable this if you are not using modules/namespaces
    "no-reference": true,        // in general you should use a module system and not /// reference imports
    "no-unexternalized-strings": false, // the VS Code team has a specific localization process that this rule enforces
    "prefer-type-cast": true,   // pick either type-cast format and use it consistently

    /**
      * Deprecated rules. The following rules are deprecated for various reasons.
      */
    "missing-optional-annotation": false,  // now supported by TypeScript compiler
    "no-duplicate-parameter-names": false, // now supported by TypeScript compiler
    "no-missing-visibility-modifiers": false, // use tslint member-access rule instead
    "no-multiple-var-decl": false,         // use tslint one-variable-per-declaration rule instead
    "no-switch-case-fall-through": false,  // now supported by TypeScript compiler
    "no-unreachable": false,               // now supported by TypeScript compiler
    "no-unused-imports": false             // use tslint no-unused-variable rule instead
  },
  "rulesDirectory": [
    "node_modules/tslint-microsoft-contrib"
  ]
}