Socket
Socket
Sign inDemoInstall

@erboladaiorg/tempora-nisi

Package Overview
Dependencies
43
Maintainers
0
Versions
49
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@erboladaiorg/tempora-nisi


Version published
Maintainers
0
Created

Readme

Source

@erboladaiorg/tempora-nisi

forked from @erboladaiorg/tempora-nisiode 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 @erboladaiorg/tempora-nisi
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.

.eslintrc.json (An example)

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

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

const nodePlugin = require("@erboladaiorg/tempora-nisi")

module.exports = [
    nodePlugin.configs["flat/recommended-script"],
    {
        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 flat/recommended configuration.
🟢 Set in the flat/recommended-module configuration.
✅ Set in the flat/recommended-script configuration.
☑️ Set in the recommended configuration.
🟢 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
🟠flat/mixed-esm-and-cjs
☑️flat/recommended
🟢flat/recommended-module
✅flat/recommended-script
☑️recommended
🟢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("@erboladaiorg/tempora-nisi");

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

🚥 Semantic Versioning Policy

@erboladaiorg/tempora-nisi 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.

Keywords

FAQs

Last updated on 12 Jul 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc