useNodejsImportProtocol (JavaScript)

Language JavaScript (and super languages)

Summary

Rule available since: v1.5.0
Diagnostic Category: lint/style/useNodejsImportProtocol
This rule is recommended, meaning it is enabled by default.
This rule has an unsafe fix.
The default severity of this rule is information.
Sources:
- Same as unicorn/prefer-node-protocol
- Same as import/enforce-node-protocol-usage

How to configure

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

Description

Enforces using the node: protocol for Node.js builtin modules.

The rule marks traditional imports like import fs from "fs"; as invalid, suggesting the format import fs from "node:fs"; instead.

The rule also isn’t triggered if there are dependencies declared in the package.json that match the name of a built-in Node.js module.

Examples

Invalid

1
import fs from 'fs';

code-block.js:1:16 lint/style/useNodejsImportProtocol  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ A Node.js builtin module should be imported with the node: protocol.
  
  > 1 │ import fs from 'fs';
      │                ^^^^
    2 │ 
  
  ℹ Using the node: protocol is more explicit and signals that the imported module belongs to Node.js.
  
  ℹ Unsafe fix: Add the node: protocol.
  
    1   │ - import·fs·from·'fs';
      1 │ + import·fs·from·'node:fs';
    2 2 │

1
import os from 'os';

code-block.js:1:16 lint/style/useNodejsImportProtocol  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ A Node.js builtin module should be imported with the node: protocol.
  
  > 1 │ import os from 'os';
      │                ^^^^
    2 │ 
  
  ℹ Using the node: protocol is more explicit and signals that the imported module belongs to Node.js.
  
  ℹ Unsafe fix: Add the node: protocol.
  
    1   │ - import·os·from·'os';
      1 │ + import·os·from·'node:os';
    2 2 │

1
import path from 'path';

code-block.js:1:18 lint/style/useNodejsImportProtocol  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ A Node.js builtin module should be imported with the node: protocol.
  
  > 1 │ import path from 'path';
      │                  ^^^^^^
    2 │ 
  
  ℹ Using the node: protocol is more explicit and signals that the imported module belongs to Node.js.
  
  ℹ Unsafe fix: Add the node: protocol.
  
    1   │ - import·path·from·'path';
      1 │ + import·path·from·'node:path';
    2 2 │

Valid

1
import fs from 'node:fs';
2

3
import os from 'node:os';
4

5
import path from 'node:path';