noTopLevelLiterals (JSON)

Language JSON (and super languages)

Summary

Rule available since: v2.4.7
Diagnostic Category: lint/style/noTopLevelLiterals
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 information.
Sources:
- Same as json/top-level-interop

How to configure

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

Description

Require the JSON top-level value to be an array or object.

Modern JSON allows an object, array, string, number, boolean, or null at the top level. Older parsers based on RFC 4627 accept only an object or array. Restricting the top level to those two forms improves compatibility and leaves room to add more fields or items later.

Examples

Invalid

1
"just a string"

code-block.json:1:1 lint/style/noTopLevelLiterals ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Expected the top-level value to be an array or object.
  
  > 1 │ "just a string"
      │ ^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ Some JSON parsers only support objects or arrays as the root element. Wrap your value in an array or object to ensure compatibility.

1
42

code-block.json:1:1 lint/style/noTopLevelLiterals ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Expected the top-level value to be an array or object.
  
  > 1 │ 42
      │ ^^
    2 │ 
  
  ℹ Some JSON parsers only support objects or arrays as the root element. Wrap your value in an array or object to ensure compatibility.

1
true

code-block.json:1:1 lint/style/noTopLevelLiterals ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Expected the top-level value to be an array or object.
  
  > 1 │ true
      │ ^^^^
    2 │ 
  
  ℹ Some JSON parsers only support objects or arrays as the root element. Wrap your value in an array or object to ensure compatibility.

1
null

code-block.json:1:1 lint/style/noTopLevelLiterals ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Expected the top-level value to be an array or object.
  
  > 1 │ null
      │ ^^^^
    2 │ 
  
  ℹ Some JSON parsers only support objects or arrays as the root element. Wrap your value in an array or object to ensure compatibility.

Valid

1
{
2
  "property": "value",
3
  "otherProperty": 123
4
}

1
["element", "anotherElement"]

1
{}

1
[]