eslint-plugin-node-import
v1.0.4
Published
Disallow imports of built-in Node.js modules without the `node:` prefix
Downloads
34,836
Maintainers
Readme
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
Add node-import
to the plugins section of your .eslintrc
configuration file. You can omit the eslint-plugin-
prefix:
{
"plugins": ["node-import"]
}
Then configure the (only) rule under the rules
section.
{
"rules": {
"node-import/prefer-node-protocol": 2
}
}
Rules
🔧 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