Rule: no-bitwise

Disallows bitwise operators.

Specifically, the following bitwise operators are banned: &, &=, |, |=, ^, ^=, <<, <<=, >>, >>=, >>>, >>>=, and ~. This rule does not ban the use of & and | for intersection and union types.

Rationale

Bitwise operators are often typos - for example bool1 & bool2 instead of bool1 && bool2. They also can be an indicator of overly clever code which decreases maintainability.

Config

Not configurable.

Examples

"no-bitwise": true

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-bitwise

Disallows bitwise operators.

Specifically, the following bitwise operators are banned: &, &=, |, |=, ^, ^=, <<, <<=, >>, >>=, >>>, >>>=, and ~. This rule does not ban the use of & and | for intersection and union types.

Rationale

Bitwise operators are often typos - for example bool1 & bool2 instead of bool1 && bool2. They also can be an indicator of overly clever code which decreases maintainability.

Config

Not configurable.

Examples

"no-bitwise": true

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-bitwise

Disallows bitwise operators.

Specifically, the following bitwise operators are banned: &, &=, |, |=, ^, ^=, <<, <<=, >>, >>=, >>>, >>>=, and ~. This rule does not ban the use of & and | for intersection and union types.

Rationale

Bitwise operators are often typos - for example bool1 & bool2 instead of bool1 && bool2. They also can be an indicator of overly clever code which decreases maintainability.

Config

Not configurable.

Examples

"no-bitwise": true

For more information see this page.