Skip to content

useNodejsImportProtocol

诊断类别:lint/style/useNodejsImportProtocol

¥Diagnostic Category: lint/style/useNodejsImportProtocol

自从:v1.5.0

¥Since: v1.5.0

来源:

¥Sources:

强制使用 node: 协议来处理 Node.js 内置模块。

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

规则将传统导入(如 import fs from "fs";)标记为无效,改为建议使用 import fs from "node:fs"; 格式。

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

如果 package.json 中声明的依赖与内置 Node.js 模块的名称匹配,则也不会触发该规则。

¥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

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

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

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

import fs from 'node:fs';
import os from 'node:os';
import path from 'node:path';

¥Related links