Skip to content

roikoren755/eslint-plugin-node

Repository files navigation

eslint-plugin-node-roikoren

Test Status codecov

Bugs Code Smells Maintainability Rating Reliability Rating Security Rating Technical Debt Vulnerabilities

Snyk Vulnerabilities for GitHub Repo

npm NPM npm npm bundle size

GitHub issues GitHub pull requests GitHub code size in bytes Lines of code GitHub top language

A re implementation of eslint-plugin-node in TypeScript.

Disclaimer

First off, I would like to deeply thank @mistycatea and everyone else involved in the original eslint-plugin-node. None of this would have been possible without them, and all credit should go to them.

This package is an attempt to migrate eslint-plugin-node to be written in TypeScript, and to use the great @typescript-eslint repository for plugin development.

Below is taken verbatim from eslint-plugin-node, and will be updated as needed.

💿 Install & Usage

Use npm or a compatible tool.

npm install --save-dev eslint eslint-plugin-node-roikoren

yarn add -D eslint eslint-plugin-node-roikoren

IMPORTANT

If you installed eslint globally, you should install this plugin in the same way.

Requirements

  • Node.js 12.22.0 or newer.
  • ESLint 5.16.0 or newer.

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

.eslintrc.json (An example)

{
  "extends": [
    "eslint:recommended",
    "plugin:node-roikoren/recommended"
  ],
  "parserOptions": {
    "ecmaVersion": 2020
  },
  "rules": {
    "node-roikoren/exports-style": ["error", "module.exports"],
    "node-roikoren/file-extension-in-import": ["error", "always"],
    "node-roikoren/prefer-global/buffer": ["error", "always"],
    "node-roikoren/prefer-global/console": ["error", "always"],
    "node-roikoren/prefer-global/process": ["error", "always"],
    "node-roikoren/prefer-global/url-search-params": ["error", "always"],
    "node-roikoren/prefer-global/url": ["error", "always"],
    "node-roikoren/prefer-promises/dns": "error",
    "node-roikoren/prefer-promises/fs": "error"
  }
}

package.json (An example)

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

📖 Rules

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

Possible Errors

Rule ID Description
node-roikoren/handle-callback-err require error handling in callbacks
node-roikoren/no-callback-literal enforce Node.js-style error-first callback pattern is followed
node-roikoren/no-exports-assign disallow the assignment to exports ⭐️
node-roikoren/no-extraneous-import disallow import declarations which import extraneous modules ⭐️
node-roikoren/no-extraneous-require disallow require() expressions which import extraneous modules ⭐️
node-roikoren/no-missing-import disallow import declarations which import non-existent modules ⭐️
node-roikoren/no-missing-require disallow require() expressions which import non-existent modules ⭐️
node-roikoren/no-new-require disallow new operators with calls to require
node-roikoren/no-path-concat disallow string concatenation with __dirname and __filename
node-roikoren/no-process-exit disallow the use of process.exit()
node-roikoren/no-unpublished-bin disallow bin files that npm ignores ⭐️
node-roikoren/no-unpublished-import disallow import declarations which import private modules ⭐️
node-roikoren/no-unpublished-require disallow require() expressions which import private modules ⭐️
node-roikoren/no-unsupported-features/es-builtins disallow unsupported ECMAScript built-ins on the specified version ⭐️
node-roikoren/no-unsupported-features/es-syntax disallow unsupported ECMAScript syntax on the specified version ⭐️
node-roikoren/no-unsupported-features/node-builtins disallow unsupported Node.js built-in APIs on the specified version ⭐️
node-roikoren/process-exit-as-throw enforce process.exit() expressions to count as the same code path as throw ⭐️
node-roikoren/shebang enforce correct usage of shebang ⭐️✒️

Best Practices

Rule ID Description
node-roikoren/no-deprecated-api/no-deprecated-api disallow deprecated APIs ⭐️

Stylistic Issues

Rule ID Description
node-roikoren/callback-return require return statements after callbacks
node-roikoren/exports-style enforce either module.exports or exports ✒️
node-roikoren/file-extension-in-import enforce the style of file extensions in import declarations ✒️
node-roikoren/global-require require require() calls to be placed at top-level module scope
node-roikoren/no-mixed-requires disallow require calls to be mixed with regular variable declarations
node-roikoren/no-process-env disallow the use of process.env
node-roikoren/no-restricted-import disallow specified modules when loaded by import declarations
node-roikoren/no-restricted-require disallow specified modules when loaded by require
node-roikoren/no-sync disallow synchronous methods
node-roikoren/prefer-global/buffer enforce either Buffer or require("buffer").Buffer
node-roikoren/prefer-global/console enforce either console or require("console")
node-roikoren/prefer-global/process enforce either process or require("process")
node-roikoren/prefer-global/text-decoder enforce either TextDecoder or require("util").TextDecoder
node-roikoren/prefer-global/text-encoder enforce either TextEncoder or require("util").TextEncoder
node-roikoren/prefer-global/url-search-params enforce either URLSearchParams or require("url").URLSearchParams
node-roikoren/prefer-global/url enforce either URL or require("url").URL
node-roikoren/prefer-promises/dns enforce require("dns").promises
node-roikoren/prefer-promises/fs enforce require("fs").promises

🔧 Configs

This plugin provides three configs:

  • plugin:node-roikoren/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.
  • plugin:node-roikoren/recommended-module considers all files as ES Modules.
  • plugin:node-roikoren/recommended-script considers all files as CommonJS.

Those preset config:

  • enable no-process-exit rule because the official document does not recommend a use of process.exit().
  • enable plugin rules which are given ⭐ in the above table.
  • add { ecmaVersion : 2019} etc. into parserOptions.
  • add proper globals into globals.
  • add this plugin into plugins.

👫 FAQ

🚥 Semantic Versioning Policy

eslint-plugin-node-roikoren 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

Contributions are welcome!

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.