useJsonImportAttribute

JavaScript (and super languages)

Summary

Rule available since: v2.0.0
Diagnostic Category: lint/nursery/useJsonImportAttribute
This rule has a safe fix.
The default severity of this rule is information.
This rule belongs to the following domains:
- project

Description

Enforces the use of with { type: "json" } for JSON module imports.

ECMAScript modules can import JSON modules. However, the specific import assertion with { type: "json" } is required to inform the JavaScript runtime that the imported file should be parsed as JSON. Omitting this assertion can lead to runtime errors or misinterpretation of the imported module.

This rule ensures that all imports of .json files include this assertion.

Examples

Invalid

1
import jsonData from './data.json';

code-block.js:1:1 lint/nursery/useJsonImportAttribute  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ This JSON import is missing the type: “json” import attribute.
  
  > 1 │ import jsonData from ‘./data.json’;
      │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ To explicitly declare the module type for JSON imports, add with { type: “json” } to this import statement.
  
  ℹ Safe fix: Add ‘type: “json”’ import attribute.
  
    1 │ import·jsonData·from·‘./data.json’·with·{·type:·“json”·};
      │                                   ++++++++++++++++++++++

1
import jsonData from './data.json' with { someOtherAttribute: "value" };

code-block.js:1:36 lint/nursery/useJsonImportAttribute  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ The import attributes for this JSON module are missing type: “json”.
  
  > 1 │ import jsonData from ‘./data.json’ with { someOtherAttribute: “value” };
      │                                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ Ensure the with clause includes type: “json” for this JSON import.
  
  ℹ Safe fix: Add ‘type: “json”’ import attribute.
  
    1 │ import·jsonData·from·‘./data.json’·with·{·type:·“json”,·someOtherAttribute:·“value”·};
      │                                           ++++++++++++++

Valid

1
import jsonData from './data.json' with { type: "json" };
2

3
import jsonData from './data.json' with { type: "json", other: "value" };
4

5
import code from './script.js'; // Not a JSON import

How to configure

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