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

Enforces vertical alignment.

Rationale

Helps maintain a readable, consistent style in your codebase.

Consistent alignment for code statements helps keep code readable and clear. Statements misaligned from the standard can be harder to read and understand.

Notes

• Has Fix

Config

Five arguments may be optionally provided:

• "parameters" checks alignment of function parameters.
• "arguments" checks alignment of function call arguments.
• "statements" checks alignment of statements.
• "members" checks alignment of members of classes, interfaces, type literal, object literals and object destructuring.
• "elements" checks alignment of elements of array literals, array destructuring and tuple types.

Examples

"align": true,parameters,statements

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "arguments",
      "elements",
      "members",
      "parameters",
      "statements"
    ]
  },
  "minLength": 1,
  "maxLength": 5
}

For more information see this page.

Rule: align

Enforces vertical alignment.

Rationale

Helps maintain a readable, consistent style in your codebase.

Consistent alignment for code statements helps keep code readable and clear. Statements misaligned from the standard can be harder to read and understand.

Notes

• Has Fix

Config

Five arguments may be optionally provided:

• "parameters" checks alignment of function parameters.
• "arguments" checks alignment of function call arguments.
• "statements" checks alignment of statements.
• "members" checks alignment of members of classes, interfaces, type literal, object literals and object destructuring.
• "elements" checks alignment of elements of array literals, array destructuring and tuple types.

Examples

"align": true,parameters,statements

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "arguments",
      "elements",
      "members",
      "parameters",
      "statements"
    ]
  },
  "minLength": 1,
  "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.