eslint-plugin-node-import

Disallow imports of built-in Node.js modules without the node: prefix

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-node-import:

npm install eslint-plugin-node-import --save-dev

Usage

Flat config (eslint.config.js)

Preset config

Extend this plugin's recommended config:

const nodeImport = require('eslint-plugin-node-import');

module.exports = [
	...nodeImport.configs["flat/recommended"],
	// your config
]

Manual

Add node-import to the plugins section of your configuration and configure the (only) rule under the rules section:

const nodeImport = require('eslint-plugin-node-import');

module.exports = [
	{
		plugins: {"node-import": nodeImport},
		rules: {
			"node-import/prefer-node-protocol": "error"
		}
	}
]

Legacy config (.eslintrc.*)

Preset config

Extend this plugin's recommended config:

{
	"extends": ["plugin:node-import/recommended"]
}

Manual

Add node-import to the plugins section of your .eslintrc configuration file and configure the (only) rule under the rules section:

{
	"plugins": ["node-import"],
	"rules": {
		"node-import/prefer-node-protocol": 2
	}
}

Rules

💼 Configurations enabled in.
✅ Set in the recommended configuration.
🔧 Automatically fixable by the --fix CLI option.

| Name                 | Description | 💼 | 🔧 | | :--------------------------------------------------------- | :------------------------------------------------------------------------ | :- | :- | | prefer-node-protocol | Prefer using the node: protocol when importing Node.js builtin modules. | ✅ | 🔧 |

Credits

This plugin is a composite of two different custom ESLint rules:

• @alex-kinokon's eslint-import-require-node-prefix from this GitHub Gist
• Sindre Sorhus' prefer-node-protocol from eslint-plugin-unicorn

Licence

© 2023 Nikita Karamov
Licensed under the ISC License

This project is hosted on GitHub: https://github.com/kytta/eslint-plugin-node-import.git