Home

Awesome

This project has been no longer maintained. Please consider to use https://github.com/eslint-community/eslint-plugin-n.

eslint-plugin-node

npm version Downloads/month Build Status Coverage Status Dependency Status

Additional ESLint's rules for Node.js

💿 Install & Usage

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

Note: It recommends a use of the "engines" field of package.json. The "engines" field is used by node/no-unsupported-features/* rules.

.eslintrc.json (An example)

{
    "extends": [
        "eslint:recommended",
        "plugin:node/recommended"
    ],
    "parserOptions": {
        // Only ESLint 6.2.0 and later support ES2020.
        "ecmaVersion": 2020
    },
    "rules": {
        "node/exports-style": ["error", "module.exports"],
        "node/file-extension-in-import": ["error", "always"],
        "node/prefer-global/buffer": ["error", "always"],
        "node/prefer-global/console": ["error", "always"],
        "node/prefer-global/process": ["error", "always"],
        "node/prefer-global/url-search-params": ["error", "always"],
        "node/prefer-global/url": ["error", "always"],
        "node/prefer-promises/dns": "error",
        "node/prefer-promises/fs": "error"
    }
}

package.json (An example)

{
    "name": "your-module",
    "version": "1.0.0",
    "type": "commonjs",
    "engines": {
        "node": ">=8.10.0"
    }
}

📖 Rules

<!--RULES_TABLE_START-->

Possible Errors

Rule IDDescription
node/handle-callback-errrequire error handling in callbacks
node/no-callback-literalensure Node.js-style error-first callback pattern is followed
node/no-exports-assigndisallow the assignment to exports⭐️
node/no-extraneous-importdisallow import declarations which import extraneous modules⭐️
node/no-extraneous-requiredisallow require() expressions which import extraneous modules⭐️
node/no-missing-importdisallow import declarations which import non-existence modules⭐️
node/no-missing-requiredisallow require() expressions which import non-existence modules⭐️
node/no-new-requiredisallow new operators with calls to require
node/no-path-concatdisallow string concatenation with __dirname and __filename
node/no-process-exitdisallow the use of process.exit()
node/no-unpublished-bindisallow bin files that npm ignores⭐️
node/no-unpublished-importdisallow import declarations which import private modules⭐️
node/no-unpublished-requiredisallow require() expressions which import private modules⭐️
node/no-unsupported-features/es-builtinsdisallow unsupported ECMAScript built-ins on the specified version⭐️
node/no-unsupported-features/es-syntaxdisallow unsupported ECMAScript syntax on the specified version⭐️
node/no-unsupported-features/node-builtinsdisallow unsupported Node.js built-in APIs on the specified version⭐️
node/process-exit-as-throwmake process.exit() expressions the same code path as throw⭐️
node/shebangsuggest correct usage of shebang⭐️✒️

Best Practices

Rule IDDescription
node/no-deprecated-apidisallow deprecated APIs⭐️

Stylistic Issues

Rule IDDescription
node/callback-returnrequire return statements after callbacks
node/exports-styleenforce either module.exports or exports
node/file-extension-in-importenforce the style of file extensions in import declarations✒️
node/global-requirerequire require() calls to be placed at top-level module scope
node/no-mixed-requiresdisallow require calls to be mixed with regular variable declarations
node/no-process-envdisallow the use of process.env
node/no-restricted-importdisallow specified modules when loaded by import declarations
node/no-restricted-requiredisallow specified modules when loaded by require
node/no-syncdisallow synchronous methods
node/prefer-global/bufferenforce either Buffer or require("buffer").Buffer
node/prefer-global/consoleenforce either console or require("console")
node/prefer-global/processenforce either process or require("process")
node/prefer-global/text-decoderenforce either TextDecoder or require("util").TextDecoder
node/prefer-global/text-encoderenforce either TextEncoder or require("util").TextEncoder
node/prefer-global/url-search-paramsenforce either URLSearchParams or require("url").URLSearchParams
node/prefer-global/urlenforce either URL or require("url").URL
node/prefer-promises/dnsenforce require("dns").promises
node/prefer-promises/fsenforce require("fs").promises

Deprecated rules

These rules have been deprecated in accordance with the deprecation policy, and replaced by newer rules:

Rule IDReplaced by
node/no-hide-core-modules(nothing)
node/no-unsupported-featuresnode/no-unsupported-features/es-syntax and node/no-unsupported-features/es-builtins
<!--RULES_TABLE_END-->

🔧 Configs

This plugin provides three configs:

Those preset config:

👫 FAQ

🚥 Semantic Versioning Policy

eslint-plugin-node follows semantic versioning and ESLint's Semantic Versioning Policy.

📰 Changelog

❤️ Contributing

Welcome contributing!

Please use GitHub's Issues/PRs.

Development Tools