noNodejsModules

Diagnostic Category: lint/correctness/noNodejsModules

JavaScript (and super languages)

Since: v1.5.0 Sources:

Same as: import/no-nodejs-modules

Description

Forbid the use of Node.js builtin modules.

This can be useful for client-side web projects that don’t have access to those modules.

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.

Type-only imports are ignored.

Examples

Invalid

import fs from "fs";

code-block.js:1:16 lint/correctness/noNodejsModules ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Using Node.js modules is forbidden.
  
  > 1 │ import fs from “fs”;
      │                ^^^^
    2 │ 
  
  ℹ Can be useful for client-side web projects that do not have access to those modules.
  
  ℹ Remove the import module.

import path from "node:path";

code-block.js:1:18 lint/correctness/noNodejsModules ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Using Node.js modules is forbidden.
  
  > 1 │ import path from “node:path”;
      │                  ^^^^^^^^^^^
    2 │ 
  
  ℹ Can be useful for client-side web projects that do not have access to those modules.
  
  ℹ Remove the import module.

Valid

import fs from "fs-custom";

import type path from "node:path";

How to configure

{
  "linter": {
    "rules": {
      "correctness": {
        "noNodejsModules": "error"
      }
    }
  }
}