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

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 242.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

• Extract Method
• Extract Class
• Form Template Method
• Introduce Null Object
• Pull Up Method
• Pull Up Field
• Substitute Algorithm

Further Reading

• Don't Repeat Yourself on the C2 Wiki
• Duplicated Code on SourceMaking
• Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 133.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

• Extract Method
• Extract Class
• Form Template Method
• Introduce Null Object
• Pull Up Method
• Pull Up Field
• Substitute Algorithm

Further Reading

• Don't Repeat Yourself on the C2 Wiki
• Duplicated Code on SourceMaking
• Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 98.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

• Extract Method
• Extract Class
• Form Template Method
• Introduce Null Object
• Pull Up Method
• Pull Up Field
• Substitute Algorithm

Further Reading

• Don't Repeat Yourself on the C2 Wiki
• Duplicated Code on SourceMaking
• Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76

Rule: triple-equals

Requires === and !== in place of == and !=.

Config

Two arguments may be optionally provided:

• "allow-null-check" allows == and != when comparing to null.
• "allow-undefined-check" allows == and != when comparing to undefined.

Examples

"triple-equals": true

"triple-equals": true,allow-null-check

"triple-equals": true,allow-undefined-check

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "allow-null-check",
      "allow-undefined-check"
    ]
  },
  "minLength": 0,
  "maxLength": 2
}

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

Enforces quote character for string literals.

Notes

• Has Fix

Config

Five arguments may be optionally provided:

• "single" enforces single quotes.
• "double" enforces double quotes.
• "backtick" enforces backticks.
• "jsx-single" enforces single quotes for JSX attributes.
• "jsx-double" enforces double quotes for JSX attributes.
• "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
• "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.

Examples

"quotemark": true,single,avoid-escape,avoid-template

"quotemark": true,single,jsx-double

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "single",
      "double",
      "backtick",
      "jsx-single",
      "jsx-double",
      "avoid-escape",
      "avoid-template"
    ]
  },
  "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: max-line-length

Requires lines to be under a certain max length.

Rationale

Limiting the length of a line of code improves code readability. It also makes comparing code side-by-side easier and improves compatibility with various editors, IDEs, and diff viewers.

Config

It can take one argument, which can be any of the following: * integer indicating maximum length of lines. * object with keys: * limit - number greater than 0 defining the max line length * ignore-pattern - string defining ignore pattern for this rule, being parsed by new RegExp(). For example: * // pattern will ignore all in-line comments. * ^import pattern will ignore all import statements. * ^export {(.*?)} pattern will ignore all multiple export statements. * class [a-zA-Z]+ implements pattern will ignore all class declarations implementing interfaces. * ^import |^export {(.*?)}|class [a-zA-Z]+ implements |// pattern will ignore all the cases listed above. * check-strings - determines if strings should be checked, false by default. * check-regex - determines if regular expressions should be checked, false by default.

Examples

"max-line-length": true,120

"max-line-length": true,[object Object]

Schema

{
  "type": "array",
  "items": {
    "oneOf": [
      {
        "type": "number"
      },
      {
        "type": "object",
        "properties": {
          "limit": {
            "type": "number"
          },
          "ignore-pattern": {
            "type": "string"
          },
          "check-strings": {
            "type": "boolean"
          },
          "check-regex": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      }
    ]
  },
  "minLength": 1,
  "maxLength": 2
}

For more information see this page.

Rule: no-inferrable-types

Disallows explicit type declarations for variables or parameters initialized to a number, string, or boolean.

Rationale

Explicit types where they can be easily inferred by the compiler make code more verbose.

Notes

• TypeScript Only
• Has Fix

Config

Two arguments may be optionally provided:

• ignore-params allows specifying an inferrable type annotation for function params. This can be useful when combining with the typedef rule.
• ignore-properties allows specifying an inferrable type annotation for class properties.

Examples

"no-inferrable-types": true

"no-inferrable-types": true,ignore-params

"no-inferrable-types": true,ignore-params,ignore-properties

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "ignore-params",
      "ignore-properties"
    ]
  },
  "minLength": 0,
  "maxLength": 2
}

