17.15.1 โ€ข Published 3 days ago

eslint-plugin-n v17.15.1

Weekly downloads
-
License
MIT
Repository
github
Last release
3 days ago

eslint-plugin-n

forked from eslint-plugin-node v11.1.0. as the original repository seems no longer maintained.

npm version Downloads Build Status

Additional ESLint rules for Node.js

๐ŸŽจ Playground

online-playground

๐Ÿ’ฟ Install & Usage

npm install --save-dev eslint eslint-plugin-n
VersionSupported Node.jsSupported ESLint VersionStatus
17.x^18.18.0 \|\| ^20.9.0 \|\| >=21.1.0>=8.23.0๐Ÿƒโ€โ™‚๏ธactively maintained
16.x>=16.0.0>=7.0.0โš ๏ธEOL
15.x>=12.22.0>=7.0.0โš ๏ธEOL

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

eslint.config.js (requires eslint>=v8.23.0)

const nodePlugin = 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:

const nodePlugin = require("eslint-plugin-n")

module.exports = [
    {
        plugins: {n: nodePlugin},
        rules: {
            "n/exports-style": ["error", "module.exports"]
        }
    }
]

.eslintrc.json (legacy example)

{
    "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"
    }
}

Configured Node.js version range

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

  1. Rule configuration version
  2. ESLint shared setting node.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 since 16 is the maintained lts (see also Node.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"
    }
}

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

๐Ÿ“– Rules

๐Ÿ’ผ Configurations enabled in.\ ๐ŸŸข Set in the recommended-module configuration.\ โœ… Set in the recommended-script configuration.\ ๐Ÿ”ง Automatically fixable by the --fix CLI option.\ โŒ Deprecated.

Nameย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย ย Description๐Ÿ’ผ๐Ÿ”งโŒ
callback-returnrequire return statements after callbacks
exports-styleenforce either module.exports or exports๐Ÿ”ง
file-extension-in-importenforce the style of file extensions in import declarations๐Ÿ”ง
global-requirerequire require() calls to be placed at top-level module scope
handle-callback-errrequire error handling in callbacks
hashbangrequire correct usage of hashbang๐ŸŸข โœ…๐Ÿ”ง
no-callback-literalenforce Node.js-style error-first callback pattern is followed
no-deprecated-apidisallow deprecated APIs๐ŸŸข โœ…
no-exports-assigndisallow the assignment to exports๐ŸŸข โœ…
no-extraneous-importdisallow import declarations which import extraneous modules๐ŸŸข โœ…
no-extraneous-requiredisallow require() expressions which import extraneous modules๐ŸŸข โœ…
no-hide-core-modulesdisallow third-party modules which are hiding core modulesโŒ
no-missing-importdisallow import declarations which import non-existence modules๐ŸŸข โœ…
no-missing-requiredisallow require() expressions which import non-existence modules๐ŸŸข โœ…
no-mixed-requiresdisallow require calls to be mixed with regular variable declarations
no-new-requiredisallow new operators with calls to require
no-path-concatdisallow string concatenation with __dirname and __filename
no-process-envdisallow the use of process.env
no-process-exitdisallow the use of process.exit()๐ŸŸข โœ…
no-restricted-importdisallow specified modules when loaded by import declarations
no-restricted-requiredisallow specified modules when loaded by require
no-syncdisallow synchronous methods
no-unpublished-bindisallow bin files that npm ignores๐ŸŸข โœ…
no-unpublished-importdisallow import declarations which import private modules๐ŸŸข โœ…
no-unpublished-requiredisallow require() expressions which import private modules๐ŸŸข โœ…
no-unsupported-features/es-builtinsdisallow unsupported ECMAScript built-ins on the specified version๐ŸŸข โœ…
no-unsupported-features/es-syntaxdisallow unsupported ECMAScript syntax on the specified version๐ŸŸข โœ…
no-unsupported-features/node-builtinsdisallow unsupported Node.js built-in APIs on the specified version๐ŸŸข โœ…
prefer-global/bufferenforce either Buffer or require("buffer").Buffer
prefer-global/consoleenforce either console or require("console")
prefer-global/processenforce either process or require("process")
prefer-global/text-decoderenforce either TextDecoder or require("util").TextDecoder
prefer-global/text-encoderenforce either TextEncoder or require("util").TextEncoder
prefer-global/urlenforce either URL or require("url").URL
prefer-global/url-search-paramsenforce either URLSearchParams or require("url").URLSearchParams
prefer-node-protocolenforce using the node: protocol when importing Node.js builtin modules.๐Ÿ”ง
prefer-promises/dnsenforce require("dns").promises
prefer-promises/fsenforce require("fs").promises
process-exit-as-throwrequire that process.exit() expressions use the same code path as throw๐ŸŸข โœ…
shebangrequire correct usage of hashbang๐Ÿ”งโŒ

๐Ÿ”ง Configs

Name
๐ŸŸขrecommended-module
โœ…recommended-script

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.

These preset configs:

  • enable no-process-exit rule because the official document does not recommend a use of process.exit().
  • enable plugin rules indicated by emojis in the rules table.
  • add {ecmaVersion: 2021} and etc into parserOptions.
  • add proper globals into globals.
  • add this plugin into plugins.

๐Ÿ‘ซ 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.

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

  • A: You can use the new exported flat config flat/mixed-esm-and-cjs, an example:
const nodePlugin = require("eslint-plugin-n");

