eslint-config-molindo

eslint-config-molindo

Goals

1. Find errors that are detectable with static analysis.
2. Make reading code easier by providing consistent code style.
3. Make writing code faster by leveraging auto fix wherever possible.

Getting started

1. yarn add eslint eslint-config-molindo prettier --dev
2. Setup your project config in eslint.config.mjs:

import {getPresets} from 'eslint-config-molindo';

export default [
  ...(await getPresets(
    // Base config
    'typescript', // or 'javascript'

    // Optional extensions
    'react',
    'cssModules',
    'tailwind',
    'jest',
    'cypress',
    'vitest'
  )),

  {
    // Your custom config
  }
];

1. If you require globals, like browser APIs on window, you can add them to your config:

// eslint.config.mjs
import globals from 'globals';

export default [
  // ...
  {
    languageOptions: {
      globals: {
        ...globals.browser,
        ...globals.node
      }
    }
  }
];

1. To set up Prettier, add to your package.json:

"prettier": "eslint-config-molindo/.prettierrc.json"

1. If you use TypeScript, add to your tsconfig.json:

"extends": "eslint-config-molindo/tsconfig.json"

Happy linting!

Further configuration

CI integration

To validate your code in a CI pipeline, add the following to your package.json:

"scripts": {
  "lint": "eslint src && prettier src --check"
}

VSCode integration

The following two extensions are recommended:

1. dbaeumer.vscode-eslint
2. esbenp.prettier-vscode

To auto-fix errors from ESLint as well as Prettier on save, you can use the following configuration:

// settings.json (VSCode)
{
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": "always"
  },
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.formatOnSave": true
}

Versioning

• Patch releases are for improved documentation, fixing a rule to stop reporting false positives and internal code changes.
• Minor releases are for changes to rules that can automatically be fixed.
• Major releases happen when rules are changed that can't be fixed automatically.

Changelog

8.0.0

Features

• ESLint 9 compatibility.
• Upgraded all plugins.
• eslint-import-resolver-typescript is now used for TypeScript files to configure eslint-plugin-import correctly. This now correctly takes into consideration paths from tsconfig.json when determining ordering of imports.
• New rules from eslint-plugin-unicorn:
  • unicorn/prefer-array-index-of
  • unicorn/prefer-optional-catch-binding
  • unicorn/no-useless-spread
• New rules from @typescript-eslint:
  • @typescript-eslint/prefer-optional-chain
  • @typescript-eslint/no-unnecessary-condition
• New rules from eslint-plugin-import:
  • import/no-useless-path-segments
• Apply TypeScript-specific rules also to .mts, .mtsx, .cts and .ctsx files.
• Add eslint-plugin-unused-imports to remove unused imports during autofix.
• Add vitest rules.
• Enable sort-imports.

Breaking changes

• ESLint 9 is now required (see updated README)
• The ESLint config is intended to be consumed via ESM (e.g. by using eslint.config.mjs)
• Prettier no longer runs via an integrated rule since this is discouraged. Instead, a supplemental Prettier config is now provided (see updated README). To enable prettier checking on CI, you might want to consider adding prettier --check to your CI pipeline.
• The valid-jsdoc rule has been removed since it was removed from ESLint core and is only available via an additional plugin. If you'd like to keep this rule, add eslint-plugin-jsdoc to your project.
• Globals for Cypress are no longer provided out of the box, but should be added explicitly by projects (see predefined global variables).
• The src directory is no longer resolved by default. For TypeScript projects, paths from tsconfig.json are now suggested as the alternative and will be resolved by default. For JavaScript projects, you can add settings: {'import/resolver': {node: {paths: ['node_modules', 'src']}}} to your ESLint config.