For more information see this page.

Rule: no-unused-expression

Disallows unused expression statements.

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

Rationale

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

Config

Three arguments may be optionally provided:

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

Examples

"no-unused-expression": true

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

Schema

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

For more information see this page.

Rule: quotemark

Enforces quote character for string literals.

Notes

• Has Fix

Config

Five arguments may be optionally provided:

• "single" enforces single quotes.
• "double" enforces double quotes.
• "backtick" enforces backticks.
• "jsx-single" enforces single quotes for JSX attributes.
• "jsx-double" enforces double quotes for JSX attributes.
• "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
• "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.

Examples

"quotemark": true,single,avoid-escape,avoid-template

"quotemark": true,single,jsx-double

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "single",
      "double",
      "backtick",
      "jsx-single",
      "jsx-double",
      "avoid-escape",
      "avoid-template"
    ]
  },
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: radix

Requires the radix parameter to be specified when calling parseInt.

Rationale

From MDN:

Always specify this parameter to eliminate reader confusion and to guarantee predictable behavior. Different implementations produce different results when a radix is not specified, usually defaulting the value to 10.

Config

Not configurable.

Examples

"radix": 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: no-trailing-whitespace

Disallows trailing whitespace at the end of a line.

Rationale

Keeps version control diffs clean as it prevents accidental whitespace from being committed.

Notes

• Has Fix

Config

Possible settings are:

• "ignore-template-strings": Allows trailing whitespace in template strings.
• "ignore-comments": Allows trailing whitespace in comments.
• "ignore-jsdoc": Allows trailing whitespace only in JSDoc comments.
• "ignore-blank-lines": Allows trailing whitespace on empty lines.

Examples

"no-trailing-whitespace": true

"no-trailing-whitespace": true,ignore-comments

"no-trailing-whitespace": true,ignore-jsdoc

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "ignore-comments",
      "ignore-jsdoc",
      "ignore-template-strings",
      "ignore-blank-lines"
    ]
  }
}

For more information see this page.

Rule: triple-equals

Requires === and !== in place of == and !=.

Config

Two arguments may be optionally provided:

• "allow-null-check" allows == and != when comparing to null.
• "allow-undefined-check" allows == and != when comparing to undefined.

Examples

"triple-equals": true

"triple-equals": true,allow-null-check

"triple-equals": true,allow-undefined-check

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "allow-null-check",
      "allow-undefined-check"
    ]
  },
  "minLength": 0,
  "maxLength": 2
}

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

Enforces quote character for string literals.

Notes

• Has Fix

Config

Five arguments may be optionally provided:

• "single" enforces single quotes.
• "double" enforces double quotes.
• "backtick" enforces backticks.
• "jsx-single" enforces single quotes for JSX attributes.
• "jsx-double" enforces double quotes for JSX attributes.
• "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
• "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.

Examples

"quotemark": true,single,avoid-escape,avoid-template

"quotemark": true,single,jsx-double

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "single",
      "double",
      "backtick",
      "jsx-single",
      "jsx-double",
      "avoid-escape",
      "avoid-template"
    ]
  },
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: quotemark

Enforces quote character for string literals.

Notes

• Has Fix

Config

Five arguments may be optionally provided:

• "single" enforces single quotes.
• "double" enforces double quotes.
• "backtick" enforces backticks.
• "jsx-single" enforces single quotes for JSX attributes.
• "jsx-double" enforces double quotes for JSX attributes.
• "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
• "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.

Examples

"quotemark": true,single,avoid-escape,avoid-template

"quotemark": true,single,jsx-double

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "single",
      "double",
      "backtick",
      "jsx-single",
      "jsx-double",
      "avoid-escape",
      "avoid-template"
    ]
  },
  "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: quotemark

