ESLint Config Love

Common errors

• Parsing error: 'parserOptions.project' has been set for 'parser'.
  The 'project' of 'parserOptions' was set and now 'parser' needs to be configured with 'project'.

  cause The `eslint-config-love` configuration enables type-aware linting rules which require a `tsconfig.json` to be present and correctly configured.
  fix Ensure a valid `tsconfig.json` file exists in your project's root or specified location, and that the `include` glob covers all files ESLint should process.

• ESLint couldn't find the config "love".

  cause The `eslint-config-love` package is not installed or the `extends` path in `.eslintrc` is incorrect.
  fix Run `npm install --save-dev eslint-config-love` and ensure your ESLint configuration file correctly references `love` in the `extends` array or similar.

• TypeError [ERR_UNKNOWN_FILE_EXTENSION]: Unknown file extension ".cjs" for <path-to-eslint-config-love>/index.js

  cause You are attempting to use `require()` for `eslint-config-love` in a CommonJS context, but the package is ESM-first.
  fix For CommonJS configurations, use a dynamic import: `const { default: love } = await import('eslint-config-love')` inside an `async` function for your ESLint config.

• ESLint: Cannot find module 'eslint' or 'typescript'.

  cause Missing peer dependencies. `eslint-config-love` relies on `eslint` and `typescript` as peer dependencies.
  fix Install the required peer dependencies: `npm install --save-dev eslint typescript`.

Warnings

• breaking This package has an extremely aggressive major version release schedule, with new major versions often released weekly or bi-weekly. Each new version frequently introduces breaking changes, typically by enabling new rules or upgrading underlying ESLint plugins. Users should anticipate needing to adjust their code or ESLint configurations with almost every update. Always review the changelog before upgrading.
  Fix: Always check the release notes and changelog on GitHub for specific migration instructions before upgrading to a new major version.
• breaking Version 153.0.0 introduced breaking changes related to promise handling, specifically enabling `promise/prefer-catch` and updating `eslint-plugin-promise` to `^7.2.0`.
  Fix: Review and refactor promise chains to ensure they always include a `.catch()` or are otherwise handled, and update `eslint-plugin-promise` if managed separately.
• breaking Multiple recent versions have introduced breaking changes due to significant updates to `@typescript-eslint` plugins, enabling new strict TypeScript-specific rules.
  Fix: Review your TypeScript code for new linting errors related to rules like `@typescript-eslint/strict-void-return`, `@typescript-eslint/no-useless-default-assignment`, or `@typescript-eslint/no-unused-private-class-members` and refactor as necessary or disable specific rules if they do not fit your project's needs.
• gotcha The configuration explicitly sets `languageOptions.parserOptions.project = true`, meaning ESLint will require a `tsconfig.json` file in your project to correctly parse and lint TypeScript files, especially for type-aware rules. Without it, you will encounter parsing errors.
  Fix: Ensure you have a `tsconfig.json` file in your project root or configure `parserOptions.project` in your `.eslintrc` to point to your `tsconfig.json` files.

Install

• npm install eslint-config-love npm
• yarn add eslint-config-love yarn
• pnpm add eslint-config-love pnpm

Imports

• love
  wrong:

  import { love } from 'eslint-config-love'

  correct:

  import love from 'eslint-config-love'

  The configuration object is exported as the default in an ESM environment.
• love
  wrong:

  const love = require('eslint-config-love')

  correct:

  const { default: love } = await import('eslint-config-love')

  For CommonJS, dynamic `import()` is required to load the ESM-first package; direct `require()` will not work.

Quickstart

This quickstart shows how to configure ESLint in a CommonJS project using dynamic import and provides a basic tsconfig.json necessary for the configuration's type-aware rules.

// .eslintrc.cjs (for CommonJS projects)
module.exports = (async function config() {
  const { default: love } = await import('eslint-config-love')

  return [
    {
      ...love,
      files: ['**/*.js', '**/*.ts', '**/*.jsx', '**/*.tsx'],
    },
  ]
})()

// tsconfig.json (required for TypeScript rules utilizing type information)
{
  "compilerOptions": {
    "target": "ESNext",
    "module": "ESNext",
    "lib": ["ESNext"],
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "isolatedModules": true,
    // ... other compiler options
  },
  "include": ["src/**/*.ts", "src/**/*.tsx", "src/**/*.js", "src/**/*.jsx"],
  "exclude": ["node_modules"]
}