noEmptyObjectKeys (JSON)

Language JSON (and super languages)

Summary

Rule available since: v2.4.7
Diagnostic Category: lint/suspicious/noEmptyObjectKeys
This rule isn’t recommended, so you need to enable it.
This rule doesn’t have a fix.
The default severity of this rule is warning.
Sources:
- Same as json/no-empty-keys

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "suspicious": {
5
        "noEmptyObjectKeys": "error"
6
      }
7
    }
8
  }
9
}

Description

Disallow empty keys in JSON objects.

JSON allows empty strings as object keys, but they are difficult to identify in logs, error messages, and source code. This rule reports keys that are empty or contain only whitespace, because they are usually accidental. Use a short, meaningful name instead.

Examples

Invalid

1
{
2
  "": "value"
3
}

code-block.json:2:3 lint/suspicious/noEmptyObjectKeys ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Unexpected empty object key.
  
    1 │ {
  > 2 │   "": "value"
      │   ^^
    3 │ }
    4 │ 
  
  ℹ Empty keys often cause confusion and may cause issues with parsers or processors. Either remove this property or provide a meaningful key name.

1
{
2
  "validKey": "value",
3
  "": "another value"
4
}

code-block.json:3:3 lint/suspicious/noEmptyObjectKeys ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Unexpected empty object key.
  
    1 │ {
    2 │   "validKey": "value",
  > 3 │   "": "another value"
      │   ^^
    4 │ }
    5 │ 
  
  ℹ Empty keys often cause confusion and may cause issues with parsers or processors. Either remove this property or provide a meaningful key name.

1
{
2
  " ": "space as key"
3
}

code-block.json:2:3 lint/suspicious/noEmptyObjectKeys ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Unexpected empty object key.
  
    1 │ {
  > 2 │   " ": "space as key"
      │   ^^^
    3 │ }
    4 │ 
  
  ℹ Empty keys often cause confusion and may cause issues with parsers or processors. Either remove this property or provide a meaningful key name.

1
{
2
  "\t": "tab as key"
3
}

code-block.json:2:3 lint/suspicious/noEmptyObjectKeys ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Unexpected empty object key.
  
    1 │ {
  > 2 │   "\t": "tab as key"
      │   ^^^^
    3 │ }
    4 │ 
  
  ℹ Empty keys often cause confusion and may cause issues with parsers or processors. Either remove this property or provide a meaningful key name.

1
{
2
  "\n": "newline as key"
3
}

code-block.json:2:3 lint/suspicious/noEmptyObjectKeys ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Unexpected empty object key.
  
    1 │ {
  > 2 │   "\n": "newline as key"
      │   ^^^^
    3 │ }
    4 │ 
  
  ℹ Empty keys often cause confusion and may cause issues with parsers or processors. Either remove this property or provide a meaningful key name.

Valid

1
{
2
  "key": "value"
3
}