Enforces quote character for string literals.

Notes

• Has Fix

Config

Five arguments may be optionally provided:

• "single" enforces single quotes.
• "double" enforces double quotes.
• "backtick" enforces backticks.
• "jsx-single" enforces single quotes for JSX attributes.
• "jsx-double" enforces double quotes for JSX attributes.
• "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
• "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.

Examples

"quotemark": true,single,avoid-escape,avoid-template

"quotemark": true,single,jsx-double

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "single",
      "double",
      "backtick",
      "jsx-single",
      "jsx-double",
      "avoid-escape",
      "avoid-template"
    ]
  },
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: quotemark

Enforces quote character for string literals.

Notes

• Has Fix

Config

Five arguments may be optionally provided:

• "single" enforces single quotes.
• "double" enforces double quotes.
• "backtick" enforces backticks.
• "jsx-single" enforces single quotes for JSX attributes.
• "jsx-double" enforces double quotes for JSX attributes.
• "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
• "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.

Examples

"quotemark": true,single,avoid-escape,avoid-template

"quotemark": true,single,jsx-double

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "single",
      "double",
      "backtick",
      "jsx-single",
      "jsx-double",
      "avoid-escape",
      "avoid-template"
    ]
  },
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: triple-equals

Requires === and !== in place of == and !=.

Config

Two arguments may be optionally provided:

• "allow-null-check" allows == and != when comparing to null.
• "allow-undefined-check" allows == and != when comparing to undefined.

Examples

"triple-equals": true

"triple-equals": true,allow-null-check

"triple-equals": true,allow-undefined-check

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "allow-null-check",
      "allow-undefined-check"
    ]
  },
  "minLength": 0,
  "maxLength": 2
}

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

Enforces quote character for string literals.

Notes

• Has Fix

Config

Five arguments may be optionally provided:

• "single" enforces single quotes.
• "double" enforces double quotes.
• "backtick" enforces backticks.
• "jsx-single" enforces single quotes for JSX attributes.
• "jsx-double" enforces double quotes for JSX attributes.
• "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
• "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.

Examples

"quotemark": true,single,avoid-escape,avoid-template

"quotemark": true,single,jsx-double

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "single",
      "double",
      "backtick",
      "jsx-single",
      "jsx-double",
      "avoid-escape",
      "avoid-template"
    ]
  },
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

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

Notes

• Has Fix

Config

One of the following arguments must be provided:

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

A second optional argument specifies indentation size:

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

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

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

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

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

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

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

Notes

• Has Fix

Config

One of the following arguments must be provided:

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

A second optional argument specifies indentation size:

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

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

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

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

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

For more information see this page.

Rule: no-inferrable-types

Disallows explicit type declarations for variables or parameters initialized to a number, string, or boolean.

Rationale

Explicit types where they can be easily inferred by the compiler make code more verbose.

Notes

• TypeScript Only
• Has Fix

Config

Two arguments may be optionally provided:

• ignore-params allows specifying an inferrable type annotation for function params. This can be useful when combining with the typedef rule.
• ignore-properties allows specifying an inferrable type annotation for class properties.

Examples

"no-inferrable-types": true

"no-inferrable-types": true,ignore-params

"no-inferrable-types": true,ignore-params,ignore-properties

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "ignore-params",
      "ignore-properties"
    ]
  },
  "minLength": 0,
  "maxLength": 2
}

For more information see this page.

Rule: no-trailing-whitespace

Disallows trailing whitespace at the end of a line.

Rationale

Keeps version control diffs clean as it prevents accidental whitespace from being committed.

Notes

• Has Fix

Config

Possible settings are:

• "ignore-template-strings": Allows trailing whitespace in template strings.
• "ignore-comments": Allows trailing whitespace in comments.
• "ignore-jsdoc": Allows trailing whitespace only in JSDoc comments.
• "ignore-blank-lines": Allows trailing whitespace on empty lines.

