feat(plugin-eslint): replace @poppinss/cliui with new logger

Author: matejchalk

packages/plugin-eslint/src/lib/meta/groups.ts

@@ -1,6 +1,6 @@
 import type { Rule } from 'eslint';
 import type { Group, GroupRef } from '@code-pushup/models';
-import { objectToKeys, slugify, ui } from '@code-pushup/utils';
+import { logger, objectToKeys, slugify } from '@code-pushup/utils';
 import type { CustomGroup } from '../config.js';
 import { ruleToSlug } from './hash.js';
 import { type RuleData, parseRuleId } from './parse.js';
@@ -109,7 +109,7 @@ export function groupsFromCustomConfig(
           `Invalid rule configuration in group ${group.slug}. All rules are invalid.`,
         );
       }
-      ui().logger.warning(
+      logger.warn(
         `Some rules in group ${group.slug} are invalid: ${invalidRules.join(', ')}`,
       );
     }

packages/plugin-eslint/src/lib/meta/groups.unit.test.ts

@@ -1,5 +1,5 @@
 import type { Group } from '@code-pushup/models';
-import { ui } from '@code-pushup/utils';
+import { logger } from '@code-pushup/utils';
 import {
   createRulesMap,
   groupsFromCustomConfig,
@@ -306,8 +306,7 @@ describe('groupsFromCustomConfig', () => {
         refs: [{ slug: 'react-jsx-key', weight: 3 }],
       },
     ]);
-    expect(ui()).toHaveLogged(
-      'warn',
+    expect(logger.warn).toHaveBeenCalledWith(
       'Some rules in group custom-group are invalid: invalid-rule',
     );
   });

packages/plugin-eslint/src/lib/meta/versions/flat.ts

@@ -2,7 +2,7 @@ import type { Linter, Rule } from 'eslint';
 import { builtinRules } from 'eslint/use-at-your-own-risk';
 import path from 'node:path';
 import { pathToFileURL } from 'node:url';
-import { exists, findNearestFile, toArray, ui } from '@code-pushup/utils';
+import { exists, findNearestFile, logger, toArray } from '@code-pushup/utils';
 import type { ESLintTarget } from '../../config.js';
 import { jsonHash } from '../hash.js';
 import {
@@ -25,7 +25,7 @@ export async function loadRulesForFlatConfig({
     .map(rule => {
       const meta = findRuleMeta(rule.id, configs);
       if (!meta) {
-        ui().logger.warning(`Cannot find metadata for rule ${rule.id}`);
+        logger.warn(`Cannot find metadata for rule ${rule.id}`);
         return null;
       }
       return { ...rule, meta };
@@ -106,7 +106,7 @@ function findPluginRuleMeta(
   const rule = config?.plugins?.[plugin]?.rules?.[name];
 
   if (typeof rule === 'function') {
-    ui().logger.warning(
+    logger.warn(
       `Cannot parse metadata for rule ${plugin}/${name}, plugin registers it as a function`,
     );
     return undefined;

packages/plugin-eslint/src/lib/meta/versions/legacy.ts

@@ -3,8 +3,8 @@ import {
   asyncSequential,
   distinct,
   exists,
+  logger,
   toArray,
-  ui,
 } from '@code-pushup/utils';
 import type { ESLintTarget } from '../../config.js';
 import { setupESLint } from '../../setup.js';
@@ -41,7 +41,7 @@ export async function loadRulesForLegacyConfig({
       }
       const ruleMeta = rulesMeta[id];
       if (!ruleMeta) {
-        ui().logger.warning(`Metadata not found for ESLint rule ${id}`);
+        logger.warn(`Metadata not found for ESLint rule ${id}`);
         return null;
       }
       // ignoring meta.defaultOptions to match legacy config handling in calculateConfigForFile

packages/plugin-eslint/src/lib/nx/find-all-projects.ts

@@ -1,4 +1,4 @@
-import { stringifyError, ui } from '@code-pushup/utils';
+import { logger, stringifyError } from '@code-pushup/utils';
 import type { ESLintTarget } from '../config.js';
 import { filterProjectGraph } from './filter-project-graph.js';
 import { nxProjectsToConfig } from './projects-to-config.js';
@@ -14,9 +14,8 @@ async function resolveCachedProjectGraph() {
   try {
     return readCachedProjectGraph();
   } catch (error) {
-    ui().logger.info(
-      `Could not read cached project graph, falling back to async creation.
-      ${stringifyError(error)}`,
+    logger.info(
+      `Could not read cached project graph, falling back to async creation.\n${stringifyError(error)}`,
     );
     return await createProjectGraphAsync({ exitOnError: false });
   }

packages/plugin-eslint/src/lib/runner/index.ts

@@ -5,7 +5,7 @@ import type {
   PluginArtifactOptions,
   RunnerFunction,
 } from '@code-pushup/models';
-import { asyncSequential, ui } from '@code-pushup/utils';
+import { asyncSequential, logger } from '@code-pushup/utils';
 import type { ESLintPluginRunnerConfig, ESLintTarget } from '../config.js';
 import { lint } from './lint.js';
 import { lintResultsToAudits, mergeLinterOutputs } from './transform.js';
@@ -23,7 +23,7 @@ export function createRunnerFunction(options: {
   };
 
   return async (): Promise<AuditOutputs> => {
-    ui().logger.log(`ESLint plugin executing ${targets.length} lint targets`);
+    logger.info(`ESLint plugin executing ${targets.length} lint targets`);
 
     const linterOutputs = artifacts
       ? await loadArtifacts(artifacts)

packages/plugin-eslint/src/lib/runner/index.unit.test.ts

@@ -6,7 +6,7 @@ import {
   DEFAULT_PERSIST_CONFIG,
   type pluginArtifactOptionsSchema,
 } from '@code-pushup/models';
-import { ui } from '@code-pushup/utils';
+import { logger } from '@code-pushup/utils';
 import type { ESLintTarget } from '../config.js';
 import { createRunnerFunction } from './index.js';
 import * as lintModule from './lint.js';
@@ -130,7 +130,9 @@ describe('createRunnerFunction', () => {
 
     expect(loadArtifactsSpy).toHaveBeenCalledWith(artifacts);
     expect(lintSpy).not.toHaveBeenCalled();
-    expect(ui()).toHaveLogged('log', 'ESLint plugin executing 2 lint targets');
+    expect(logger.info).toHaveBeenCalledWith(
+      'ESLint plugin executing 2 lint targets',
+    );
   });
 
   it('should use internal linting logic when artifacts are not provided', async () => {

packages/plugin-eslint/src/lib/runner/transform.ts

@@ -3,10 +3,10 @@ import type { AuditOutput, Issue, IssueSeverity } from '@code-pushup/models';
 import {
   compareIssueSeverity,
   countOccurrences,
+  logger,
   objectToEntries,
   pluralizeToken,
   truncateIssueMessage,
-  ui,
 } from '@code-pushup/utils';
 import { ruleIdToSlug } from '../meta/index.js';
 import type { LinterOutput } from './types.js';
@@ -36,9 +36,7 @@ export function lintResultsToAudits({
     .reduce<Record<string, LintIssue[]>>((acc, issue) => {
       const { ruleId, message, filePath } = issue;
       if (!ruleId) {
-        ui().logger.warning(
-          `ESLint core error - ${message} (file: ${filePath})`,
-        );
+        logger.warn(`ESLint core error - ${message} (file: ${filePath})`);
         return acc;
       }
       const options = ruleOptionsPerFile[filePath]?.[ruleId] ?? [];