module.exports = [
  ...nodePlugin.configs["flat/mixed-esm-and-cjs"],
  {
    rules: {
      "n/exports-style": ["error", "module.exports"],
    },
  },
]

๐Ÿšฅ Semantic Versioning Policy

eslint-plugin-n 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.

Deprecated rules follow ESLint's deprecation policy.

๐Ÿ“ฐ 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.
@yysmx/eslint-config@yysmx/eslint-config-basic@anjun-brasil/eslint-configwmc-eslint@azul-tecnologia/eslint-config@lvyunlong/eslint-config@lvyunlong/eslint-config-basic@jiqi/eslint-config@jiqi/eslint-config-basic@jiralite/eslint-config-neon@kaivanwong/eslint-config-base@qualopreco/eslint-config@rjqh/eslint-config-basic@rain-star/eslint-config-basic@cyenoch/eslint-config@asasinmode/eslint-config@obvcloud/eslint-config-preset-basic@denverzh/eslint-config@denverzh/eslint-config-base@ventjs/eslint-config-basic@ixfe/eslint-config-basic@silence94/eslint-config-basic@jady/eslint-config@caryhu/eslint-config-basiceslint-config-asteroid-preview@fellwork/eslint-config-core@fellwork/eslint-config-foreman@easy-going/eslint-config-base@renya/eslint-config-core@progressivestudio/eslint-config-base@chris-zhu/eslint-config-basiceslint-config-zggz@liuhq8796/eslint-config-wonderful-elementeslint-config-tiggertest@infinitebrahmanuniverse/nolb-eslint-plugin-n@mafalda/eslint-config@yomarsanchez/eslint-config-seek@kriszu/eslint-config-basic@liberopneto/eslint-config@soybeanjs/eslint-config-basic@darkmatter-ui/eslint-config@godismyjudgebro/eslint-config@asasinmode/eslint-config-basic@tgarif/eslint-config-basiceslint-config-soybeanjs-base@kayooliveira/eslint-config@kayooliveira/eslint-plugin@stackz/eslint-configeslint-config-dienerld-reactdienerld-eslint-reactlucasaugustscode-eslint-configeslint-config-mynaeslint-config-watchfulla-eslint-configeslint-config-flower@tackpay/eslint-config-ts@okno/eslint-configquickestrainklinglog@everything-registry/sub-chunk-1612@alt-research/dev@amadeulinhares/eslint-config@ifmini/eslint-config@ifshizuku/eslint-config-basic@ventsislavnikolov/eslint-config@ifmini/eslint-config-core@alexmadeira/config-eslint@alexmadeira/eslint-config-testealiksend-lintervbg_eslinteslint-config-zohynorylord-kit@wood-scripts/eslint-config@daopk/eslint-config-nodeeslint-config-vbg@verteal/eslint-configeslint-config-lucasspradostitch-node@hsjm/eslint-config@blanc-nova/eslint-standard@rubykgen/eslint-config@ruijadom/eslint-config@pixelmonbrasil/eslint-config@voxpelli/neostandardeslint-config-dylanjs@josephanson/eslint-configtalljack-eslint-configwmc-prettier-lintersemistandardstandardteste_lib_easy_3vscode-lintv3-echartsvianuxt3-clivicente015-eslint-config@dark15/eslint-configwizardcomp-eslint-config@daltondevs/eslint@iz7n/eslint-config@cv9t/eslint-config
17.15.0

13 days ago

17.15.1

3 days ago

17.14.0

1 month ago

17.13.2

1 month ago

17.13.0

2 months ago

17.13.1

2 months ago

17.12.0

2 months ago

17.10.3

3 months ago

17.11.0

2 months ago

17.11.1

2 months ago

17.10.2

5 months ago

17.10.0

5 months ago

17.10.1

5 months ago

17.9.0

6 months ago

17.8.1

7 months ago

17.8.0

7 months ago

17.7.0

7 months ago

17.6.0

8 months ago

17.5.0

8 months ago

17.5.1

8 months ago

17.4.0

8 months ago

17.3.0

8 months ago

17.3.1

8 months ago

17.2.1

8 months ago

17.2.0

9 months ago

17.1.0

9 months ago

17.0.0-8

9 months ago

17.0.0

9 months ago

17.0.0-7

9 months ago

17.0.0-6

9 months ago

17.0.0-5

9 months ago

17.0.0-4

10 months ago

17.0.0-3

10 months ago

17.0.0-2

10 months ago

17.0.0-1

11 months ago

16.6.2

12 months ago

17.0.0-0

12 months ago

16.6.1

12 months ago

16.6.0

12 months ago

16.5.0

1 year ago

16.4.0

1 year ago

16.3.1

1 year ago

16.3.0

1 year ago

16.2.0

1 year ago

16.1.0

1 year ago

16.0.2

1 year ago

16.0.1

1 year ago

16.0.0

2 years ago

16.0.0-0

2 years ago

16.0.0-1

2 years ago

15.7.0

2 years ago

15.6.1

2 years ago

15.5.0

2 years ago

15.4.0

2 years ago

15.5.2

2 years ago

15.6.0

2 years ago

15.5.1

2 years ago

15.3.0

2 years ago

15.2.5

2 years ago

15.2.1

3 years ago

15.2.4

2 years ago

15.2.2

3 years ago

15.2.3

3 years ago

15.2.0

3 years ago

15.1.0

3 years ago

15.0.1

3 years ago

15.0.0

3 years ago

14.0.0

3 years ago