fix(eslint-plugin): include signals to ESLint v8 rules (#4387)

Closes #4385

Author: timdeschryver

.eslintrc.json

@@ -26,15 +26,13 @@
       "files": ["*.ts", "*.tsx"],
       "extends": ["plugin:@nx/typescript"],
       "rules": {
-        "@typescript-eslint/no-extra-semi": "error",
         "no-extra-semi": "off"
       }
     },
     {
       "files": ["*.js", "*.jsx"],
       "extends": ["plugin:@nx/javascript"],
       "rules": {
-        "@typescript-eslint/no-extra-semi": "error",
         "no-extra-semi": "off"
       }
     },
@@ -54,6 +52,7 @@
         "@typescript-eslint/prefer-namespace-keyword": "error",
         "@typescript-eslint/ban-types": "warn",
         "@typescript-eslint/no-empty-function": "warn",
+        "@typescript-eslint/no-empty-object-type": "warn",
         "eqeqeq": ["off", "smart"],
         "id-blacklist": [
           "error",

modules/data/src/utils/default-logger.ts

@@ -5,19 +5,31 @@ import { Logger } from './interfaces';
 export class DefaultLogger implements Logger {
   error(message?: any, extra?: any) {
     if (message) {
-      extra ? console.error(message, extra) : console.error(message);
+      if (extra) {
+        console.error(message, extra);
+      } else {
+        console.error(message);
+      }
     }
   }
 
   log(message?: any, extra?: any) {
     if (message) {
-      extra ? console.log(message, extra) : console.log(message);
+      if (extra) {
+        console.log(message, extra);
+      } else {
+        console.log(message);
+      }
     }
   }
 
   warn(message?: any, extra?: any) {
     if (message) {
-      extra ? console.warn(message, extra) : console.warn(message);
+      if (extra) {
+        console.warn(message, extra);
+      } else {
+        console.warn(message);
+      }
     }
   }
 }

modules/entity/spec/fixtures/book.ts

@@ -1,4 +1,4 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
+// eslint-disable-next-line @typescript-eslint/no-var-requires,@typescript-eslint/no-require-imports
 const deepFreeze = require('deep-freeze');
 
 export interface BookModel {

modules/eslint-plugin/package.json

@@ -45,6 +45,7 @@
   },
   "peerDependencies": {
     "eslint": "^8.57.0 || ^9.0.0",
+    "@typescript-eslint/utils": "^7.11.0 || ^8.0.0-alpha.20",
     "typescript": "*"
   }
 }

modules/eslint-plugin/scripts/generate-config.ts

@@ -39,7 +39,7 @@ function writeConfig(
     },
     {}
   );
-  const parserOptions: null | Record<string, string | number> =
+  const requireParserOptions: null | Record<string, string | number> =
     rulesForConfig.some(([_, rule]) => rule.meta.docs?.requiresTypeChecking)
       ? {
           ecmaVersion: 2020,
@@ -75,8 +75,12 @@ function writeConfig(
         languageOptions: {
           parser,
           ${
-            parserOptions
-              ? `parserOptions: ${JSON.stringify(parserOptions, null, 2)},`
+            requireParserOptions
+              ? `parserOptions: ${JSON.stringify(
+                  requireParserOptions,
+                  null,
+                  2
+                )},`
               : ''
           }
         },
@@ -94,7 +98,7 @@ function writeConfig(
     plugins: ['@ngrx'],
     rules: configRules,
   };
-  if (configName.includes('all')) {
+  if (requireParserOptions) {
     jsonConfig.parserOptions = {
       ecmaVersion: 2020,
       sourceType: 'module',

modules/eslint-plugin/spec/exported-rules.spec.ts

@@ -0,0 +1,39 @@
+import * as path from 'path';
+import * as lib from '../src/rules';
+import { traverseFolder } from '../src/utils';
+import { configs } from '../v9';
+
+const rulesDirectory = path.join(__dirname, '../src/rules');
+const configsDirectory = path.join(__dirname, '../src/configs');
+
+function getAllRules() {
+  return [...traverseFolder(rulesDirectory, ['.ts'])]
+    .map((rule) => rule.file)
+    .filter((rule) => rule !== 'index');
+}
+function getAllConfigs() {
+  return [...traverseFolder(configsDirectory, ['.ts'])];
+}
+
+describe('ESLint V8', () => {
+  test('exports all rules', () => {
+    const rules = getAllRules();
+    expect(Object.keys(lib.rules).length).toBe(rules.length);
+  });
+  test('exports all configurations', () => {
+    const configs = getAllConfigs();
+    expect(configs.length).toBe(6);
+  });
+});
+
+describe('ESLint V9', () => {
+  test('exports all rules ', () => {
+    const rules = getAllRules();
+    expect(Object.keys((configs.all[1] as any).rules).length).toBe(
+      rules.length
+    );
+  });
+  test('exports all configurations', () => {
+    expect(Object.keys(configs).length).toBe(6);
+  });
+});

modules/eslint-plugin/src/configs/effects.json

@@ -9,5 +9,10 @@
     "@ngrx/prefer-action-creator-in-of-type": "error",
     "@ngrx/prefer-effect-callback-in-block-statement": "error",
     "@ngrx/use-effects-lifecycle-interface": "error"
+  },
+  "parserOptions": {
+    "ecmaVersion": 2020,
+    "sourceType": "module",
+    "project": "./tsconfig.json"
   }
 }

modules/eslint-plugin/src/configs/signals.json

@@ -4,5 +4,10 @@
   "rules": {
     "@ngrx/signal-state-no-arrays-at-root-level": "error",
     "@ngrx/with-state-no-arrays-at-root-level": "error"
+  },
+  "parserOptions": {
+    "ecmaVersion": 2020,
+    "sourceType": "module",
+    "project": "./tsconfig.json"
   }
 }

modules/eslint-plugin/src/rule-creator.ts

@@ -14,7 +14,7 @@ type CreateRuleMeta<
   TMessageIds extends string,
   TOptions extends readonly unknown[]
 > = {
-  docs: Omit<TSESLint.RuleMetaDataDocs<TOptions>, 'url'> & {
+  docs: Omit<TSESLint.RuleMetaDataDocs, 'url'> & {
     requiresTypeChecking?: boolean;
   };
 } & Omit<Meta<TMessageIds, TOptions>, 'docs'>;

modules/eslint-plugin/src/rules/index.ts

@@ -31,6 +31,8 @@ import selectStyle from './store/select-style';
 import useConsistentGlobalStoreName from './store/use-consistent-global-store-name';
 // operators
 import preferConcatLatestFrom from './operators/prefer-concat-latest-from';
+import signalStateNoArraysAtRootLevel from './signals/signal-state-no-arrays-at-root-level';
+import withStateNoArraysAtRootLevel from './signals/with-state-no-arrays-at-root-level';
 
 export const rules = {
   // component-store
@@ -71,4 +73,7 @@ export const rules = {
   'use-consistent-global-store-name': useConsistentGlobalStoreName,
   // operators
   'prefer-concat-latest-from': preferConcatLatestFrom,
+  // signals
+  'signal-state-no-arrays-at-root-level': signalStateNoArraysAtRootLevel,
+  'with-state-no-arrays-at-root-level': withStateNoArraysAtRootLevel,
 };