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: 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: whitespace

Enforces whitespace style conventions.

Rationale

Helps maintain a readable, consistent style in your codebase.

Notes

• Has Fix

Config

Several arguments may be optionally provided:

• "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
• "check-decl"checks that variable declarations have whitespace around the equals token.
• "check-operator" checks for whitespace around operator tokens.
• "check-module" checks for whitespace in import & export statements.
• "check-separator" checks for whitespace after separator tokens (,/;).
• "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
• "check-type" checks for whitespace before a variable type specification.
• "check-typecast" checks for whitespace between a typecast and its target.
• "check-type-operator" checks for whitespace between type operators | and &.
• "check-preblock" checks for whitespace before the opening brace of a block.
• "check-postbrace" checks for whitespace after an opening brace.

Examples

"whitespace": true,check-branch,check-operator,check-typecast

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

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: whitespace

Enforces whitespace style conventions.

Rationale

Helps maintain a readable, consistent style in your codebase.

Notes

• Has Fix

Config

Several arguments may be optionally provided:

• "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
• "check-decl"checks that variable declarations have whitespace around the equals token.
• "check-operator" checks for whitespace around operator tokens.
• "check-module" checks for whitespace in import & export statements.
• "check-separator" checks for whitespace after separator tokens (,/;).
• "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
• "check-type" checks for whitespace before a variable type specification.
• "check-typecast" checks for whitespace between a typecast and its target.
• "check-type-operator" checks for whitespace between type operators | and &.
• "check-preblock" checks for whitespace before the opening brace of a block.
• "check-postbrace" checks for whitespace after an opening brace.

Examples

"whitespace": true,check-branch,check-operator,check-typecast

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

For more information see this page.

Rule: whitespace

Enforces whitespace style conventions.

Rationale

Helps maintain a readable, consistent style in your codebase.

Notes

• Has Fix

Config

Several arguments may be optionally provided:

• "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
• "check-decl"checks that variable declarations have whitespace around the equals token.
• "check-operator" checks for whitespace around operator tokens.
• "check-module" checks for whitespace in import & export statements.
• "check-separator" checks for whitespace after separator tokens (,/;).
• "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
• "check-type" checks for whitespace before a variable type specification.
• "check-typecast" checks for whitespace between a typecast and its target.
• "check-type-operator" checks for whitespace between type operators | and &.
• "check-preblock" checks for whitespace before the opening brace of a block.
• "check-postbrace" checks for whitespace after an opening brace.

Examples

"whitespace": true,check-branch,check-operator,check-typecast

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

For more information see this page.

Rule: whitespace

Enforces whitespace style conventions.

Rationale

Helps maintain a readable, consistent style in your codebase.

Notes

• Has Fix

Config

Several arguments may be optionally provided:

• "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
• "check-decl"checks that variable declarations have whitespace around the equals token.
• "check-operator" checks for whitespace around operator tokens.
• "check-module" checks for whitespace in import & export statements.
• "check-separator" checks for whitespace after separator tokens (,/;).
• "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
• "check-type" checks for whitespace before a variable type specification.
• "check-typecast" checks for whitespace between a typecast and its target.
• "check-type-operator" checks for whitespace between type operators | and &.
• "check-preblock" checks for whitespace before the opening brace of a block.
• "check-postbrace" checks for whitespace after an opening brace.

Examples

"whitespace": true,check-branch,check-operator,check-typecast

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

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-var-keyword

Disallows usage of the var keyword.

Use let or const instead.

Rationale

Declaring variables using var has several edge case behaviors that make var unsuitable for modern code. Variables declared by var have their parent function block as their scope, ignoring other control flow statements. vars have declaration "hoisting" (similar to functions) and can appear to be used before declaration.

Variables declared by const and let instead have as their scope the block in which they are defined, and are not allowed to used before declaration or be re-declared with another const or let.

Notes

• Has Fix

Config

Not configurable.

Examples

"no-var-keyword": true

For more information see this page.

Rule: no-var-keyword

Disallows usage of the var keyword.

Use let or const instead.

Rationale

Declaring variables using var has several edge case behaviors that make var unsuitable for modern code. Variables declared by var have their parent function block as their scope, ignoring other control flow statements. vars have declaration "hoisting" (similar to functions) and can appear to be used before declaration.

