@voxpelli/eslint-config

My personal ESLint config which extends standard / semistandard with a couple of extra checks that I find helpful in my projects.

Includes the semistandard rules directly rather than relying on eslint-config-semistandard, as that package isn't always trailing the main eslint-config-standard package.

This package follows semantic versioning. Tightening of any checks is a breaking change, therefore that will only happen in major releases. Minor and patch releases will only include relaxation of rules or fixing of minor obvious oversights.

Can I use this in my own project?

Absolutely, go ahead! I maintain this project as if multiple people are using it. Be sure to give me feedback and if you like it, give me a ping and say so, would make my day 😄

Usage

Install

Be sure to install the correct versions of peer dependencies that this module requires, else you will likely get an incorrect rule setup.

To easily install all correct peer dependencies, you can use install-peerdeps:

install-peerdeps --dev @voxpelli/eslint-config

Configure

Add an .eslintrc, or other ESLint configuration, that extends this config:

{
  "extends": "@voxpelli",
  "root": true
}

Configure, ESM

Instead of simply extending @voxpelli you can extend @voxpelli/eslint-config/esm and get a version of the rules that enforces ESM best practices as well.

How does this differ from pure standard?

• 🛑 = changed to error level
• ⚠️ = changed to warn level
• 🔇 = deactivated
• 🔧 = changed config
• 😬 = will not pass vanilla standard linting

🔧 Changed standard rules

• 🔧⚠️😬 comma-dangle – changed – prefer dangling commas in everything but functions + is it set to warn rather than error as I gradually move to this setup
• 🔇 dot-notation – deactivated – clashes with the noPropertyAccessFromIndexSignature check in TypeScript, which I use
• 🔧😬 no-multi-spaces – changed – sets ignoreEOLComments to true, can be useful for more readable comments across multiple lines and I see no real downsides to it (Incompatible with standard)
• 🔧 no-unused-vars – changed – sets "args": "all", "argsIgnorePattern": "^_", because I personally don't feel limited by Express error handlers + wants to stay in sync with TypeScript noUnusedParameters
• 🔧😬 semi and no-extra-semi – changed – adopts the semicolons setup from semistandard (Incompatible with plain standard, compatible with semistandard)
• 🔧⚠️ n/no-deprecated-api – changed – changed to warn instead of error as often it's not an urgent thing to fix

➕ Added ESLint core rules

• ⚠️ func-style – disallows function declarations, good to be consistent with how functions are declared
• ⚠️ no-console – warns on existence of console.log and similar, as they are mostly used for debugging and should not be committed
• 🛑 no-constant-binary-expression – errors when binary expressions are detected to constantly evaluate a specific way
• 🛑 no-nonoctal-decimal-escape – there's no reason not to ban it
• 🛑 no-unsafe-optional-chaining – enforces one to be careful with .? and not use it in ways that can inadvertently cause errors or NaN results
• ⚠️ no-warning-comments – warns of the existence of FIXME comments, as they should always be fixed before pushing
• 🛑 object-shorthand – requires the use of object shorthands for properties, more tidy
• 🛑 quote-props – requires properties to be quoted when needed but otherwise disallows it

📦 Added ESLint rule package

• plugin:n/recommended
• plugin:security/recommended
• plugin:mocha/recommended
• plugin:unicorn/recommended
• plugin:promise/recommended
• plugin:jsdoc/recommended

🔧 Overrides of added ESLint rule packages

• 🔇 jsdoc/check-types – deactivated – to improve use with types in js.

• 🔇 jsdoc/no-undefined-types – deactivated – to improve use with types in js.

• 🔇 jsdoc/require-jsdoc – deactivated – to improve use with types in js.

• 🔇 jsdoc/require-param-description – deactivated – to improve use with types in js.

• 🔇 jsdoc/require-property-description – deactivated – to improve use with types in js.

• 🔇 jsdoc/require-returns-description – deactivated – to improve use with types in js.

• 🔇 jsdoc/require-yields – deactivated – to improve use with types in js.

• 🔧 jsdoc/tag-lines – changed – to enforce an empty line between description and tags, but disallow them elsewhere.

• 🔇 jsdoc/valid-types – deactivated – to improve use with types in js.

• 🔇 mocha/no-mocha-arrows – deactivated – while Mocha discourages arrow functions I find it more readable to use them + I find it safe when type checking ones test files as then the type checking will notify one when one tries to do a this.setTimeout() or similar in an arrow function where there is no such local context

• 🔇 n/no-process-exit – deactivated – added by plugin:n/recommended, but deactivated in favor of unicorn/no-process-exit

• 🔇 security/detect-object-injection – deactivated – causes too many false errors

• 🔇 security/detect-unsafe-regex – deactivated – at least early on wasn't very stable

• 🔧 unicorn/catch-error-name – changed – I prefer err over error as I find errorto be a far too similar name to the built in Error class

• 🔇 unicorn/explicit-length-check – deactivated – I don't see an issue with if (string.length) instead of if (string.length !== 0)

• ⚠️ unicorn/unicorn/no-await-expression-member – changed – eg. useful in chai tests

• ⚠️ unicorn/unicorn/no-negated-condition – deactivated – turned off, there are valid cases for this, so it simply gets noisy

• 🔇 unicorn/numeric-separators-style – deactivated – currently not enough good support for this in engines

• ⚠️ unicorn/prefer-add-event-listener – changed – set to warn instead of error

• ⚠️ unicorn/prefer-event-target – changed – set to warn instead of error

• 🔇 unicorn/prefer-module – deactivated – only useful when you know you're targetting ESM

• ⚠️ unicorn/prefer-spread – changed – set to warn instead of error

• ⚠️ unicorn/prefer-string-replace-all – changed – set to warn instead of error

• 🔇 unicorn/prevent-abbreviations – deactivated – same as unicorn/catch-error-name, I prefer an abbreviated err over a non-abbreviated errorbecause the latter is too similar to Error for my taste

• 🔧 unicorn/switch-case-braces – changed – I prefer to avoid braces in case statements rather than enforcing them

➕ Additional standalone ESLint rules

• ⚠️ es-x/no-exponential-operators – disallows the use of the ** operator, as that's in most cases a mistake and one really meant to write *

• ⚠️ import/no-deprecated – disallows the use of explicitly deprecated code (code marked with @deprecated)

• 🛑 import/no-order – enforces a specific ordering of imports

• ⚠️ n/prefer-global/console

• ⚠️ n/prefer-promises/fs

• ⚠️ n/no-process-env

• 🛑 n/no-sync

• 🛑 promise/prefer-await-to-then

• 🛑 sort-destructure-keys/sort-destructure-keys

Extended ESM config

By extending @voxpelli/eslint-config/esm instead of @voxpelli you will get these differences:

🔧 Overrides of rules

• ⚠️ func-style – enforces function declarations whenever an arrow function isn't used. Better to do export function foo () { than export const foo = function () {
• 🛑 unicorn/prefer-module – changed – restored to its plugin:unicorn/recommended value of error

Alternatives

• eslint-config-rainbow by @bcomnes
• semistandard
• standard

See also

• voxpelli/ghatemplates – the templates I use with ghat to update GitHub Actions in my projects
• voxpelli/renovate-config-voxpelli – the shareable Renovate setup I use in my projects
• voxpelli/tsconfig – the shareable tsconfig.json setup I use in my projects