@ebarooni/angular-eslint-config

Shared ESLint configuration for Angular projects.

Installation

npm i -D @ebarooni/angular-eslint-config @eslint/js angular-eslint eslint eslint-config-prettier typescript typescript-eslint

Compatibility

Supported versions: angular-eslint 22, ESLint 10, @eslint/js 10, eslint-config-prettier 10, TypeScript 6.0, and typescript-eslint 8.58.

Node.js in .nvmrc is 24.22.2. The engines field allows Node.js ^22.22.3, ^24.15.0, or >=26.0.0.

Use 1.x for Angular 18-21 / TypeScript 5.

Setup

Create eslint.config.mjs in the Angular project:

import defineEslintConfig from "@ebarooni/angular-eslint-config";

export default defineEslintConfig({
  tsconfigRootDir: import.meta.dirname,
});

defineEslintConfig() with no arguments also works. The config uses the TypeScript project service. The config ignores .angular/, dist/ and coverage/.

Pass extra config objects after the options object.

Usage

npx eslint
npx eslint --fix

Test project

The test directory is a small Angular 22 app. It uses this package.

npm run test at the root builds this package, installs that app, and runs ESLint there. It does not call the scripts below. npm run lint in test runs the same ESLint command. The lint result is the same.

Build this package before you lint the test app. The package entry is dist. dist is not in git.

An old dist from 1.0 causes Config (unnamed): Unexpected key "tsconfigRootDir". The 1.0 function puts the options object into the ESLint config. That object has tsconfigRootDir at the top level. Run npm run build. The 2.0 file puts the key under languageOptions.parserOptions. npm run test checks that placement.

npm ci
npm run build
cd test
npm ci
npm run lint
npm run format:check
npm run format

npm run format writes Prettier changes. npm run format:check only checks them. The root package has the same format and format:check scripts.

Migration to 2.0.0

2.0.0 uses ESLint 10. It does not support ESLint 9.

2.0.0 changes the call.

Old call:

import defineEslintConfig from "@ebarooni/angular-eslint-config";

export default defineEslintConfig([
  {
    languageOptions: {
      parserOptions: {
        project: ["tsconfig.eslint.json"],
        tsconfigRootDir: import.meta.dirname,
      },
    },
  },
]);

New call:

import defineEslintConfig from "@ebarooni/angular-eslint-config";

export default defineEslintConfig({
  tsconfigRootDir: import.meta.dirname,
});

The old array call throws. Pass an options object.

Delete tsconfig.eslint.json when no other file uses it.

2.0.0 also enables these rules. They report errors in existing code:

• @angular-eslint/prefer-on-push-component-change-detection with allowExplicitOnPush: false. An explicit ChangeDetectionStrategy.OnPush is an error. The rule can remove it.
• @angular-eslint/no-uncalled-signals
• @angular-eslint/prefer-signals
• @angular-eslint/prefer-output-readonly
• @angular-eslint/template/prefer-ngsrc
• @angular-eslint/template/no-duplicate-attributes
• @angular-eslint/template/button-has-type

This package is ESM only. It does not ship a CommonJS build. Use import. require() returns a module object, not the function.