Examples

"no-trailing-whitespace": true

"no-trailing-whitespace": true,ignore-comments

"no-trailing-whitespace": true,ignore-jsdoc

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "ignore-comments",
      "ignore-jsdoc",
      "ignore-template-strings",
      "ignore-blank-lines"
    ]
  }
}

For more information see this page.

Rule: no-trailing-whitespace

Disallows trailing whitespace at the end of a line.

Rationale

Keeps version control diffs clean as it prevents accidental whitespace from being committed.

Notes

• Has Fix

Config

Possible settings are:

• "ignore-template-strings": Allows trailing whitespace in template strings.
• "ignore-comments": Allows trailing whitespace in comments.
• "ignore-jsdoc": Allows trailing whitespace only in JSDoc comments.
• "ignore-blank-lines": Allows trailing whitespace on empty lines.

Examples

"no-trailing-whitespace": true

"no-trailing-whitespace": true,ignore-comments

"no-trailing-whitespace": true,ignore-jsdoc

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "ignore-comments",
      "ignore-jsdoc",
      "ignore-template-strings",
      "ignore-blank-lines"
    ]
  }
}

For more information see this page.

Rule: triple-equals

Requires === and !== in place of == and !=.

Config

Two arguments may be optionally provided:

• "allow-null-check" allows == and != when comparing to null.
• "allow-undefined-check" allows == and != when comparing to undefined.

Examples

"triple-equals": true

"triple-equals": true,allow-null-check

"triple-equals": true,allow-undefined-check

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "allow-null-check",
      "allow-undefined-check"
    ]
  },
  "minLength": 0,
  "maxLength": 2
}

For more information see this page.

Rule: triple-equals

Requires === and !== in place of == and !=.

Config

Two arguments may be optionally provided:

• "allow-null-check" allows == and != when comparing to null.
• "allow-undefined-check" allows == and != when comparing to undefined.

Examples

"triple-equals": true

"triple-equals": true,allow-null-check

"triple-equals": true,allow-undefined-check

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "allow-null-check",
      "allow-undefined-check"
    ]
  },
  "minLength": 0,
  "maxLength": 2
}

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-inferrable-types

Disallows explicit type declarations for variables or parameters initialized to a number, string, or boolean.

Rationale

Explicit types where they can be easily inferred by the compiler make code more verbose.

Notes

• TypeScript Only
• Has Fix

Config

Two arguments may be optionally provided:

• ignore-params allows specifying an inferrable type annotation for function params. This can be useful when combining with the typedef rule.
• ignore-properties allows specifying an inferrable type annotation for class properties.

Examples

"no-inferrable-types": true

"no-inferrable-types": true,ignore-params

"no-inferrable-types": true,ignore-params,ignore-properties

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "ignore-params",
      "ignore-properties"
    ]
  },
  "minLength": 0,
  "maxLength": 2
}

For more information see this page.

Rule: no-inferrable-types

Disallows explicit type declarations for variables or parameters initialized to a number, string, or boolean.

Rationale

Explicit types where they can be easily inferred by the compiler make code more verbose.

Notes

• TypeScript Only
• Has Fix

Config

Two arguments may be optionally provided:

• ignore-params allows specifying an inferrable type annotation for function params. This can be useful when combining with the typedef rule.
• ignore-properties allows specifying an inferrable type annotation for class properties.

Examples

"no-inferrable-types": true

"no-inferrable-types": true,ignore-params

"no-inferrable-types": true,ignore-params,ignore-properties

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "ignore-params",
      "ignore-properties"
    ]
  },
  "minLength": 0,
  "maxLength": 2
}

For more information see this page.

Rule: quotemark

Enforces quote character for string literals.

Notes

• Has Fix

Config

Five arguments may be optionally provided:

