chore: migrate eslint config to flat format #4887

jdegand · 2025-07-16T18:15:42Z

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our guidelines: https://github.com/ngrx/platform/blob/main/CONTRIBUTING.md#commit
Tests for the changes have been added (for bug fixes / features)
Documentation has been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

Change to ESLint flat config.

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[x] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Outdated ESLint configuration. Failing lint command in package.json.

Closes #4883

What is the new behavior?

ESLint works with lint command.

Does this PR introduce a breaking change?

[ ] Yes
[X] No

Other information

There are quite a few lint tests failing.

netlify · 2025-07-16T18:15:51Z

✅ Deploy Preview for ngrx-site-v19 ready!

Name	Link
🔨 Latest commit	`825948e`
🔍 Latest deploy log	https://app.netlify.com/projects/ngrx-site-v19/deploys/6897f5504a5f0000081db740
😎 Deploy Preview	https://deploy-preview-4887--ngrx-site-v19.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

netlify · 2025-07-16T18:16:12Z

✅ Deploy Preview for ngrx-io canceled.

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`825948e`
🔍 Latest deploy log	https://app.netlify.com/projects/ngrx-io/deploys/6897f5501a3a3e000860e350

timdeschryver

The migration looks good.
Can you look at the lint errors please to make the build pass?

eslint.config.mjs

This reverts commit 6764780.

timdeschryver · 2025-08-04T13:17:44Z

@jdegand there seem to be some linting issues.
Are you planning to take a look at them?

jdegand · 2025-08-04T23:40:42Z

@timdeschryver I think some issues stem from this in the config files:

parserOptions: {
          project: ['modules/effects/testing/tsconfig.*?.json'],
},

There are issues resolving file paths. I going to try tweaking this first.

Changing the wildcard helped 3 more lints pass.

jdegand · 2025-08-05T01:44:49Z

Using

import baseConfig from '../../eslint.config.mjs';
import typescriptEslintEslintPlugin from '@typescript-eslint/eslint-plugin';
import cypressPlugin from 'eslint-plugin-cypress';

export default [
  {
    ignores: ['**/dist'],
  },
  ...baseConfig,

  {
    plugins: {
      '@typescript-eslint': typescriptEslintEslintPlugin,
      cypress: cypressPlugin,
    },
  },
  {
    rules: {},
  },
  {
    files: ['**/*.ts', '**/*.tsx', '**/*.js', '**/*.jsx'],
    rules: {},
    languageOptions: {
      parserOptions: {
        project: 'projects/example-app-e2e/tsconfig.*.json',
      },
    },
  },
  {
    files: ['src/plugins/index.js'],
    rules: {
      '@typescript-eslint/no-var-requires': 'off',
      'no-undef': 'off',
    },
  },
  {
    ignores: ['schematics-core'],
  },

  // ✅ Cypress E2E overrides
  {
    files: ['src/**/*.cy.{ts,tsx}'],
    plugins: {
      cypress: cypressPlugin,
    },
    languageOptions: {
      parserOptions: {
        project: null,
      },
    },
    rules: {},
  },
];

for the standalone and example app and not using FlatCompat at all works. FlatCompat has potential incompatibilities. I have tried extending the recommended config and ignoring name to no avail. Also, there is a potential issue with a missing @types/cypress dependency in the tsconfig.json. This causes a warning, but no real difference. The types can be included or deleted.

jdegand · 2025-08-05T17:11:44Z

There seem to be inconsistencies between the results of CI tests and what I get in a GitHub codespace. I am getting more lint successes in a GitHub codespace. If high CPU usage happens in the codespace, results seem to become unreliable.

timdeschryver · 2025-08-05T17:40:51Z

@jdegand the cypress plugin will be removed in #4891.
It's ok to just remove it here as well if that makes it easier.

jdegand · 2025-08-05T23:43:07Z

Now, I think the question mark after the wildcard didn't make a difference (modules/effects/testing/tsconfig.*?.json).
ngrx.io config has the *? syntax and still works. Let me know a preference and this can be changed.

Running pnpm lint causes high CPU usage in the codespace and then things become unreliable. It is better to lint a few projects separately (npx nx run store:lint, etc) so a few cached values help performance of the codespace.

I changed the two e2e configs so the cypress-plugin can be removed.

jdegand · 2025-08-07T17:28:33Z

projects/www/src/app/pages/guide/data/entity-metadata.md got added to the PR after merging main? It is incorrectly formatted, but it still made it pass the husky lint?

markostanimirovic · 2025-08-09T23:59:08Z

modules/store/tsconfig.build.json

+    "paths": {
+      "@ngrx/store": ["src"]
+    },


is this change required?

This was part of my debugging (this is just helping to point to the correct files to lint) and it's not necessary. Looks like the only file I did this in.

markostanimirovic · 2025-08-09T23:59:22Z

nx.json

@@ -92,7 +92,8 @@
      "!{projectRoot}/tsconfig.spec.json",
      "!{projectRoot}/jest.config.[jt]s",
      "!{projectRoot}/.eslintrc.json",


it seems this line can be removed

Actually, there is a leftover eslintrc.json file in the projects/www folder. Because it uses analog, I guess the nx script skipped converting it automatically. I guess this can be converted as well.

