refactor: rename targetScoreIcon to scoreTargetIcon

Author: hanna-skryl

packages/utils/src/lib/reports/__snapshots__/generate-md-report-category-section.unit.test.ts.snap

@@ -72,7 +72,7 @@ exports[`categoriesOverviewSection > should render filtered categories table 1`]
 "
 `;
 
-exports[`categoriesOverviewSection > should render targetScore icon "❌" if score fails 1`] = `
+exports[`categoriesOverviewSection > should render scoreTarget icon "❌" if score fails 1`] = `
 "| 🏷 Category                       |   ⭐ Score   | 🛡 Audits |
 | :-------------------------------- | :---------: | :-------: |
 | [Bug Prevention](#bug-prevention) | 🟢 **98** ❌ |     1     |

packages/utils/src/lib/reports/generate-md-report-category-section.ts

@@ -11,7 +11,7 @@ import {
   getPluginNameFromSlug,
   scoreFilter,
   scoreMarker,
-  targetScoreIcon,
+  scoreTargetIcon,
 } from './utils.js';
 
 export function categoriesOverviewSection(
@@ -28,7 +28,7 @@ export function categoriesOverviewSection(
     categories
       .filter(scoreFilter(options))
       .map(({ title, refs, score, isBinary }) => [
-        // @TODO refactor `isBinary: boolean` to `targetScore: number` #713
+        // @TODO refactor `isBinary: boolean` to `scoreTarget: number` #713
         // The heading "ID" is inferred from the heading text in Markdown.
         md.link(`#${slugify(title)}`, title),
         md`${scoreMarker(score)} ${md.bold(
@@ -130,6 +130,6 @@ export function binaryIconSuffix(
   score: number,
   isBinary: boolean | undefined,
 ): string {
-  // @TODO refactor `isBinary: boolean` to `targetScore: number` #713
-  return targetScoreIcon(score, isBinary ? 1 : undefined, { prefix: ' ' });
+  // @TODO refactor `isBinary: boolean` to `scoreTarget: number` #713
+  return scoreTargetIcon(score, isBinary ? 1 : undefined, { prefix: ' ' });
 }

packages/utils/src/lib/reports/generate-md-report-category-section.unit.test.ts

@@ -91,7 +91,7 @@ describe('categoriesOverviewSection', () => {
     ).toMatchSnapshot();
   });
 
-  it('should render targetScore icon "❌" if score fails', () => {
+  it('should render scoreTarget icon "❌" if score fails', () => {
     expect(
       categoriesOverviewSection({
         plugins: [

packages/utils/src/lib/reports/log-stdout-summary.ts

@@ -13,7 +13,7 @@ import type { ScoredReport } from './types.js';
 import {
   applyScoreColor,
   countCategoryAudits,
-  targetScoreIcon,
+  scoreTargetIcon,
 } from './utils.js';
 
 function log(msg = ''): void {
@@ -130,12 +130,12 @@ export function logCategories({
   log();
 }
 
-// @TODO refactor `isBinary: boolean` to `targetScore: number` #713
+// @TODO refactor `isBinary: boolean` to `scoreTarget: number` #713
 export function binaryIconPrefix(
   score: number,
   isBinary: boolean | undefined,
 ): string {
-  return targetScoreIcon(score, isBinary ? 1 : undefined, {
+  return scoreTargetIcon(score, isBinary ? 1 : undefined, {
     passIcon: bold(green('✓')),
     failIcon: bold(red('✗')),
     postfix: ' ',

packages/utils/src/lib/reports/utils.ts

@@ -297,24 +297,24 @@ export function applyScoreColor(
     : style.bold(style.red(formattedScore));
 }
 
-export function targetScoreIcon(
+export function scoreTargetIcon(
   score: number,
-  targetScore?: number,
+  scoreTarget?: number,
   options: {
     passIcon?: string;
     failIcon?: string;
     prefix?: string;
     postfix?: string;
   } = {},
 ): string {
-  if (targetScore != null) {
+  if (scoreTarget != null) {
     const {
       passIcon = '✅',
       failIcon = '❌',
       prefix = '',
       postfix = '',
     } = options;
-    if (score >= targetScore) {
+    if (score >= scoreTarget) {
       return `${prefix}${passIcon}${postfix}`;
     }
     return `${prefix}${failIcon}${postfix}`;

packages/utils/src/lib/reports/utils.unit.test.ts

@@ -28,8 +28,8 @@ import {
   roundValue,
   scoreFilter,
   scoreMarker,
+  scoreTargetIcon,
   severityMarker,
-  targetScoreIcon,
 } from './utils.js';
 
 describe('scoreFilter', () => {
@@ -497,42 +497,42 @@ describe('applyScoreColor', () => {
   });
 });
 
-describe('targetScoreIcon', () => {
-  it('should return target score icon "✅" for passed score', () => {
-    expect(targetScoreIcon(0.42, 0.4)).toBe('✅');
+describe('scoreTargetIcon', () => {
+  it('should return score target icon "✅" for passed score', () => {
+    expect(scoreTargetIcon(0.42, 0.4)).toBe('✅');
   });
 
-  it('should return target score icon "❌" for failed score', () => {
-    expect(targetScoreIcon(0.42, 0.5)).toBe('❌');
+  it('should return score target icon "❌" for failed score', () => {
+    expect(scoreTargetIcon(0.42, 0.5)).toBe('❌');
   });
 
-  it('should return prefixed target score icon if prefix is provided', () => {
+  it('should return prefixed score target icon if prefix is provided', () => {
     expect(
-      targetScoreIcon(0.42, 0.1, {
+      scoreTargetIcon(0.42, 0.1, {
         prefix: '<',
       }),
     ).toBe('<✅');
   });
 
-  it('should return prefixed target score icon if postfix is provided', () => {
+  it('should return prefixed score target icon if postfix is provided', () => {
     expect(
-      targetScoreIcon(0.42, 0.1, {
+      scoreTargetIcon(0.42, 0.1, {
         postfix: '>',
       }),
     ).toBe('✅>');
   });
 
-  it('should return pre and postfixed target score icon if both are provided', () => {
+  it('should return pre and postfixed score target icon if both are provided', () => {
     expect(
-      targetScoreIcon(0.42, 0.1, {
+      scoreTargetIcon(0.42, 0.1, {
         prefix: '<',
         postfix: '>',
       }),
     ).toBe('<✅>');
   });
 
-  it('should return no target score icon if no targetScore is provided', () => {
-    expect(targetScoreIcon(0.42)).toBe('');
+  it('should return no score target icon if no scoreTarget is provided', () => {
+    expect(scoreTargetIcon(0.42)).toBe('');
   });
 });