Variables declared by const and let instead have as their scope the block in which they are defined, and are not allowed to used before declaration or be re-declared with another const or let.

Notes

• Has Fix

Config

Not configurable.

Examples

"no-var-keyword": true

For more information see this page.

Rule: space-within-parens

Enforces spaces within parentheses or disallow them. Empty parentheses () are always allowed.

Notes

• Has Fix

Config

You may enforce the amount of whitespace within parentheses.

Schema

{
  "type": "number",
  "min": 0
}

For more information see this page.

Rule: whitespace

Enforces whitespace style conventions.

Rationale

Helps maintain a readable, consistent style in your codebase.

Notes

• Has Fix

Config

Several arguments may be optionally provided:

• "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
• "check-decl"checks that variable declarations have whitespace around the equals token.
• "check-operator" checks for whitespace around operator tokens.
• "check-module" checks for whitespace in import & export statements.
• "check-separator" checks for whitespace after separator tokens (,/;).
• "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
• "check-type" checks for whitespace before a variable type specification.
• "check-typecast" checks for whitespace between a typecast and its target.
• "check-type-operator" checks for whitespace between type operators | and &.
• "check-preblock" checks for whitespace before the opening brace of a block.
• "check-postbrace" checks for whitespace after an opening brace.

Examples

"whitespace": true,check-branch,check-operator,check-typecast

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

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: jsdoc-format

Enforces basic format rules for JSDoc comments.

