eslint-plugin-node

What is eslint-plugin-node?

The eslint-plugin-node package is an ESLint plugin that contains rules that are specific to Node.js development. It helps in identifying issues related to syntax and patterns that are not optimal or could lead to errors in a Node.js context.

What are eslint-plugin-node's main functionalities?

Process Exit As Throw

This rule treats calls to process.exit() as throw statements, which can be useful for highlighting an unexpected termination of the Node.js process.

/* eslint node/no-process-exit: 'error' */
process.exit(1);

No Deprecated API

This rule prevents the use of deprecated Node.js APIs to encourage best practices and avoid potential future issues with deprecated methods.

/* eslint node/no-deprecated-api: 'error' */
const domain = require('domain');

No Missing Imports

This rule ensures that all modules that are imported into a file are actually resolvable, helping to catch typos and incorrect module names.

/* eslint node/no-missing-import: 'error' */
import someModule from 'nonexistent-module';

No Unpublished Bin

This rule checks that all files referenced in the 'bin' field of package.json are actually published, preventing issues with npm packages.

/* eslint node/no-unpublished-bin: 'error' */
{
  "bin": "bin/nonexistent.js"
}

Other packages similar to eslint-plugin-node

eslint-plugin-import

This package provides similar functionality to eslint-plugin-node in terms of managing imports and exports in your code. It includes features like ensuring imports point to a file/module that can be resolved.

eslint-plugin-promise

While eslint-plugin-node focuses on Node.js-specific rules, eslint-plugin-promise provides rules that are specific to the use of promises in JavaScript, which can be relevant in Node.js for handling asynchronous operations.

eslint-plugin-security

This package focuses on identifying potential security issues in Node.js code, which complements eslint-plugin-node's focus on Node.js best practices and avoiding deprecated or problematic patterns.

README

eslint-plugin-node

Additional ESLint's rules for Node.js

Install & Usage

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

.eslintrc

{
    "extends": "eslint:recommended",
    "plugins": ["node"],
    "env": {
        "es6": true,
        "node": true
    },
    "rules": {
        "node/no-missing-import": "error",
        "node/no-missing-require": "error",
        "node/no-unpublished-import": "error",
        "node/no-unpublished-require": "error",
        "node/no-unsupported-features": ["error", {"version": 4}],
        "node/process-exit-as-throw": "error",
        "node/shebang": "error"
    }
}

Rules

Some rules are slow because it searches package.json and opens it.

• no-missing-import - Disallow import and export declarations for files that don't exist.
• no-missing-require - Disallow require()s for files that don't exist.
• no-unpublished-import - Disallow import and export declarations for files that are not published.
• no-unpublished-require - Disallow require()s for files that are not published.
• no-unsupported-features - Disallow unsupported ECMAScript features on the specified version.
• process-exit-as-throw - Make the same code path as throw at process.exit(). (⚠ Experimental)
• shebang - Suggest correct usage of shebang. (fixable)

FAQ

Q: The no-missing-import / no-missing-require rules don't work with nested folders in SublimeLinter-eslint

A: See context.getFilename() in rule returns relative path in the SublimeLinter-eslint FAQ.