Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

• Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
• Code is considered more complex for each "break in the linear flow of the code"
• Code is considered more complex when "flow breaking structures are nested"

Further reading

• Cognitive Complexity docs
• Cognitive Complexity: A new way of measuring understandability

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: no-shadowed-variable

Disallows shadowing variable declarations.

Rationale

When a variable in a local scope and a variable in the containing scope have the same name, shadowing occurs. Shadowing makes it impossible to access the variable in the containing scope and obscures to what value an identifier actually refers. Compare the following snippets:

const a = 'no shadow';
function print() {
    console.log(a);
}
print(); // logs 'no shadow'.

const a = 'no shadow';
function print() {
    const a = 'shadow'; // TSLint will complain here.
    console.log(a);
}
print(); // logs 'shadow'.

ESLint has an equivalent rule. For more background information, refer to this MDN closure doc.

Config

You can optionally pass an object to disable checking for certain kinds of declarations. Possible keys are "class", "enum", "function", "import", "interface", "namespace", "typeAlias" and "typeParameter". You can also pass "underscore" to ignore variable names that begin with _. Just set the value to false for the check you want to disable. All checks default to true, i.e. are enabled by default. Note that you cannot disable variables and parameters.

The option "temporalDeadZone" defaults to true which shows errors when shadowing block scoped declarations in their temporal dead zone. When set to false parameters, classes, enums and variables declared with let or const are not considered shadowed if the shadowing occurs within their temporal dead zone.

The following example shows how the "temporalDeadZone" option changes the linting result:

function fn(value) {
    if (value) {
        const tmp = value; // no error on this line if "temporalDeadZone" is false
        return tmp;
    }
    let tmp = undefined;
    if (!value) {
        const tmp = value; // this line always contains an error
        return tmp;
    }
}

Examples

"no-shadowed-variable": true

"no-shadowed-variable": true,[object Object]

Schema

{
  "type": "object",
  "properties": {
    "class": {
      "type": "boolean"
    },
    "enum": {
      "type": "boolean"
    },
    "function": {
      "type": "boolean"
    },
    "import": {
      "type": "boolean"
    },
    "interface": {
      "type": "boolean"
    },
    "namespace": {
      "type": "boolean"
    },
    "typeAlias": {
      "type": "boolean"
    },
    "typeParameter": {
      "type": "boolean"
    },
    "temporalDeadZone": {
      "type": "boolean"
    },
    "underscore": {
      "type": "boolean"
    }
  }
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: no-unused-expression

Disallows unused expression statements.

Unused expressions are expression statements which are not assignments or function calls (and thus usually no-ops).

Rationale

Detects potential errors where an assignment or function call was intended.

Config

Three arguments may be optionally provided:

• allow-fast-null-checks allows to use logical operators to perform fast null checks and perform method or function calls for side effects (e.g. e && e.preventDefault()).
• allow-new allows 'new' expressions for side effects (e.g. new ModifyGlobalState();.
• allow-tagged-template allows tagged templates for side effects (e.g. this.add\foo`;`.

Examples

"no-unused-expression": true

"no-unused-expression": true,allow-fast-null-checks

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "allow-fast-null-checks",
      "allow-new",
      "allow-tagged-template"
    ]
  },
  "minLength": 0,
  "maxLength": 3
}

For more information see this page.

Rule: no-unused-expression

Disallows unused expression statements.

Unused expressions are expression statements which are not assignments or function calls (and thus usually no-ops).

Rationale

Detects potential errors where an assignment or function call was intended.

Config

Three arguments may be optionally provided:

• allow-fast-null-checks allows to use logical operators to perform fast null checks and perform method or function calls for side effects (e.g. e && e.preventDefault()).
• allow-new allows 'new' expressions for side effects (e.g. new ModifyGlobalState();.
• allow-tagged-template allows tagged templates for side effects (e.g. this.add\foo`;`.

Examples

"no-unused-expression": true

"no-unused-expression": true,allow-fast-null-checks

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "allow-fast-null-checks",
      "allow-new",
      "allow-tagged-template"
    ]
  },
  "minLength": 0,
  "maxLength": 3
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: no-unused-expression

Disallows unused expression statements.

Unused expressions are expression statements which are not assignments or function calls (and thus usually no-ops).

Rationale

