ESLint plugin cannot be used in none type-aware environment

[muuvmuuv]

Which @ngrx/* package(s) are the source of the bug?

eslint-plugin

Minimal reproduction of the bug/regression with instructions

https://github.com/ngrx/platform/blob/main/modules/eslint-plugin/src/configs/signals.ts#L29

We aren't using type-aware-linting and have a monorepo setup with "references", therefore we cannot import the eslint-plugin because it will throw:

Parsing error: ESLint was configured to run on `<tsconfigRootDir>/src/toast/toast-config.ts` using `parserOptions.project`: <tsconfigRootDir>/tsconfig.json
That TSConfig uses project "references" and doesn't include `<tsconfigRootDir>/src/toast/toast-config.ts` directly, which is not supported by `parserOptions.project`.
Either:
- Switch to `parserOptions.projectService`
- Use an ESLint-specific TSConfig
See the typescript-eslint docs for more info: https://typescript-eslint.io/troubleshooting/typed-linting#are-typescript-project-references-supported (eslint)

Expected behavior

Provide two eslint configs with and without type-information configurations.

Versions of NgRx, Angular, Node, affected browser(s) and operating system(s)

All latest on macOS

Other information

No response

I would be willing to submit a PR to fix this issue

• Yes
• No

[timdeschryver]

Do you have a reproduction of this issue?

[muuvmuuv]

Tried to repr it but I get another error here : https://stackblitz.com/edit/stackblitz-starters-xaetfedb?description=An%20angular-cli%20project%20based%20on%20@angular/animations,%20@angular/common,%20@angular/compiler,%20@angular/core,%20@angular/forms,%20@angular/platform-browser,%20@angular/platform-browser-dynamic,%20@angular/router,%20core-js,%20rxjs,%20tslib%20and%20zone.js&file=apps%2Fapp%2Fpackage.json,package.json,apps%2Fapp%2Feslint.config.js%3AL32,apps%2Fapp%2Fsrc%2Fmain.ts&template=node&title=Angular%20Starter

You need to run: npm run -w app lint

Removing ngrx-eslint prints the expected error from angular-eslint. Any idea?

[timdeschryver]

Thanks @muuvmuuv !
For now, you can override the settings by:

• disabling the specific rules that require type information
• or keep them enabled, and use projectService (I think this will be used in our future config settings) or project to set the path to the tsconfig file. For more information see https://typescript-eslint.io/blog/project-service

Because the project has multiple tsconfigs, you will need to add a reference to the correct tsconfig, in this case this is resolved by adding the following to the eslint config.

    languageOptions: {
      globals: {
        ...globals.browser,
      },

      parserOptions: {
        // projectService: true,
        project: './tsconfig.app.json',
      },
    },

[muuvmuuv]

I have already tried disabling that rule but unfortunately that does not help because the ngrx config sets the parser options which are not compatible with our monorepo constellation, hence the error. I will try overriding the parserOptions.

[muuvmuuv]

Ok, this way it works:

			parserOptions: {
				projectService: false,
				project: false,
			},
		},
		rules: {
			'@ngrx/avoid-cyclic-effects': 'off', // requires type information
			'@ngrx/no-multiple-actions-in-effects': 'off', // requires type information
			'@ngrx/with-state-no-arrays-at-root-level': 'off', // requires type information