refactor: migrate to latest prettier

vmasek · vmasek · commit b472450deac3 · 2024-10-18T11:52:49.000+02:00
Signed-off-by: Vojtech Masek &lt;vojtech@flowup.cz&gt;
diff --git a/.prettierrc b/.prettierrc
@@ -2,6 +2,7 @@
   "singleQuote": true,
   "arrowParens": "avoid",
   "trailingComma": "all",
+  "plugins": ["@trivago/prettier-plugin-sort-imports"],
   "importOrder": [
     "^@code-pushup/portal-client$",
     "^@code-pushup/(.*)$",
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -16,11 +16,11 @@ npm install
 
 This table provides a quick overview of the environmental setup, with detailed explanations in the corresponding sections.
 
-| Feature                          | Local Default | CI Default         | Description                                                                                                                   |
-| -------------------------------- | ------------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
-| `env.INCLUDE_SLOW_TESTS` **❗️** | `false`       | `true`             | Controls inclusion of long-running tests. Overridden by setting. Details in the [Testing](#Testing) section.                  |
-| `env.CUSTOM_CHROME_PATH`         | N/A           | Windows **❗️❗️** | Path to Chrome executable. See [plugin-lighthouse/CONTRIBUTING.md](./packages/plugin-lighthouse/CONTRIBUTING.md#chrome-path). |
-| Quality Pipeline                 | Off           | On                 | Runs all plugins against the codebase.                                                                                        |
+| Feature                         | Local Default | CI Default       | Description                                                                                                                   |
+| ------------------------------- | ------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------- |
+| `env.INCLUDE_SLOW_TESTS` **❗️** | `false`       | `true`           | Controls inclusion of long-running tests. Overridden by setting. Details in the [Testing](#Testing) section.                  |
+| `env.CUSTOM_CHROME_PATH`        | N/A           | Windows **❗️❗️** | Path to Chrome executable. See [plugin-lighthouse/CONTRIBUTING.md](./packages/plugin-lighthouse/CONTRIBUTING.md#chrome-path). |
+| Quality Pipeline                | Off           | On               | Runs all plugins against the codebase.                                                                                        |
 
 **❗️** Test Inclusion Logic
 
diff --git a/docs/e2e.md b/docs/e2e.md
@@ -102,7 +102,7 @@ Root/
 // nx.json
 {
   // ...
-  "plugins": ["tools/src/npm/npm.plugin.ts", "tools/src/publish/publish.plugin.ts", "tools/src/verdaccio/verdaccio.plugin.ts"]
+  "plugins": ["tools/src/npm/npm.plugin.ts", "tools/src/publish/publish.plugin.ts", "tools/src/verdaccio/verdaccio.plugin.ts"],
 }
 ```
 
@@ -115,10 +115,10 @@ Root/
     "e2e": {
       "executor": "@nx/vite:test",
       "options": {
-        "configFile": "e2e/<project-name>-e2e/vite.config.e2e.ts"
-      }
-    }
-  }
+        "configFile": "e2e/<project-name>-e2e/vite.config.e2e.ts",
+      },
+    },
+  },
 }
 ```
 
diff --git a/e2e/cli-e2e/tests/collect.e2e.test.ts b/e2e/cli-e2e/tests/collect.e2e.test.ts
@@ -32,7 +32,7 @@ describe('CLI collect', () => {
       audits: audits.map(
         pluginReport.slug === 'lighthouse' ? omitVariableAuditData : p => p,
       ) as AuditReport[],
-    } as PluginReport);
+    }) as PluginReport;
   const omitVariableReportData = ({
     commit,
     date,
diff --git a/examples/react-todos-app/index.html b/examples/react-todos-app/index.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
   <head>
     <meta charset="utf-8" />
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -67,7 +67,7 @@
     "@swc/core": "^1.3.99",
     "@testing-library/jest-dom": "^6.4.2",
     "@testing-library/react": "^14.0.0",
-    "@trivago/prettier-plugin-sort-imports": "^4.2.0",
+    "@trivago/prettier-plugin-sort-imports": "^4.3.0",
     "@types/benchmark": "^2.1.5",
     "@types/debug": "^4.1.12",
     "@types/eslint": "^8.44.2",
@@ -106,7 +106,7 @@
     "knip": "^5.9.4",
     "memfs": "^4.5.0",
     "moment": "^2.29.4",
-    "prettier": "^2.6.2",
+    "prettier": "^3.3.3",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "tsconfig-paths": "^4.2.0",
diff --git a/packages/cli/src/lib/implementation/core-config.integration.test.ts b/packages/cli/src/lib/implementation/core-config.integration.test.ts
@@ -38,14 +38,14 @@ vi.mock('@code-pushup/core', async () => {
       return filepath.includes('all-persist-options')
         ? allPersistOptions
         : filepath.includes('persist-only-filename')
-        ? persistOnlyFilename
-        : filepath.includes('no-persist')
-        ? noPersist
-        : filepath.includes('no-category')
-        ? noCategory
-        : filepath.includes('no-upload')
-        ? noUpload
-        : CORE_CONFIG_MOCK;
+          ? persistOnlyFilename
+          : filepath.includes('no-persist')
+            ? noPersist
+            : filepath.includes('no-category')
+              ? noCategory
+              : filepath.includes('no-upload')
+                ? noUpload
+                : CORE_CONFIG_MOCK;
     }),
   };
 });
diff --git a/packages/cli/src/lib/implementation/global.utils.ts b/packages/cli/src/lib/implementation/global.utils.ts
@@ -13,11 +13,11 @@ export function filterKebabCaseKeys<T extends Record<string, unknown>>(
         (typeof value === 'object' && Array.isArray(obj[key]))
           ? { ...acc, [key]: value }
           : typeof value === 'object' && !Array.isArray(value) && value != null
-          ? {
-              ...acc,
-              [key]: filterKebabCaseKeys(value as Record<string, unknown>),
-            }
-          : { ...acc, [key]: value },
+            ? {
+                ...acc,
+                [key]: filterKebabCaseKeys(value as Record<string, unknown>),
+              }
+            : { ...acc, [key]: value },
       {},
     ) as T;
 }
diff --git a/packages/cli/src/lib/implementation/validate-filter-options.utils.ts b/packages/cli/src/lib/implementation/validate-filter-options.utils.ts
@@ -18,8 +18,8 @@ export function validateFilterOption(
   const validItems = isCategoryOption(option)
     ? categories
     : isPluginOption(option)
-    ? plugins
-    : [];
+      ? plugins
+      : [];
   const invalidItems = itemsToFilter.filter(
     item => !validItems.some(({ slug }) => slug === item),
   );
@@ -94,8 +94,8 @@ export function getItemType(option: FilterOptionType, count: number): string {
   const itemType = isCategoryOption(option)
     ? 'category'
     : isPluginOption(option)
-    ? 'plugin'
-    : 'item';
+      ? 'plugin'
+      : 'item';
   return pluralize(itemType, count);
 }
 
diff --git a/packages/models/src/lib/implementation/utils.ts b/packages/models/src/lib/implementation/utils.ts
@@ -89,10 +89,11 @@ export function getMissingRefsForCategories(
       .filter(({ type }) => type === 'group')
       .map(({ plugin, slug }) => `${plugin}#${slug} (group)`),
   );
-  const groupRefsFromPlugins = plugins.flatMap(({ groups, slug: pluginSlug }) =>
-    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,
diff --git a/packages/nx-plugin/README.md b/packages/nx-plugin/README.md
@@ -10,7 +10,7 @@ Register this plugin in your `nx.json` to leverage a set of generators and execu
 // nx.json
 {
   //...
-  "plugins": ["@code-pushup/nx-plugin"]
+  "plugins": ["@code-pushup/nx-plugin"],
 }
 ```
 
diff --git a/packages/nx-plugin/src/executors/cli/README.md b/packages/nx-plugin/src/executors/cli/README.md
@@ -15,9 +15,9 @@ Configure a target in your project json.
   "name": "my-project",
   "targets": {
     "code-pushup": {
-      "executor": "@code-pushup/nx-plugin:cli"
-    }
-  }
+      "executor": "@code-pushup/nx-plugin:cli",
+    },
+  },
 }
 ```
 
@@ -54,11 +54,11 @@ The following things happen:
       "options": {
         "projectPrefix": "cli", // upload.project = cli-my-project
         "verbose": true,
-        "progress": false
+        "progress": false,
         // persist and upload options as defined in CoreConfig
-      }
-    }
-  }
+      },
+    },
+  },
 }
 ```
 
diff --git a/packages/nx-plugin/src/plugin/README.md b/packages/nx-plugin/src/plugin/README.md
@@ -15,7 +15,7 @@ Why should you use this plugin?
 // nx.json
 {
   //...
-  "plugins": ["@code-pushup/nx-plugin"]
+  "plugins": ["@code-pushup/nx-plugin"],
 }
 ```
 
