Repository files navigation

forked fromeslint-plugin-node v11.1.0. as the original repository seemsno longer maintained.

Additional ESLint rules for Node.js

online-playground

npm install --save-dev eslint eslint-plugin-n

Note: It recommends a use ofthe "engines" field of package.json. The "engines" field is used byn/no-unsupported-features/* rules.

constnodePlugin=require("eslint-plugin-n")module.exports=[nodePlugin.configs["flat/recommended-script"],{rules:{"n/exports-style":["error","module.exports"]}}]

To setup without the recommended configs, you'll need to add the plugin:

constnodePlugin=require("eslint-plugin-n")module.exports=[{plugins:{n:nodePlugin},rules:{"n/exports-style":["error","module.exports"]}}]

{"extends": ["eslint:recommended","plugin:n/recommended"],"parserOptions": {"ecmaVersion":2021    },"rules": {"n/exports-style": ["error","module.exports"]    }}

To setup without the recommended rules you'll need to add the plugin:

{"parserOptions": {"ecmaVersion":2021    },"plugins": ["n"],"rules": {"n/exports-style": ["error","module.exports"]    }}

package.json (An example)

{"name":"your-module","version":"1.0.0","type":"commonjs","engines": {"node":">=8.10.0"    }}

The rules get the supported Node.js version range from the following, falling back to the next if unspecified:

1. Rule configurationversion
2. ESLintshared settingnode.version
3. package.json [engines] field
4. >=16.0.0

If you omit the [engines] field, this rule chooses>=16.0.0 as the configured Node.js version since16 is the maintained lts (see alsoNode.js Release Working Group).

For Node.js packages, using the [engines] field is recommended because it's the official way to indicate support:

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

ForShareable Configs or packages with a different development environment (e.g. pre-compiled, web package, etc.), you can configure ESLint withsettings.node.version to specify support.

💼Configurations enabled in.
🟢 Set in therecommended-moduleconfiguration.
✅ Set in therecommended-scriptconfiguration.
🔧 Automatically fixable by the--fix CLI option.
❌ Deprecated.

About each config:

• recommended: Considers 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.
• recommended-module: Considers all files as ES Modules.
• recommended-script: Considers all files as CommonJS.
• flat/all: enables all of the rules shipped with the package. This configuration isnot recommended for production use because it may change with every minor and major version. Use at your own risk.

These preset configs:

• enableno-process-exit rule becausethe official document does not recommend a use ofprocess.exit().
• enable plugin rules indicated by emojis in therules table.
• add{ecmaVersion: 2021} and etc intoparserOptions.
• add proper globals intoglobals.
• add this plugin intoplugins.

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

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

• Q: How to use the flat eslint config with mixed commonjs and es modules?

• A: You can use the new exported flat configflat/mixed-esm-and-cjs, an example:

constnodePlugin=require("eslint-plugin-n");module.exports=[  ...nodePlugin.configs["flat/mixed-esm-and-cjs"],{rules:{"n/exports-style":["error","module.exports"],},},]

eslint-plugin-n followssemantic versioning andESLint'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.

Deprecated rules follow ESLint'sdeprecation policy.

• GitHub Releases

Welcome contributing!

Please use GitHub's Issues/PRs.

• npm test runs tests and measures coverage.
• npm run coverage shows the coverage result ofnpm test command.
• npm run clean removes the coverage result ofnpm test command.