eslint-plugin-node
Additional ESLint's rules for Node.js
Last updated 15 days ago by mysticatea .
MIT · Repository · Bugs · Original npm · Tarball
$ cnpm install eslint-plugin-node 
SYNC missed versions from official npm registry.

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 ^4.0.0 || >=6.0.0
  • Requires ESLint >=3.1.0

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

.eslintrc.json (An example)

{
    "plugins": ["node"],
    "extends": ["eslint:recommended", "plugin:node/recommended"],
    "rules": {
        "node/exports-style": ["error", "module.exports"]
    }
}

package.json (An example)

{
    "name": "your-module",
    "version": "1.0.0",
    "engines": {
        "node": ">=4.0.0"
    }
}

???? Rules

  • ⭐️ - the mark of recommended rules.
  • ✒️ - the mark of fixable rules.

Possible Errors

Rule ID Description
no-extraneous-import disallow import declarations of extraneous packages
⭐️ no-extraneous-require disallow require() expressions of extraneous packages
no-missing-import disallow import declarations of missing files
⭐️ no-missing-require disallow require() expressions of missing files
⭐️ no-unpublished-bin disallow 'bin' files which are ignored by npm
no-unpublished-import disallow import declarations of private things
⭐️ no-unpublished-require disallow require() expressions of private things
⭐️ no-unsupported-features disallow unsupported ECMAScript features on the specified version
⭐️ process-exit-as-throw make process.exit() expressions the same code path as throw
⭐️✒️ shebang enforce the correct usage of shebang

Best Practices

Rule ID Description
⭐️ no-deprecated-api disallow deprecated APIs

Stylistic Issues

Rule ID Description
exports-style enforce either module.exports or exports

???? 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 :star: in the above table.
  • enables no-process-exit rule because the official document does not recommend a use of process.exit().
  • adds {ecmaVersion: 8} into parserOptions.

???? 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.
Maintainers (1)
Downloads
Today 13
This Week 140
This Month 15,483
Last Day 127
Last Week 2,079
Last Month 45,092
Dependencies (4)
Dev Dependencies (8)
Dependents (532)

Copyright 2014 - 2017 © taobao.org |