I've had some issues getting this working perfectly, but it looks there will be extra lint errors that need to be fixed inside the www folder.

The new style guide generated quite a few errors.

I don't know if you want this included into this PR or a separate PR. I created another branch to work on and implemented fixes there. I can easily do whatever you prefer. Although it does clutter the PR, I did remove standalone:true from a lot of components in the www folder (might as well do it now).

markostanimirovic · 2025-08-10T00:01:08Z

projects/www/src/app/pages/guide/data/entity-metadata.md

-  return PropsFilterFnFactory<Villain>[('name', 'saying')](
-    entities,
-    pattern
+  return (
+    PropsFilterFnFactory <
+    Villain >
+    [('name', 'saying')](entities, pattern)


can you revert this change?

I used no-verify to revert the file.

timdeschryver · 2025-08-10T18:20:39Z

modules/component-store/eslint.config.mjs

+
+export default [
+  {
+    ignores: ['**/dist', '**/jest.config.ts', '**/schematics-core/test-setup.ts', '**/schematics-core/utility/standalone.ts'],


Is it possible to add this to the base config and remove it in the module specific configs?

In the base config:

ignores: ['**/dist', '**/jest.config.ts', '**/schematics-core'],

I don't remember why we excluded these, this can be looked into later.

All the exclusions were added to match previous files. The lints fail without them.

Potential option is to add .eslintignore files and add the files there.

In base config, could add an overrides array like this:

overrides: [ { files: ['**/jest.config.ts'], env: { node: true }, rules: { // customize rules for config files }, }, { files: ['**/schematics-core/**/*.ts'], env: { node: true }, rules: { // loosen rules or add globals as needed }, }, ],

Typically, files are ignored if they use "globals" or unusual patterns that could break if linted. Code that uses TypeScript AST, Node.js (node vs web environments), and schematics is also typically ignored. That standalone utility looks a stop-gap or bridge file and may be something that could potentially be removed as bootstrapApplication can make standalone components.

jdegand added 3 commits July 15, 2025 18:46

feat: replace eslintrc.json files

1254db9

fix: remove reference to eslintrc.json in nx.json

5661c1e

feat(package.json): change lint command

727cb96

timdeschryver reviewed Jul 17, 2025

View reviewed changes

eslint.config.mjs Show resolved Hide resolved

jdegand added 2 commits July 17, 2025 18:30

chore(eslint): add ts-check to config files

6764780

Revert "chore(eslint): add ts-check to config files"

e8d26e3

This reverts commit 6764780.

timdeschryver added the Needs Cleanup Review changes needed label Aug 4, 2025

jdegand added 2 commits August 4, 2025 23:59

fix: change wildcard in parserOptions

15a5c96

fix: cypress config in example-app

441378f

jdegand added 2 commits August 5, 2025 01:50

refactor: cypress configs

30f9b8f

fix: effects config project file path

8671a5a

jdegand added 9 commits August 5, 2025 17:58

fix: exclude files for data config

4fa1936

fix: exclude jest in configs

f20590c

fix(entity): exclude standalone

3e5cb40

fix: component-store, component, and potentially router-store

3595758

fix: exclude test-setup in router-store

89b5d53

fix: exclude jest in store config

0427dd6

fix: exclude module boundaries

9baba88

fix: remove references to store in effects config

59d187f

fix: remove cypress plugin from configs

70c6a30

jdegand added 2 commits August 7, 2025 01:21

chore: merge main

a0ecfb4

fix: pnpm-lock

4b12129

jdegand requested a review from timdeschryver August 7, 2025 01:46

markostanimirovic removed the Needs Cleanup Review changes needed label Aug 9, 2025

markostanimirovic reviewed Aug 10, 2025

View reviewed changes

markostanimirovic changed the title ~~chore(eslint): migrate config to flat format~~ chore: migrate eslint config to flat format Aug 10, 2025

jdegand added 2 commits August 10, 2025 00:50

revert: md file

49757c0

fix: tsconfig in store

825948e

timdeschryver reviewed Aug 10, 2025

View reviewed changes

Uh oh!

chore: migrate eslint config to flat format #4887

Are you sure you want to change the base?

chore: migrate eslint config to flat format #4887

Conversation

jdegand commented Jul 16, 2025

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

Uh oh!

netlify bot commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for ngrx-site-v19 ready!

Uh oh!

netlify bot commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for ngrx-io canceled.

Uh oh!

timdeschryver left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

timdeschryver commented Aug 4, 2025

Uh oh!

jdegand commented Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jdegand commented Aug 5, 2025

Uh oh!

jdegand commented Aug 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

timdeschryver commented Aug 5, 2025

Uh oh!

jdegand commented Aug 5, 2025

Uh oh!

jdegand commented Aug 7, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jdegand Aug 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jdegand Aug 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

timdeschryver Aug 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jdegand Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

netlify bot commented Jul 16, 2025 •

edited

Loading

netlify bot commented Jul 16, 2025 •

edited

Loading

jdegand commented Aug 4, 2025 •

edited

Loading

jdegand commented Aug 5, 2025 •

edited

Loading

jdegand Aug 10, 2025 •

edited

Loading

jdegand Aug 10, 2025 •

edited

Loading

timdeschryver Aug 10, 2025 •

edited

Loading

jdegand Aug 11, 2025 •

edited

Loading