• "single" enforces single quotes.
• "double" enforces double quotes.
• "backtick" enforces backticks.
• "jsx-single" enforces single quotes for JSX attributes.
• "jsx-double" enforces double quotes for JSX attributes.
• "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
• "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.

Examples

"quotemark": true,single,avoid-escape,avoid-template

"quotemark": true,single,jsx-double

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "single",
      "double",
      "backtick",
      "jsx-single",
      "jsx-double",
      "avoid-escape",
      "avoid-template"
    ]
  },
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: quotemark

Enforces quote character for string literals.

Notes

• Has Fix

Config

Five arguments may be optionally provided:

• "single" enforces single quotes.
• "double" enforces double quotes.
• "backtick" enforces backticks.
• "jsx-single" enforces single quotes for JSX attributes.
• "jsx-double" enforces double quotes for JSX attributes.
• "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
• "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.

Examples

"quotemark": true,single,avoid-escape,avoid-template

"quotemark": true,single,jsx-double

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "single",
      "double",
      "backtick",
      "jsx-single",
      "jsx-double",
      "avoid-escape",
      "avoid-template"
    ]
  },
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

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

Notes

• Has Fix

Config

One of the following arguments must be provided:

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

A second optional argument specifies indentation size:

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

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

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

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

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

For more information see this page.

Rule: no-trailing-whitespace

Disallows trailing whitespace at the end of a line.

Rationale

Keeps version control diffs clean as it prevents accidental whitespace from being committed.

Notes

• Has Fix

Config

Possible settings are:

• "ignore-template-strings": Allows trailing whitespace in template strings.
• "ignore-comments": Allows trailing whitespace in comments.
• "ignore-jsdoc": Allows trailing whitespace only in JSDoc comments.
• "ignore-blank-lines": Allows trailing whitespace on empty lines.

Examples

"no-trailing-whitespace": true

"no-trailing-whitespace": true,ignore-comments

"no-trailing-whitespace": true,ignore-jsdoc

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "ignore-comments",
      "ignore-jsdoc",
      "ignore-template-strings",
      "ignore-blank-lines"
    ]
  }
}

For more information see this page.

Rule: quotemark

Enforces quote character for string literals.

Notes

• Has Fix

Config

Five arguments may be optionally provided:

• "single" enforces single quotes.
• "double" enforces double quotes.
• "backtick" enforces backticks.
• "jsx-single" enforces single quotes for JSX attributes.
• "jsx-double" enforces double quotes for JSX attributes.
• "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
• "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.

Examples

"quotemark": true,single,avoid-escape,avoid-template

"quotemark": true,single,jsx-double

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "single",
      "double",
      "backtick",
      "jsx-single",
      "jsx-double",
      "avoid-escape",
      "avoid-template"
    ]
  },
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: semicolon

Enforces consistent semicolon usage at the end of every statement.

Notes

• Has Fix

Config

One of the following arguments must be provided:

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

The following arguments may be optionally provided:

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

Examples

"semicolon": true,always

"semicolon": true,never

"semicolon": true,always,ignore-interfaces

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

Schema

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

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

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

Notes

• Has Fix

Config

One of the following arguments must be provided:

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

A second optional argument specifies indentation size:

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

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

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

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

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

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

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

Notes

• Has Fix

Config

One of the following arguments must be provided:

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

A second optional argument specifies indentation size:

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

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

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

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

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

For more information see this page.

Rule: quotemark

Enforces quote character for string literals.

Notes

• Has Fix

Config

Five arguments may be optionally provided:

• "single" enforces single quotes.
• "double" enforces double quotes.
• "backtick" enforces backticks.
• "jsx-single" enforces single quotes for JSX attributes.
• "jsx-double" enforces double quotes for JSX attributes.
• "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
• "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.

Examples

"quotemark": true,single,avoid-escape,avoid-template