@@ -29,10 +29,10 @@ or with options:
     {
       "plugin": "@code-pushup/nx-plugin",
       "options": {
-        "projectPrefix": "cli"
-      }
-    }
-  ]
+        "projectPrefix": "cli",
+      },
+    },
+  ],
 }
 ```
 
diff --git a/packages/plugin-coverage/src/lib/runner/runner.integration.test.ts b/packages/plugin-coverage/src/lib/runner/runner.integration.test.ts
@@ -39,9 +39,8 @@ describe('createRunnerConfig', () => {
 
     await createRunnerConfig('executeRunner.ts', pluginConfig);
 
-    const config = await readJsonFile<FinalCoveragePluginConfig>(
-      PLUGIN_CONFIG_PATH,
-    );
+    const config =
+      await readJsonFile<FinalCoveragePluginConfig>(PLUGIN_CONFIG_PATH);
     expect(config).toStrictEqual(pluginConfig);
   });
 });
diff --git a/packages/plugin-eslint/mocks/fixtures/todos-app/www/index.html b/packages/plugin-eslint/mocks/fixtures/todos-app/www/index.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html>
   <body>
     <div id="root" />
diff --git a/packages/plugin-eslint/src/lib/nx/traverse-graph.unit.test.ts b/packages/plugin-eslint/src/lib/nx/traverse-graph.unit.test.ts
@@ -3,7 +3,7 @@ import { findAllDependencies } from './traverse-graph';
 
 describe('findAllDependencies', () => {
   const mockProjectGraph = (dependencies: ProjectGraph['dependencies']) =>
-    ({ dependencies } as ProjectGraph);
+    ({ dependencies }) as ProjectGraph;
 
   it('should return empty array when a project has no dependencies', () => {
     expect(
diff --git a/packages/plugin-eslint/src/lib/runner/index.ts b/packages/plugin-eslint/src/lib/runner/index.ts
@@ -21,9 +21,8 @@ export const PLUGIN_CONFIG_PATH = join(
 );
 
 export async function executeRunner(): Promise<void> {
-  const { slugs, targets } = await readJsonFile<ESLintPluginRunnerConfig>(
-    PLUGIN_CONFIG_PATH,
-  );
+  const { slugs, targets } =
+    await readJsonFile<ESLintPluginRunnerConfig>(PLUGIN_CONFIG_PATH);
 
   const linterOutputs = await targets.reduce(
     async (acc, target) => [...(await acc), await lint(target)],
diff --git a/packages/plugin-eslint/src/lib/runner/lint.unit.test.ts b/packages/plugin-eslint/src/lib/runner/lint.unit.test.ts
@@ -17,7 +17,7 @@ class MockESLint {
               'max-lines': ['warn', 500],
               '@typescript-eslint/no-explicit-any': 'error',
             },
-      } as Linter.Config),
+      }) as Linter.Config,
   );
 }
 
diff --git a/packages/plugin-js-packages/src/lib/package-managers/derive-package-manager.ts b/packages/plugin-js-packages/src/lib/package-managers/derive-package-manager.ts
@@ -32,9 +32,8 @@ export async function derivePackageManagerInPackageJson(
 export async function derivePackageManager(
   currentDir = process.cwd(),
 ): Promise<PackageManagerId> {
-  const pkgManagerFromPackageJson = await derivePackageManagerInPackageJson(
-    currentDir,
-  );
+  const pkgManagerFromPackageJson =
+    await derivePackageManagerInPackageJson(currentDir);
   if (pkgManagerFromPackageJson) {
     return pkgManagerFromPackageJson;
   }
diff --git a/packages/plugin-js-packages/src/lib/package-managers/npm/audit-result.ts b/packages/plugin-js-packages/src/lib/package-managers/npm/audit-result.ts
@@ -17,7 +17,7 @@ export function npmToAuditResult(output: string): AuditResult {
         name: name.toString(),
         severity: detail.severity,
         versionRange: detail.range,
-        directDependency: detail.isDirect ? true : detail.effects[0] ?? '',
+        directDependency: detail.isDirect ? true : (detail.effects[0] ?? ''),
         fixInformation: npmToFixInformation(detail.fixAvailable),
         ...(advisory != null && {
           title: advisory.title,
diff --git a/packages/plugin-js-packages/src/lib/runner/outdated/transform.ts b/packages/plugin-js-packages/src/lib/runner/outdated/transform.ts
@@ -32,13 +32,16 @@ export function outdatedResultToAuditOutput(
     neq(dep.current, dep.latest),
   );
 
-  const outdatedStats = outdatedDependencies.reduce((acc, dep) => {
-    const outdatedLevel = diff(dep.current, dep.latest);
-    if (outdatedLevel == null) {
-      return acc;
-    }
-    return { ...acc, [outdatedLevel]: acc[outdatedLevel] + 1 };
-  }, objectFromEntries(RELEASE_TYPES.map(versionType => [versionType, 0])));
+  const outdatedStats = outdatedDependencies.reduce(
+    (acc, dep) => {
+      const outdatedLevel = diff(dep.current, dep.latest);
+      if (outdatedLevel == null) {
+        return acc;
+      }
+      return { ...acc, [outdatedLevel]: acc[outdatedLevel] + 1 };
+    },
+    objectFromEntries(RELEASE_TYPES.map(versionType => [versionType, 0])),
+  );
 
   const issues =
     outdatedDependencies.length === 0
diff --git a/packages/plugin-js-packages/src/lib/runner/runner.integration.test.ts b/packages/plugin-js-packages/src/lib/runner/runner.integration.test.ts
@@ -32,9 +32,8 @@ describe('createRunnerConfig', () => {
       packageJsonPaths: ['package.json'],
     };
     await createRunnerConfig('executeRunner.ts', pluginConfig);
-    const config = await readJsonFile<FinalJSPackagesPluginConfig>(
-      PLUGIN_CONFIG_PATH,
-    );
+    const config =
+      await readJsonFile<FinalJSPackagesPluginConfig>(PLUGIN_CONFIG_PATH);
     expect(config).toStrictEqual(pluginConfig);
   });
 });
diff --git a/packages/plugin-lighthouse/src/lib/runner/utils.ts b/packages/plugin-lighthouse/src/lib/runner/utils.ts
@@ -50,8 +50,8 @@ function formatBaseAuditOutput(lhrAudit: Result): AuditOutput {
           ? 'passed'
           : 'failed'
         : score
-        ? `${formatReportScore(score)}%`
-        : undefined),
+          ? `${formatReportScore(score)}%`
+          : undefined),
   };
 }
 
diff --git a/packages/plugin-lighthouse/src/lib/runner/utils.unit.test.ts b/packages/plugin-lighthouse/src/lib/runner/utils.unit.test.ts
@@ -239,7 +239,7 @@ describe('toAuditOutputs', () => {
             score: 0,
             numericValue: 0,
             displayValue: '0 ms',
-          } as Result),
+          }) as Result,
       ),
     );
     expect(getLogMessages(ui().logger)).toHaveLength(0);
@@ -256,7 +256,7 @@ describe('toAuditOutputs', () => {
             score: 0,
             numericValue: 0,
             displayValue: '0 ms',
-          } as Result),
+          }) as Result,
       ),
       { verbose: true },
     );
diff --git a/packages/utils/src/lib/reports/generate-md-report.unit.test.ts b/packages/utils/src/lib/reports/generate-md-report.unit.test.ts
diff --git a/testing/test-setup/src/lib/cliui.mock.ts b/testing/test-setup/src/lib/cliui.mock.ts
diff --git a/testing/test-utils/src/lib/utils/dynamic-mocks/eslint-plugin.mock.ts b/testing/test-utils/src/lib/utils/dynamic-mocks/eslint-plugin.mock.ts
diff --git a/tools/src/debug/README.md b/tools/src/debug/README.md
diff --git a/tools/src/npm/README.md b/tools/src/npm/README.md
diff --git a/tools/src/publish/README.md b/tools/src/publish/README.md
diff --git a/tools/src/verdaccio/README.md b/tools/src/verdaccio/README.md
diff --git a/tools/src/verdaccio/bin/create-verdaccio-env.ts b/tools/src/verdaccio/bin/create-verdaccio-env.ts

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-<!DOCTYPE html>`
	`1`	`+<!doctype html>`
`2`	`2`	`<html lang="en">`
`3`	`3`	`<head>`
`4`	`4`	`<meta charset="utf-8" />`