Detects potential errors where an assignment or function call was intended.

Config

Three arguments may be optionally provided:

• allow-fast-null-checks allows to use logical operators to perform fast null checks and perform method or function calls for side effects (e.g. e && e.preventDefault()).
• allow-new allows 'new' expressions for side effects (e.g. new ModifyGlobalState();.
• allow-tagged-template allows tagged templates for side effects (e.g. this.add\foo`;`.

Examples

"no-unused-expression": true

"no-unused-expression": true,allow-fast-null-checks

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "allow-fast-null-checks",
      "allow-new",
      "allow-tagged-template"
    ]
  },
  "minLength": 0,
  "maxLength": 3
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: only-arrow-functions

Disallows traditional (non-arrow) function expressions.

Note that non-arrow functions are allowed if 'this' appears somewhere in its body (as such functions cannot be converted to arrow functions).

Rationale

Traditional functions don't bind lexical scope, which can lead to unexpected behavior when accessing 'this'.

Config

Two arguments may be optionally provided:

• "allow-declarations" allows standalone function declarations.
• "allow-named-functions" allows the expression function foo() {} but not function() {}.

Examples

"only-arrow-functions": true

"only-arrow-functions": true,allow-declarations,allow-named-functions

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "allow-declarations",
      "allow-named-functions"
    ]
  },
  "minLength": 0,
  "maxLength": 1
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: comment-format

Enforces formatting rules for single-line comments.

Rationale

Helps maintain a consistent, readable style in your codebase.

Notes

• Has Fix

Config

Four arguments may be optionally provided:

• "check-space" requires that all single-line comments must begin with a space, as in // comment
  • note that for comments starting with multiple slashes, e.g. ///, leading slashes are ignored
  • TypeScript reference comments are ignored completely
• "check-lowercase" requires that the first non-whitespace character of a comment must be lowercase, if applicable.
• "check-uppercase" requires that the first non-whitespace character of a comment must be uppercase, if applicable.
• "allow-trailing-lowercase" allows that only the first comment of a series of comments needs to be uppercase.
  • requires "check-uppercase"
  • comments must start at the same position

Exceptions to "check-lowercase" or "check-uppercase" can be managed with object that may be passed as last argument.

One of two options can be provided in this object:

• "ignore-words" - array of strings - words that will be ignored at the beginning of the comment.
• "ignore-pattern" - string - RegExp pattern that will be ignored at the beginning of the comment.

Examples

"comment-format": true,check-space,check-uppercase,allow-trailing-lowercase

"comment-format": true,check-lowercase,[object Object]

"comment-format": true,check-lowercase,[object Object]

Schema

{
  "type": "array",
  "items": {
    "anyOf": [
      {
        "type": "string",
        "enum": [
          "check-space",
          "check-lowercase",
          "check-uppercase",
          "allow-trailing-lowercase"
        ]
      },
      {
        "type": "object",
        "properties": {
          "ignore-words": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "ignore-pattern": {
            "type": "string"
          }
        },
        "minProperties": 1,
        "maxProperties": 1
      }
    ]
  },
  "minLength": 1,
  "maxLength": 5
}

For more information see this page.

Rule: no-unused-expression

Disallows unused expression statements.

Unused expressions are expression statements which are not assignments or function calls (and thus usually no-ops).

Rationale

Detects potential errors where an assignment or function call was intended.

Config

Three arguments may be optionally provided:

• allow-fast-null-checks allows to use logical operators to perform fast null checks and perform method or function calls for side effects (e.g. e && e.preventDefault()).
• allow-new allows 'new' expressions for side effects (e.g. new ModifyGlobalState();.
• allow-tagged-template allows tagged templates for side effects (e.g. this.add\foo`;`.

Examples

"no-unused-expression": true

"no-unused-expression": true,allow-fast-null-checks

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "allow-fast-null-checks",
      "allow-new",
      "allow-tagged-template"
    ]
  },
  "minLength": 0,
  "maxLength": 3
}

For more information see this page.

Rule: no-unused-expression

Disallows unused expression statements.

Unused expressions are expression statements which are not assignments or function calls (and thus usually no-ops).

Rationale

Detects potential errors where an assignment or function call was intended.

Config

Three arguments may be optionally provided:

