My personal ESLint config – a superset of the neostandard base config that I co-created and co-maintain.

This config contains a couple of more opinionated checks that I find helpful in my projects.

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

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

Add an eslint.config.js (or eslint.config.mjs if your project is CJS) that exports this config:

export { default } from '@voxpelli/eslint-config';

If you need to configure something, instead do:

import { voxpelli } from '@voxpelli/eslint-config';

export default voxpelli({
  cjs: true,     // Ensures the config has rules fit for a CJS context rather than an ESM context
  noMocha: true, // By standard this config expects tests to be of the Mocha kind, but one can opt out
});

You can also do custom extensions:

import { voxpelli } from '@voxpelli/eslint-config';

export default [
  ...voxpelli({
    // Config options
  }),
  {
    // Custom ESLint config
  },
];

• 🛑 = changed to error level
• ⚠️ = changed to warn level
• 🔇 = deactivated
• 🔧 = changed config

• 🔧 @stylistic/comma-dangle – changed – set to enforce dangling commas in arrays, objects, imports and exports
• 🔧 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

• ⚠️ 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

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

• 🔇 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 combined with type checking 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

• 🛑 @stylistic/quote-props – requires properties to be quoted when needed but otherwise disallows it

• ⚠️ 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 *

• ⚠️ 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

• 🛑 unicorn/consistent-destructuring – while unicorn dropped it from their recommended config I still like it, see #283

Unless one configures cjs: true these additional rules will be applied:

• ⚠️ 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

You may want to use neostandard instead, it's the general base config that I help maintain for the community.

I do maintain this project though as if multiple people are using it, so sure, you can use it, but its ultimate purpose is to support my projects.

I do follow semantic versioning, so the addition or tightening of any checks will trigger major releases whereas minor and patch releases should only ever have relaxation of rules and bug fixes.

• neostandard
• xo

• 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