"quotemark": true,single,jsx-double

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "single",
      "double",
      "backtick",
      "jsx-single",
      "jsx-double",
      "avoid-escape",
      "avoid-template"
    ]
  },
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: quotemark

Enforces quote character for string literals.

Notes

• Has Fix

Config

Five arguments may be optionally provided:

• "single" enforces single quotes.
• "double" enforces double quotes.
• "backtick" enforces backticks.
• "jsx-single" enforces single quotes for JSX attributes.
• "jsx-double" enforces double quotes for JSX attributes.
• "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
• "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.

Examples

"quotemark": true,single,avoid-escape,avoid-template

"quotemark": true,single,jsx-double

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "single",
      "double",
      "backtick",
      "jsx-single",
      "jsx-double",
      "avoid-escape",
      "avoid-template"
    ]
  },
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

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

Notes

• Has Fix

Config

One of the following arguments must be provided:

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

A second optional argument specifies indentation size:

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

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

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

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

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

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

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

Notes

• Has Fix

Config

One of the following arguments must be provided:

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

A second optional argument specifies indentation size:

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

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

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

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

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

For more information see this page.

Rule: no-trailing-whitespace

Disallows trailing whitespace at the end of a line.

Rationale

Keeps version control diffs clean as it prevents accidental whitespace from being committed.

Notes

• Has Fix

Config

Possible settings are:

• "ignore-template-strings": Allows trailing whitespace in template strings.
• "ignore-comments": Allows trailing whitespace in comments.
• "ignore-jsdoc": Allows trailing whitespace only in JSDoc comments.
• "ignore-blank-lines": Allows trailing whitespace on empty lines.

Examples

"no-trailing-whitespace": true

"no-trailing-whitespace": true,ignore-comments

"no-trailing-whitespace": true,ignore-jsdoc

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "ignore-comments",
      "ignore-jsdoc",
      "ignore-template-strings",
      "ignore-blank-lines"
    ]
  }
}

For more information see this page.

Rule: quotemark

Enforces quote character for string literals.

Notes

• Has Fix

Config

Five arguments may be optionally provided:

• "single" enforces single quotes.
• "double" enforces double quotes.
• "backtick" enforces backticks.
• "jsx-single" enforces single quotes for JSX attributes.
• "jsx-double" enforces double quotes for JSX attributes.
• "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
• "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.

Examples

"quotemark": true,single,avoid-escape,avoid-template

"quotemark": true,single,jsx-double

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "single",
      "double",
      "backtick",
      "jsx-single",
      "jsx-double",
      "avoid-escape",
      "avoid-template"
    ]
  },
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: triple-equals

Requires === and !== in place of == and !=.

Config

Two arguments may be optionally provided:

• "allow-null-check" allows == and != when comparing to null.
• "allow-undefined-check" allows == and != when comparing to undefined.

Examples

"triple-equals": true

"triple-equals": true,allow-null-check

"triple-equals": true,allow-undefined-check

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "allow-null-check",
      "allow-undefined-check"
    ]
  },
  "minLength": 0,
  "maxLength": 2
}

For more information see this page.

Rule: triple-equals

Requires === and !== in place of == and !=.

Config

Two arguments may be optionally provided:

• "allow-null-check" allows == and != when comparing to null.
• "allow-undefined-check" allows == and != when comparing to undefined.

Examples

"triple-equals": true

"triple-equals": true,allow-null-check

"triple-equals": true,allow-undefined-check

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "allow-null-check",
      "allow-undefined-check"
    ]
  },
  "minLength": 0,
  "maxLength": 2
}

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

Enforces quote character for string literals.

Notes

• Has Fix

Config

Five arguments may be optionally provided:

• "single" enforces single quotes.
• "double" enforces double quotes.
• "backtick" enforces backticks.
• "jsx-single" enforces single quotes for JSX attributes.
• "jsx-double" enforces double quotes for JSX attributes.
• "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
• "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.

