noEmptyObjectKeys

Ce contenu n’est pas encore disponible dans votre langue.

JSON (and super languages)

Summary

Diagnostic Category: lint/nursery/noEmptyObjectKeys
This rule doesn’t have a fix.
The default severity of this rule is information.
Sources:
- Same as json/no-empty-keys

How to configure

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

Description

Disallow empty keys in JSON objects.

In JSON, using empty keys (keys that are empty strings or contain only whitespace) can lead to accessibility and maintenance issues. While technically valid in JSON, empty keys make objects harder to read, can cause confusion when debugging, and may create problems with some JSON parsers or processors. Additionally, empty keys often indicate mistakes or oversights in the processes.

Examples

Invalid

1
{
2
  "": "value"
3
}

code-block.json:2:3 lint/nursery/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.
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.

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

code-block.json:3:3 lint/nursery/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.
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.

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

code-block.json:2:3 lint/nursery/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.
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.

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

code-block.json:2:3 lint/nursery/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.
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.

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

code-block.json:2:3 lint/nursery/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.
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.

Valid

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