Skip to content

User Guide

💿 Installation

bash
npm install --save-dev eslint eslint-plugin-node-dependencies

Requirements

  • ESLint v9.38.0 and above
  • Node.js ^20.19.0 || ^22.13.0 || >=24

📖 Usage

Add node-dependencies to the plugins section of your eslint.config.js configuration file and either use one of the configurations available (recommended) or configure the rules you want:

The plugin.configs.recommended config enables a subset of the rules that should be most useful to most users. See lib/configs/rules/recommended.ts for more details.

js
// eslint.config.js
import nodeDependenciesPlugin from "eslint-plugin-node-dependencies"

export default [
    ...nodeDependenciesPlugin.configs.recommended,
];

Advanced Configuration

Override/add specific rules configurations. See also: http://eslint.org/docs/user-guide/configuring.

js
// eslint.config.js
import nodeDependenciesPlugin from "eslint-plugin-node-dependencies"

export default [
    {
        plugins: { "node-dependencies": nodeDependenciesPlugin },
        rules: {
            // Override/add rules settings here, such as:
            "node-dependencies/rule-name": "error"
        }
    }
];

See the rule list to get the rules that this plugin provides.