JSPM

  • Created
  • Published
  • Downloads 3553804
  • Score
    100M100P100Q191334F
  • License MIT

Additional ESLint's rules for Node.js

Package Exports

  • eslint-plugin-node
  • eslint-plugin-node/conf/recommended.json
  • eslint-plugin-node/lib/rules/no-deprecated-api
  • eslint-plugin-node/lib/rules/process-exit-as-throw
  • eslint-plugin-node/package.json

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (eslint-plugin-node) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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

.eslintrc

{
    "plugins": ["node"],
    "extends": ["eslint:recommended", "plugin:node/recommended"]
}

Configs

This plugin provides plugin:node/recommended preset config. This preset config:

  • enables the environment of ES2015 (ES6) and Node.js.
  • enables rules which are given ⭐ in the following table.

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

Rules

Rule ID Description
no-deprecated-api Disallow deprecated API.
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.
  • ⭐ - the mark of a recommended rule.
  • 📝 - the mark of a fixable rule.

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 eslint-plugin-node 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 eslint-plugin-node 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 removed.
    • An existing option of a rule is removed.
    • An existing config is updated.

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.