The following rules are enforced for JSDoc comments (comments starting with /**):

• each line contains an asterisk and asterisks must be aligned
• each asterisk must be followed by either a space or a newline (except for the first and the last)
• the only characters before the asterisk on each line must be whitespace characters
• one line comments must start with /** and end with */
• multiline comments don't allow text after /** in the first line (with option "check-multiline-start")

Rationale

Helps maintain a consistent, readable style for JSDoc comments.

Config

You can optionally specify the option "check-multiline-start" to enforce the first line of a multiline JSDoc comment to be empty.

Examples

"jsdoc-format": true

"jsdoc-format": true,check-multiline-start

Schema

{
  "type": "array",
  "minItems": 0,
  "maxItems": 1,
  "items": {
    "type": "string",
    "enum": [
      "check-multiline-start"
    ]
  }
}

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: jsdoc-format

Enforces basic format rules for JSDoc comments.

The following rules are enforced for JSDoc comments (comments starting with /**):

• each line contains an asterisk and asterisks must be aligned
• each asterisk must be followed by either a space or a newline (except for the first and the last)
• the only characters before the asterisk on each line must be whitespace characters
• one line comments must start with /** and end with */
• multiline comments don't allow text after /** in the first line (with option "check-multiline-start")

Rationale

Helps maintain a consistent, readable style for JSDoc comments.

Config

You can optionally specify the option "check-multiline-start" to enforce the first line of a multiline JSDoc comment to be empty.

Examples

"jsdoc-format": true

"jsdoc-format": true,check-multiline-start

Schema

{
  "type": "array",
  "minItems": 0,
  "maxItems": 1,
  "items": {
    "type": "string",
    "enum": [
      "check-multiline-start"
    ]
  }
}

For more information see this page.

Rule: prefer-for-of

Recommends a 'for-of' loop over a standard 'for' loop if the index is only used to access the array being iterated.

Rationale

A for(... of ...) loop is easier to implement and read when the index is not needed.

Config

Not configurable.

Examples

"prefer-for-of": true

For more information see this page.

Rule: whitespace

Enforces whitespace style conventions.

Rationale

Helps maintain a readable, consistent style in your codebase.

Notes

• Has Fix

Config

Several arguments may be optionally provided:

• "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
• "check-decl"checks that variable declarations have whitespace around the equals token.
• "check-operator" checks for whitespace around operator tokens.
• "check-module" checks for whitespace in import & export statements.
• "check-separator" checks for whitespace after separator tokens (,/;).
• "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
• "check-type" checks for whitespace before a variable type specification.
• "check-typecast" checks for whitespace between a typecast and its target.
• "check-type-operator" checks for whitespace between type operators | and &.
• "check-preblock" checks for whitespace before the opening brace of a block.
• "check-postbrace" checks for whitespace after an opening brace.

Examples

"whitespace": true,check-branch,check-operator,check-typecast

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

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: whitespace

Enforces whitespace style conventions.

Rationale

Helps maintain a readable, consistent style in your codebase.

Notes

• Has Fix

Config

Several arguments may be optionally provided:

• "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
• "check-decl"checks that variable declarations have whitespace around the equals token.
• "check-operator" checks for whitespace around operator tokens.
• "check-module" checks for whitespace in import & export statements.
• "check-separator" checks for whitespace after separator tokens (,/;).
• "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
• "check-type" checks for whitespace before a variable type specification.
• "check-typecast" checks for whitespace between a typecast and its target.
• "check-type-operator" checks for whitespace between type operators | and &.
• "check-preblock" checks for whitespace before the opening brace of a block.
• "check-postbrace" checks for whitespace after an opening brace.

Examples

"whitespace": true,check-branch,check-operator,check-typecast

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

For more information see this page.

Rule: whitespace

Enforces whitespace style conventions.

Rationale

Helps maintain a readable, consistent style in your codebase.

Notes

• Has Fix

Config

Several arguments may be optionally provided:

• "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
• "check-decl"checks that variable declarations have whitespace around the equals token.
• "check-operator" checks for whitespace around operator tokens.
• "check-module" checks for whitespace in import & export statements.
• "check-separator" checks for whitespace after separator tokens (,/;).
• "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
• "check-type" checks for whitespace before a variable type specification.
• "check-typecast" checks for whitespace between a typecast and its target.
• "check-type-operator" checks for whitespace between type operators | and &.
• "check-preblock" checks for whitespace before the opening brace of a block.
• "check-postbrace" checks for whitespace after an opening brace.

Examples

"whitespace": true,check-branch,check-operator,check-typecast

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

For more information see this page.

Rule: whitespace

Enforces whitespace style conventions.

Rationale

Helps maintain a readable, consistent style in your codebase.

Notes

• Has Fix

Config

Several arguments may be optionally provided:

• "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
• "check-decl"checks that variable declarations have whitespace around the equals token.
• "check-operator" checks for whitespace around operator tokens.
• "check-module" checks for whitespace in import & export statements.
• "check-separator" checks for whitespace after separator tokens (,/;).
• "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
• "check-type" checks for whitespace before a variable type specification.
• "check-typecast" checks for whitespace between a typecast and its target.
• "check-type-operator" checks for whitespace between type operators | and &.
• "check-preblock" checks for whitespace before the opening brace of a block.
• "check-postbrace" checks for whitespace after an opening brace.

Examples

"whitespace": true,check-branch,check-operator,check-typecast

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

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: array-type

Requires using either 'T[]' or 'Array<t>' for arrays.</t>

Notes

• TypeScript Only
• Has Fix

Config

One of the following arguments must be provided:

• "array" enforces use of T[] for all types T.
• "generic" enforces use of Array<T> for all types T.
• "array-simple" enforces use of T[] if T is a simple type (primitive or type reference).

Examples

"array-type": true,array

"array-type": true,generic

"array-type": true,array-simple

Schema

{
  "type": "string",
  "enum": [
    "array",
    "generic",
    "array-simple"
  ]
}

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: whitespace

Enforces whitespace style conventions.

Rationale

Helps maintain a readable, consistent style in your codebase.

Notes

• Has Fix

Config

Several arguments may be optionally provided:

• "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
• "check-decl"checks that variable declarations have whitespace around the equals token.
• "check-operator" checks for whitespace around operator tokens.
• "check-module" checks for whitespace in import & export statements.
• "check-separator" checks for whitespace after separator tokens (,/;).
• "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
• "check-type" checks for whitespace before a variable type specification.
• "check-typecast" checks for whitespace between a typecast and its target.
• "check-type-operator" checks for whitespace between type operators | and &.
• "check-preblock" checks for whitespace before the opening brace of a block.
• "check-postbrace" checks for whitespace after an opening brace.

Examples

"whitespace": true,check-branch,check-operator,check-typecast

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

For more information see this page.

Rule: whitespace

Enforces whitespace style conventions.

Rationale

Helps maintain a readable, consistent style in your codebase.

Notes

• Has Fix

Config

Several arguments may be optionally provided:

• "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
• "check-decl"checks that variable declarations have whitespace around the equals token.
• "check-operator" checks for whitespace around operator tokens.
• "check-module" checks for whitespace in import & export statements.
• "check-separator" checks for whitespace after separator tokens (,/;).
• "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
• "check-type" checks for whitespace before a variable type specification.
• "check-typecast" checks for whitespace between a typecast and its target.
• "check-type-operator" checks for whitespace between type operators | and &.
• "check-preblock" checks for whitespace before the opening brace of a block.
• "check-postbrace" checks for whitespace after an opening brace.

Examples

"whitespace": true,check-branch,check-operator,check-typecast

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

For more information see this page.

Rule: whitespace

Enforces whitespace style conventions.

Rationale

Helps maintain a readable, consistent style in your codebase.

Notes

• Has Fix

Config

Several arguments may be optionally provided:

• "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
• "check-decl"checks that variable declarations have whitespace around the equals token.
• "check-operator" checks for whitespace around operator tokens.
• "check-module" checks for whitespace in import & export statements.
• "check-separator" checks for whitespace after separator tokens (,/;).
• "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
• "check-type" checks for whitespace before a variable type specification.
• "check-typecast" checks for whitespace between a typecast and its target.
• "check-type-operator" checks for whitespace between type operators | and &.
• "check-preblock" checks for whitespace before the opening brace of a block.
• "check-postbrace" checks for whitespace after an opening brace.

Examples

"whitespace": true,check-branch,check-operator,check-typecast

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

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: whitespace

Enforces whitespace style conventions.

Rationale

Helps maintain a readable, consistent style in your codebase.

Notes

• Has Fix

Config

Several arguments may be optionally provided:

• "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
• "check-decl"checks that variable declarations have whitespace around the equals token.
• "check-operator" checks for whitespace around operator tokens.
• "check-module" checks for whitespace in import & export statements.
• "check-separator" checks for whitespace after separator tokens (,/;).
• "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
• "check-type" checks for whitespace before a variable type specification.
• "check-typecast" checks for whitespace between a typecast and its target.
• "check-type-operator" checks for whitespace between type operators | and &.
• "check-preblock" checks for whitespace before the opening brace of a block.
• "check-postbrace" checks for whitespace after an opening brace.

Examples

"whitespace": true,check-branch,check-operator,check-typecast

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

For more information see this page.

Rule: whitespace

Enforces whitespace style conventions.

Rationale

Helps maintain a readable, consistent style in your codebase.

Notes

• Has Fix

Config

Several arguments may be optionally provided:

• "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
• "check-decl"checks that variable declarations have whitespace around the equals token.
• "check-operator" checks for whitespace around operator tokens.
• "check-module" checks for whitespace in import & export statements.
• "check-separator" checks for whitespace after separator tokens (,/;).
• "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
• "check-type" checks for whitespace before a variable type specification.
• "check-typecast" checks for whitespace between a typecast and its target.
• "check-type-operator" checks for whitespace between type operators | and &.
• "check-preblock" checks for whitespace before the opening brace of a block.
• "check-postbrace" checks for whitespace after an opening brace.

Examples

"whitespace": true,check-branch,check-operator,check-typecast

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

For more information see this page.

Rule: whitespace

Enforces whitespace style conventions.

Rationale

Helps maintain a readable, consistent style in your codebase.

Notes

• Has Fix

Config

Several arguments may be optionally provided:

• "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
• "check-decl"checks that variable declarations have whitespace around the equals token.
• "check-operator" checks for whitespace around operator tokens.
• "check-module" checks for whitespace in import & export statements.
• "check-separator" checks for whitespace after separator tokens (,/;).
• "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
• "check-type" checks for whitespace before a variable type specification.
• "check-typecast" checks for whitespace between a typecast and its target.
• "check-type-operator" checks for whitespace between type operators | and &.
• "check-preblock" checks for whitespace before the opening brace of a block.
• "check-postbrace" checks for whitespace after an opening brace.

Examples

"whitespace": true,check-branch,check-operator,check-typecast

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

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: space-within-parens

Enforces spaces within parentheses or disallow them. Empty parentheses () are always allowed.

Notes

• Has Fix

Config

You may enforce the amount of whitespace within parentheses.

Schema

{
  "type": "number",
  "min": 0
}

For more information see this page.

Rule: whitespace

Enforces whitespace style conventions.

Rationale

Helps maintain a readable, consistent style in your codebase.

Notes

• Has Fix

Config

Several arguments may be optionally provided:

• "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
• "check-decl"checks that variable declarations have whitespace around the equals token.
• "check-operator" checks for whitespace around operator tokens.
• "check-module" checks for whitespace in import & export statements.
• "check-separator" checks for whitespace after separator tokens (,/;).
• "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
• "check-type" checks for whitespace before a variable type specification.
• "check-typecast" checks for whitespace between a typecast and its target.
• "check-type-operator" checks for whitespace between type operators | and &.
• "check-preblock" checks for whitespace before the opening brace of a block.
• "check-postbrace" checks for whitespace after an opening brace.

Examples

"whitespace": true,check-branch,check-operator,check-typecast

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

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: jsdoc-format

Enforces basic format rules for JSDoc comments.

The following rules are enforced for JSDoc comments (comments starting with /**):

• each line contains an asterisk and asterisks must be aligned
• each asterisk must be followed by either a space or a newline (except for the first and the last)
• the only characters before the asterisk on each line must be whitespace characters
• one line comments must start with /** and end with */
• multiline comments don't allow text after /** in the first line (with option "check-multiline-start")

Rationale

Helps maintain a consistent, readable style for JSDoc comments.

Config

You can optionally specify the option "check-multiline-start" to enforce the first line of a multiline JSDoc comment to be empty.

Examples

"jsdoc-format": true

"jsdoc-format": true,check-multiline-start

Schema

{
  "type": "array",
  "minItems": 0,
  "maxItems": 1,
  "items": {
    "type": "string",
    "enum": [
      "check-multiline-start"
    ]
  }
}

For more information see this page.

Rule: no-var-keyword

Disallows usage of the var keyword.

Use let or const instead.

Rationale

Declaring variables using var has several edge case behaviors that make var unsuitable for modern code. Variables declared by var have their parent function block as their scope, ignoring other control flow statements. vars have declaration "hoisting" (similar to functions) and can appear to be used before declaration.

Variables declared by const and let instead have as their scope the block in which they are defined, and are not allowed to used before declaration or be re-declared with another const or let.

Notes

• Has Fix

Config

Not configurable.

Examples

"no-var-keyword": true

For more information see this page.

Rule: whitespace

Enforces whitespace style conventions.

Rationale

Helps maintain a readable, consistent style in your codebase.

Notes

• Has Fix

Config

Several arguments may be optionally provided:

• "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
• "check-decl"checks that variable declarations have whitespace around the equals token.
• "check-operator" checks for whitespace around operator tokens.
• "check-module" checks for whitespace in import & export statements.
• "check-separator" checks for whitespace after separator tokens (,/;).
• "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
• "check-type" checks for whitespace before a variable type specification.
• "check-typecast" checks for whitespace between a typecast and its target.
• "check-type-operator" checks for whitespace between type operators | and &.
• "check-preblock" checks for whitespace before the opening brace of a block.
• "check-postbrace" checks for whitespace after an opening brace.

Examples

"whitespace": true,check-branch,check-operator,check-typecast

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

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-var-keyword

Disallows usage of the var keyword.

Use let or const instead.

Rationale

Declaring variables using var has several edge case behaviors that make var unsuitable for modern code. Variables declared by var have their parent function block as their scope, ignoring other control flow statements. vars have declaration "hoisting" (similar to functions) and can appear to be used before declaration.

Variables declared by const and let instead have as their scope the block in which they are defined, and are not allowed to used before declaration or be re-declared with another const or let.

Notes

• Has Fix

Config

Not configurable.

Examples

"no-var-keyword": true

For more information see this page.

Rule: prefer-const

Requires that variable declarations use const instead of let and var if possible.

If a variable is only assigned to once when it is declared, it should be declared using 'const'

Notes

• Has Fix

Config

An optional object containing the property "destructuring" with two possible values:

• "any" (default) - If any variable in destructuring can be const, this rule warns for those variables.
• "all" - Only warns if all variables in destructuring can be const.

Examples

"prefer-const": true

"prefer-const": true,[object Object]

Schema

{
  "type": "object",
  "properties": {
    "destructuring": {
      "type": "string",
      "enum": [
        "all",
        "any"
      ]
    }
  }
}

For more information see this page.

Rule: space-within-parens

Enforces spaces within parentheses or disallow them. Empty parentheses () are always allowed.

Notes

• Has Fix

Config

You may enforce the amount of whitespace within parentheses.

Schema

{
  "type": "number",
  "min": 0
}

For more information see this page.

Rule: whitespace

Enforces whitespace style conventions.

Rationale

Helps maintain a readable, consistent style in your codebase.

Notes

• Has Fix

Config

Several arguments may be optionally provided:

• "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
• "check-decl"checks that variable declarations have whitespace around the equals token.
• "check-operator" checks for whitespace around operator tokens.
• "check-module" checks for whitespace in import & export statements.
• "check-separator" checks for whitespace after separator tokens (,/;).
• "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
• "check-type" checks for whitespace before a variable type specification.
• "check-typecast" checks for whitespace between a typecast and its target.
• "check-type-operator" checks for whitespace between type operators | and &.
• "check-preblock" checks for whitespace before the opening brace of a block.
• "check-postbrace" checks for whitespace after an opening brace.

Examples

"whitespace": true,check-branch,check-operator,check-typecast

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

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: whitespace

Enforces whitespace style conventions.

Rationale

Helps maintain a readable, consistent style in your codebase.

Notes

• Has Fix

Config

Several arguments may be optionally provided:

• "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
• "check-decl"checks that variable declarations have whitespace around the equals token.
• "check-operator" checks for whitespace around operator tokens.
• "check-module" checks for whitespace in import & export statements.
• "check-separator" checks for whitespace after separator tokens (,/;).
• "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
• "check-type" checks for whitespace before a variable type specification.
• "check-typecast" checks for whitespace between a typecast and its target.
• "check-type-operator" checks for whitespace between type operators | and &.
• "check-preblock" checks for whitespace before the opening brace of a block.
• "check-postbrace" checks for whitespace after an opening brace.

Examples

"whitespace": true,check-branch,check-operator,check-typecast

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

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: whitespace

Enforces whitespace style conventions.

Rationale

Helps maintain a readable, consistent style in your codebase.

Notes

• Has Fix

Config

Several arguments may be optionally provided:

• "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
• "check-decl"checks that variable declarations have whitespace around the equals token.
• "check-operator" checks for whitespace around operator tokens.
• "check-module" checks for whitespace in import & export statements.
• "check-separator" checks for whitespace after separator tokens (,/;).
• "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
• "check-type" checks for whitespace before a variable type specification.
• "check-typecast" checks for whitespace between a typecast and its target.
• "check-type-operator" checks for whitespace between type operators | and &.
• "check-preblock" checks for whitespace before the opening brace of a block.
• "check-postbrace" checks for whitespace after an opening brace.

Examples

"whitespace": true,check-branch,check-operator,check-typecast

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

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: jsdoc-format

Enforces basic format rules for JSDoc comments.

The following rules are enforced for JSDoc comments (comments starting with /**):

• each line contains an asterisk and asterisks must be aligned
• each asterisk must be followed by either a space or a newline (except for the first and the last)
• the only characters before the asterisk on each line must be whitespace characters
• one line comments must start with /** and end with */
• multiline comments don't allow text after /** in the first line (with option "check-multiline-start")

Rationale

Helps maintain a consistent, readable style for JSDoc comments.

Config

You can optionally specify the option "check-multiline-start" to enforce the first line of a multiline JSDoc comment to be empty.

Examples

"jsdoc-format": true

"jsdoc-format": true,check-multiline-start

Schema

{
  "type": "array",
  "minItems": 0,
  "maxItems": 1,
  "items": {
    "type": "string",
    "enum": [
      "check-multiline-start"
    ]
  }
}

For more information see this page.

Rule: space-within-parens

Enforces spaces within parentheses or disallow them. Empty parentheses () are always allowed.

Notes

• Has Fix

Config

You may enforce the amount of whitespace within parentheses.

Schema

{
  "type": "number",
  "min": 0
}

For more information see this page.

Rule: whitespace

Enforces whitespace style conventions.

Rationale

Helps maintain a readable, consistent style in your codebase.

Notes

• Has Fix

Config

Several arguments may be optionally provided:

• "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
• "check-decl"checks that variable declarations have whitespace around the equals token.
• "check-operator" checks for whitespace around operator tokens.
• "check-module" checks for whitespace in import & export statements.
• "check-separator" checks for whitespace after separator tokens (,/;).
• "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
• "check-type" checks for whitespace before a variable type specification.
• "check-typecast" checks for whitespace between a typecast and its target.
• "check-type-operator" checks for whitespace between type operators | and &.
• "check-preblock" checks for whitespace before the opening brace of a block.
• "check-postbrace" checks for whitespace after an opening brace.

Examples

"whitespace": true,check-branch,check-operator,check-typecast

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

For more information see this page.

Rule: whitespace

Enforces whitespace style conventions.

Rationale

Helps maintain a readable, consistent style in your codebase.

Notes

• Has Fix

Config

Several arguments may be optionally provided:

• "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
• "check-decl"checks that variable declarations have whitespace around the equals token.
• "check-operator" checks for whitespace around operator tokens.
• "check-module" checks for whitespace in import & export statements.
• "check-separator" checks for whitespace after separator tokens (,/;).
• "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
• "check-type" checks for whitespace before a variable type specification.
• "check-typecast" checks for whitespace between a typecast and its target.
• "check-type-operator" checks for whitespace between type operators | and &.
• "check-preblock" checks for whitespace before the opening brace of a block.
• "check-postbrace" checks for whitespace after an opening brace.

Examples

"whitespace": true,check-branch,check-operator,check-typecast

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

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: jsdoc-format

Enforces basic format rules for JSDoc comments.

The following rules are enforced for JSDoc comments (comments starting with /**):

• each line contains an asterisk and asterisks must be aligned
• each asterisk must be followed by either a space or a newline (except for the first and the last)
• the only characters before the asterisk on each line must be whitespace characters
• one line comments must start with /** and end with */
• multiline comments don't allow text after /** in the first line (with option "check-multiline-start")

Rationale

Helps maintain a consistent, readable style for JSDoc comments.

Config

You can optionally specify the option "check-multiline-start" to enforce the first line of a multiline JSDoc comment to be empty.

Examples

"jsdoc-format": true

"jsdoc-format": true,check-multiline-start

Schema

{
  "type": "array",
  "minItems": 0,
  "maxItems": 1,
  "items": {
    "type": "string",
    "enum": [
      "check-multiline-start"
    ]
  }
}

For more information see this page.

Rule: prefer-const

Requires that variable declarations use const instead of let and var if possible.

If a variable is only assigned to once when it is declared, it should be declared using 'const'

Notes

• Has Fix

Config

An optional object containing the property "destructuring" with two possible values:

• "any" (default) - If any variable in destructuring can be const, this rule warns for those variables.
• "all" - Only warns if all variables in destructuring can be const.

Examples

"prefer-const": true

"prefer-const": true,[object Object]

Schema

{
  "type": "object",
  "properties": {
    "destructuring": {
      "type": "string",
      "enum": [
        "all",
        "any"
      ]
    }
  }
}

For more information see this page.

Rule: space-within-parens

Enforces spaces within parentheses or disallow them. Empty parentheses () are always allowed.

Notes

• Has Fix

Config

You may enforce the amount of whitespace within parentheses.

Schema

{
  "type": "number",
  "min": 0
}

For more information see this page.

Rule: whitespace

Enforces whitespace style conventions.

Rationale

Helps maintain a readable, consistent style in your codebase.

Notes

• Has Fix

Config

Several arguments may be optionally provided:

• "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
• "check-decl"checks that variable declarations have whitespace around the equals token.
• "check-operator" checks for whitespace around operator tokens.
• "check-module" checks for whitespace in import & export statements.
• "check-separator" checks for whitespace after separator tokens (,/;).
• "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
• "check-type" checks for whitespace before a variable type specification.
• "check-typecast" checks for whitespace between a typecast and its target.
• "check-type-operator" checks for whitespace between type operators | and &.
• "check-preblock" checks for whitespace before the opening brace of a block.
• "check-postbrace" checks for whitespace after an opening brace.

Examples

"whitespace": true,check-branch,check-operator,check-typecast

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "check-branch",
      "check-decl",
      "check-operator",
      "check-module",
      "check-separator",
      "check-rest-spread",
      "check-type",
      "check-typecast",
      "check-type-operator",
      "check-preblock",
      "check-postbrace"
    ]
  },
  "minLength": 0,
  "maxLength": 11
}

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: 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: eofline

Ensures the file ends with a newline.

Fix for single-line files is not supported.

Rationale

It is a standard convention to end files with a newline.

Notes

• Has Fix

Config

Not configurable.

Examples

"eofline": 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: 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: 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.