chore(models): fix ESLint issues, enable all rules

Author: Tlacenka

packages/models/.eslintrc.json

@@ -1,22 +1,28 @@
 {
-  "extends": ["./code-pushup.eslintrc.json"],
-  // temporarily disable failing rules so `nx lint` passes
-  // number of errors/warnings per rule recorded at Tue Nov 28 2023 15:38:24 GMT+0100 (Central European Standard Time)
-  "rules": {
-    "arrow-body-style": "off", // 3 warnings
-    "no-magic-numbers": "off", // 4 warnings
-    "no-param-reassign": "off", // 1 error
-    "@typescript-eslint/no-shadow": "off", // 10 warnings
-    "@typescript-eslint/no-unnecessary-condition": "off", // 7 warnings
-    "@typescript-eslint/no-unsafe-argument": "off", // 2 errors
-    "@typescript-eslint/no-unsafe-call": "off", // 1 error
-    "@typescript-eslint/prefer-nullish-coalescing": "off", // 2 warnings
-    "functional/immutable-data": "off", // 2 errors, 22 warnings
-    "functional/no-let": "off", // 1 warning
-    "unicorn/better-regex": "off", // 1 warning
-    "unicorn/explicit-length-check": "off", // 1 warning
-    "unicorn/numeric-separators-style": "off", // 1 warning
-    "unicorn/prefer-logical-operator-over-ternary": "off", // 1 warning
-    "unicorn/prefer-spread": "off" // 1 warning
-  }
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "parserOptions": {
+        "project": ["packages/models/tsconfig.*?.json"]
+      },
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.json"],
+      "parser": "jsonc-eslint-parser",
+      "rules": {
+        "@nx/dependency-checks": ["error"]
+      }
+    }
+  ]
 }

packages/models/code-pushup.eslintrc.json

@@ -90,7 +90,7 @@ export function metaSchema(options?: {
     titleDescription,
     docsUrlDescription,
     description,
-  } = options || {};
+  } = options ?? {};
   return z.object(
     {
       title: titleSchema(titleDescription),

packages/models/src/lib/implementation/schemas.ts

@@ -8,7 +8,7 @@ import type { PluginReport } from '../report';
  * - category (e.g. 'performance')
  * Also validates ``and ` `
  */
-export const slugRegex = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
+export const slugRegex = /^[a-z\d]+(?:-[a-z\d]+)*$/;
 
 /**
  * Regular expression to validate a filename.
@@ -21,14 +21,12 @@ export const filenameRegex = /^(?!.*[ \\/:*?"<>|]).+$/;
  * @param strings
  */
 export function hasDuplicateStrings(strings: string[]): string[] | false {
-  const uniqueStrings = Array.from(new Set(strings));
-  const duplicatedStrings = strings.filter(
-    (
-      i => v =>
-        uniqueStrings[i] !== v || !++i
-    )(0),
+  const sortedStrings = [...strings].sort();
+  const duplStrings = sortedStrings.filter(
+    (item, index) => index !== 0 && item === sortedStrings[index - 1],
   );
-  return duplicatedStrings.length === 0 ? false : duplicatedStrings;
+
+  return duplStrings.length === 0 ? false : [...new Set(duplStrings)];
 }
 
 /**
@@ -50,10 +48,9 @@ export function hasMissingStrings(
  */
 export function errorItems(
   items: string[] | false,
-  transform: (items: string[]) => string = items => items.join(', '),
+  transform: (itemArr: string[]) => string = itemArr => itemArr.join(', '),
 ): string {
-  const paredItems = items ? items : [];
-  return transform(paredItems);
+  return transform(items || []);
 }
 
 export function exists<T>(value: T): value is NonNullable<T> {
@@ -70,46 +67,39 @@ export function getMissingRefsForCategories(
   categories: CategoryConfig[],
   plugins: PluginConfig[] | PluginReport[],
 ) {
-  const missingRefs: string[] = [];
   const auditRefsFromCategory = categories.flatMap(({ refs }) =>
     refs
       .filter(({ type }) => type === 'audit')
       .map(({ plugin, slug }) => `${plugin}/${slug}`),
   );
-  const auditRefsFromPlugins = plugins.flatMap(
-    ({ audits, slug: pluginSlug }) => {
-      return audits.map(({ slug }) => `${pluginSlug}/${slug}`);
-    },
+  const auditRefsFromPlugins = plugins.flatMap(({ audits, slug: pluginSlug }) =>
+    audits.map(({ slug }) => `${pluginSlug}/${slug}`),
   );
   const missingAuditRefs = hasMissingStrings(
     auditRefsFromCategory,
     auditRefsFromPlugins,
   );
 
-  if (Array.isArray(missingAuditRefs) && missingAuditRefs.length > 0) {
-    missingRefs.push(...missingAuditRefs);
-  }
   const groupRefsFromCategory = categories.flatMap(({ refs }) =>
     refs
       .filter(({ type }) => type === 'group')
       .map(({ plugin, slug }) => `${plugin}#${slug} (group)`),
   );
-  const groupRefsFromPlugins = plugins.flatMap(
-    ({ groups, slug: pluginSlug }) => {
-      return Array.isArray(groups)
-        ? groups.map(({ slug }) => `${pluginSlug}#${slug} (group)`)
-        : [];
-    },
+  const groupRefsFromPlugins = plugins.flatMap(({ groups, slug: pluginSlug }) =>
+    Array.isArray(groups)
+      ? groups.map(({ slug }) => `${pluginSlug}#${slug} (group)`)
+      : [],
   );
   const missingGroupRefs = hasMissingStrings(
     groupRefsFromCategory,
     groupRefsFromPlugins,
   );
-  if (Array.isArray(missingGroupRefs) && missingGroupRefs.length > 0) {
-    missingRefs.push(...missingGroupRefs);
-  }
 
-  return missingRefs.length ? missingRefs : false;
+  const missingRefs = [missingAuditRefs, missingGroupRefs]
+    .filter((refs): refs is string[] => Array.isArray(refs) && refs.length > 0)
+    .flat();
+
+  return missingRefs.length > 0 ? missingRefs : false;
 }
 export function missingRefsForCategoriesErrorMsg(
   categories: CategoryConfig[],

packages/models/src/lib/implementation/utils.ts

@@ -68,6 +68,10 @@ describe('hasDuplicateStrings', () => {
     expect(hasDuplicateStrings(['a', 'b', 'a', 'c'])).toEqual(['a']);
   });
 
+  it('should return a duplicate only once', () => {
+    expect(hasDuplicateStrings(['a', 'b', 'a', 'a'])).toEqual(['a']);
+  });
+
   it('should return false for a list with 1 item', () => {
     expect(hasDuplicateStrings(['a'])).toBe(false);
   });