Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including eslint-plugin-node with all npm packages installed. Try it out:

require("eslint/package.json"); // eslint is a peer dependency. var eslintPluginNode = require("eslint-plugin-node")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

eslint-plugin-node v10.0.0

Additional ESLint's rules for Node.js

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
  • Requires Node.js >=8.10.0
  • Requires ESLint >=5.16.0

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

  • ⭐️ - the mark of recommended rules.
  • ✒️ - the mark of fixable rules.
### Possible Errors
Rule IDDescription
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-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/exports-styleenforce either module.exports or exports
node/file-extension-in-importenforce the style of file extensions in import declarations✒️
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/node/no-unsupported-features/es-syntax and node/node/no-unsupported-features/es-builtins

🔧 Configs

This plugin provides three configs:

  • plugin:node/recommended condiders both CommonJS and ES Modules. If "type":"module" field existed in package.json then it considers files as ES Modules. Otherwise it considers files as CommonJS. In addition, it considers *.mjs files as ES Modules and *.cjs files as CommonJS.
  • plugin:node/recommended-module considers all files as ES Modules.
  • plugin:node/recommended-script considers all files as CommonJS.

Those preset config:

  • enable no-process-exit rule because the official document does not recommend a use of process.exit().
  • enable plugin rules which are given :star: in the above table.
  • add {ecmaVersion: 2019} and etc into parserOptions.
  • add proper globals into globals.
  • add this plugin into plugins.

👫 FAQ

🚥 Semantic Versioning Policy

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

  • Patch release (intended to not break your lint build)
    • A bug fix in a rule that results in it reporting fewer errors.
    • Improvements to documentation.
    • Non-user-facing changes such as refactoring code, adding, deleting, or modifying tests, and increasing test coverage.
    • Re-releasing after a failed release (i.e., publishing a release that doesn't work for anyone).
  • Minor release (might break your lint build)
    • A bug fix in a rule that results in it reporting more errors.
    • A new rule is created.
    • A new option to an existing rule is created.
    • An existing rule is deprecated.
  • Major release (likely to break your lint build)
    • A support for old Node version is dropped.
    • A support for old ESLint version is dropped.
    • An existing rule is changed in it reporting more errors.
    • An existing rule is removed.
    • An existing option of a rule is removed.
    • An existing config is updated.

📰 Changelog

❤️ Contributing

Welcome contributing!

Please use GitHub's Issues/PRs.

Development Tools

  • npm test runs tests and measures coverage.
  • npm run coverage shows the coverage result of npm test command.
  • npm run clean removes the coverage result of npm test command.
RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free