Examples

"quotemark": true,single,avoid-escape,avoid-template

"quotemark": true,single,jsx-double

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "single",
      "double",
      "backtick",
      "jsx-single",
      "jsx-double",
      "avoid-escape",
      "avoid-template"
    ]
  },
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: quotemark

Enforces quote character for string literals.

Notes

• Has Fix

Config

Five arguments may be optionally provided:

• "single" enforces single quotes.
• "double" enforces double quotes.
• "backtick" enforces backticks.
• "jsx-single" enforces single quotes for JSX attributes.
• "jsx-double" enforces double quotes for JSX attributes.
• "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
• "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.

Examples

"quotemark": true,single,avoid-escape,avoid-template

"quotemark": true,single,jsx-double

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "single",
      "double",
      "backtick",
      "jsx-single",
      "jsx-double",
      "avoid-escape",
      "avoid-template"
    ]
  },
  "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: 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: quotemark

Enforces quote character for string literals.

Notes

• Has Fix

Config

Five arguments may be optionally provided:

• "single" enforces single quotes.
• "double" enforces double quotes.
• "backtick" enforces backticks.
• "jsx-single" enforces single quotes for JSX attributes.
• "jsx-double" enforces double quotes for JSX attributes.
• "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
• "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.

Examples

"quotemark": true,single,avoid-escape,avoid-template

"quotemark": true,single,jsx-double

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "single",
      "double",
      "backtick",
      "jsx-single",
      "jsx-double",
      "avoid-escape",
      "avoid-template"
    ]
  },
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

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

Notes

• Has Fix

Config

One of the following arguments must be provided:

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

A second optional argument specifies indentation size:

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

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

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

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

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

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

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

Notes

• Has Fix

Config

One of the following arguments must be provided:

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

A second optional argument specifies indentation size:

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

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

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

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

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

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

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

Notes

• Has Fix

Config

One of the following arguments must be provided:

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

A second optional argument specifies indentation size:

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

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

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

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

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

For more information see this page.

Rule: indent

Enforces indentation with tabs or spaces.

Rationale

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

Notes

• Has Fix

Config

One of the following arguments must be provided:

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

A second optional argument specifies indentation size:

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

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

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

Examples

"indent": true,spaces

"indent": true,spaces,4

"indent": true,tabs,2

Schema

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

For more information see this page.

Rule: no-inferrable-types

Disallows explicit type declarations for variables or parameters initialized to a number, string, or boolean.

Rationale

Explicit types where they can be easily inferred by the compiler make code more verbose.

Notes

• TypeScript Only
• Has Fix

Config

Two arguments may be optionally provided:

• ignore-params allows specifying an inferrable type annotation for function params. This can be useful when combining with the typedef rule.
• ignore-properties allows specifying an inferrable type annotation for class properties.

Examples

"no-inferrable-types": true

"no-inferrable-types": true,ignore-params

"no-inferrable-types": true,ignore-params,ignore-properties

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "ignore-params",
      "ignore-properties"
    ]
  },
  "minLength": 0,
  "maxLength": 2
}

For more information see this page.

Rule: no-inferrable-types

Disallows explicit type declarations for variables or parameters initialized to a number, string, or boolean.

Rationale

Explicit types where they can be easily inferred by the compiler make code more verbose.

Notes

• TypeScript Only
• Has Fix

Config

Two arguments may be optionally provided:

• ignore-params allows specifying an inferrable type annotation for function params. This can be useful when combining with the typedef rule.
• ignore-properties allows specifying an inferrable type annotation for class properties.

Examples

"no-inferrable-types": true

"no-inferrable-types": true,ignore-params

"no-inferrable-types": true,ignore-params,ignore-properties

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "ignore-params",
      "ignore-properties"
    ]
  },
  "minLength": 0,
  "maxLength": 2
}

For more information see this page.

Rule: no-inferrable-types

