eslint-plugin-node

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

		Rule ID	Description
		exports-style	Enforce either `module.exports` or `exports`.
⭐		no-deprecated-api	Disallow deprecated API.
		no-missing-import	Disallow `import` declarations for files that don't exist. ⚠️
⭐		no-missing-require	Disallow `require()`s for files that don't exist.
⭐		no-unpublished-bin	Disallow `bin` files that npm ignores.
		no-unpublished-import	Disallow `import` declarations for files that npm ignores. ⚠️
⭐		no-unpublished-require	Disallow `require()`s for files that npm ignores.
⭐		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()`.
⭐	📝	shebang	Suggest correct usage of shebang.

⭐ - the mark of a recommended rule.
📝 - the mark of a fixable rule.

🔧 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 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

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.

⚓ 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

GitHub Releases

💪 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.

5.4 KiB Raw Blame History