• allow-fast-null-checks allows to use logical operators to perform fast null checks and perform method or function calls for side effects (e.g. e && e.preventDefault()).
• allow-new allows 'new' expressions for side effects (e.g. new ModifyGlobalState();.
• allow-tagged-template allows tagged templates for side effects (e.g. this.add\foo`;`.

Examples

"no-unused-expression": true

"no-unused-expression": true,allow-fast-null-checks

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "allow-fast-null-checks",
      "allow-new",
      "allow-tagged-template"
    ]
  },
  "minLength": 0,
  "maxLength": 3
}

For more information see this page.

Rule: ban-comma-operator

Disallows the comma operator to be used.

Read more about the comma operator here.

Rationale

Using the comma operator can create a potential for many non-obvious bugs or lead to misunderstanding of code.

Examples

foo((bar, baz)); // evaluates to 'foo(baz)' because of the extra parens - confusing and not obvious

switch (foo) {
    case 1, 2: // equals 'case 2' - probably intended 'case 1: case2:'
        return true;
    case 3:
        return false;
}

let x = (y = 1, z = 2); // x is equal to 2 - this may not be immediately obvious.

Examples

"ban-comma-operator": true

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: semicolon

Enforces consistent semicolon usage at the end of every statement.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• "always" enforces semicolons at the end of every statement.
• "never" disallows semicolons at the end of every statement except for when they are necessary.

The following arguments may be optionally provided:

• "ignore-interfaces" skips checking semicolons at the end of interface members.
• "ignore-bound-class-methods" skips checking semicolons at the end of bound class methods.
• "strict-bound-class-methods" disables any special handling of bound class methods and treats them as any other assignment. This option overrides "ignore-bound-class-methods".

Examples

"semicolon": true,always

"semicolon": true,never

"semicolon": true,always,ignore-interfaces

"semicolon": true,always,ignore-bound-class-methods

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "always",
        "never"
      ]
    },
    {
      "type": "string",
      "enum": [
        "ignore-interfaces"
      ]
    }
  ],
  "additionalItems": false
}

For more information see this page.

Rule: semicolon

Enforces consistent semicolon usage at the end of every statement.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• "always" enforces semicolons at the end of every statement.
• "never" disallows semicolons at the end of every statement except for when they are necessary.

The following arguments may be optionally provided:

• "ignore-interfaces" skips checking semicolons at the end of interface members.
• "ignore-bound-class-methods" skips checking semicolons at the end of bound class methods.
• "strict-bound-class-methods" disables any special handling of bound class methods and treats them as any other assignment. This option overrides "ignore-bound-class-methods".

Examples

"semicolon": true,always

"semicolon": true,never

"semicolon": true,always,ignore-interfaces

"semicolon": true,always,ignore-bound-class-methods

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "always",
        "never"
      ]
    },
    {
      "type": "string",
      "enum": [
        "ignore-interfaces"
      ]
    }
  ],
  "additionalItems": false
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: semicolon

Enforces consistent semicolon usage at the end of every statement.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• "always" enforces semicolons at the end of every statement.
• "never" disallows semicolons at the end of every statement except for when they are necessary.

The following arguments may be optionally provided:

• "ignore-interfaces" skips checking semicolons at the end of interface members.
• "ignore-bound-class-methods" skips checking semicolons at the end of bound class methods.
• "strict-bound-class-methods" disables any special handling of bound class methods and treats them as any other assignment. This option overrides "ignore-bound-class-methods".

Examples

"semicolon": true,always

"semicolon": true,never

"semicolon": true,always,ignore-interfaces

"semicolon": true,always,ignore-bound-class-methods

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "always",
        "never"
      ]
    },
    {
      "type": "string",
      "enum": [
        "ignore-interfaces"
      ]
    }
  ],
  "additionalItems": false
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.

Notes

• Has Fix

Config

One of the following arguments must be provided:

• spaces enforces consistent spaces.
• tabs enforces consistent tabs.

A second optional argument specifies indentation size:

• 2 enforces 2 space indentation.
• 4 enforces 4 space indentation.

Indentation size is required for auto-fixing, but not for rule checking.

NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

{
  "type": "array",
  "items": [
    {
      "type": "string",
      "enum": [
        "tabs",
        "spaces"
      ]
    },
    {
      "type": "number",
      "enum": [
        2,
        4
      ]
    }
  ],
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.