Disallows explicit type declarations for variables or parameters initialized to a number, string, or boolean.

Rationale

Explicit types where they can be easily inferred by the compiler make code more verbose.

Notes

• TypeScript Only
• Has Fix

Config

Two arguments may be optionally provided:

• ignore-params allows specifying an inferrable type annotation for function params. This can be useful when combining with the typedef rule.
• ignore-properties allows specifying an inferrable type annotation for class properties.

Examples

"no-inferrable-types": true

"no-inferrable-types": true,ignore-params

"no-inferrable-types": true,ignore-params,ignore-properties

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "ignore-params",
      "ignore-properties"
    ]
  },
  "minLength": 0,
  "maxLength": 2
}

For more information see this page.

Rule: no-trailing-whitespace

Disallows trailing whitespace at the end of a line.

Rationale

Keeps version control diffs clean as it prevents accidental whitespace from being committed.

Notes

• Has Fix

Config

Possible settings are:

• "ignore-template-strings": Allows trailing whitespace in template strings.
• "ignore-comments": Allows trailing whitespace in comments.
• "ignore-jsdoc": Allows trailing whitespace only in JSDoc comments.
• "ignore-blank-lines": Allows trailing whitespace on empty lines.

Examples

"no-trailing-whitespace": true

"no-trailing-whitespace": true,ignore-comments

"no-trailing-whitespace": true,ignore-jsdoc

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "ignore-comments",
      "ignore-jsdoc",
      "ignore-template-strings",
      "ignore-blank-lines"
    ]
  }
}

For more information see this page.

Rule: quotemark

Enforces quote character for string literals.

Notes

• Has Fix

Config

Five arguments may be optionally provided:

• "single" enforces single quotes.
• "double" enforces double quotes.
• "backtick" enforces backticks.
• "jsx-single" enforces single quotes for JSX attributes.
• "jsx-double" enforces double quotes for JSX attributes.
• "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
• "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.

Examples

"quotemark": true,single,avoid-escape,avoid-template

"quotemark": true,single,jsx-double

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "single",
      "double",
      "backtick",
      "jsx-single",
      "jsx-double",
      "avoid-escape",
      "avoid-template"
    ]
  },
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: quotemark

Enforces quote character for string literals.

Notes

• Has Fix

Config

Five arguments may be optionally provided:

• "single" enforces single quotes.
• "double" enforces double quotes.
• "backtick" enforces backticks.
• "jsx-single" enforces single quotes for JSX attributes.
• "jsx-double" enforces double quotes for JSX attributes.
• "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
• "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.

Examples

"quotemark": true,single,avoid-escape,avoid-template

"quotemark": true,single,jsx-double

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "single",
      "double",
      "backtick",
      "jsx-single",
      "jsx-double",
      "avoid-escape",
      "avoid-template"
    ]
  },
  "minLength": 0,
  "maxLength": 5
}

For more information see this page.

Rule: triple-equals

Requires === and !== in place of == and !=.

Config

Two arguments may be optionally provided:

• "allow-null-check" allows == and != when comparing to null.
• "allow-undefined-check" allows == and != when comparing to undefined.

Examples

"triple-equals": true

"triple-equals": true,allow-null-check

"triple-equals": true,allow-undefined-check

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "allow-null-check",
      "allow-undefined-check"
    ]
  },
  "minLength": 0,
  "maxLength": 2
}

For more information see this page.

Rule: triple-equals

Requires === and !== in place of == and !=.

Config

Two arguments may be optionally provided:

• "allow-null-check" allows == and != when comparing to null.
• "allow-undefined-check" allows == and != when comparing to undefined.

Examples

"triple-equals": true

"triple-equals": true,allow-null-check

"triple-equals": true,allow-undefined-check

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "allow-null-check",
      "allow-undefined-check"
    ]
  },
  "minLength": 0,
  "maxLength": 2
}

For more information see this page.