refactor: rename scoreTarget to scoreTargets

Author: hanna-skryl

packages/core/src/lib/implementation/execute-plugin.ts

@@ -58,7 +58,7 @@ export async function executePlugin(
     description,
     docsUrl,
     groups,
-    scoreTarget,
+    scoreTargets,
     ...pluginMeta
   } = pluginConfig;
   const { write: cacheWrite = false, read: cacheRead = false } = cache;
@@ -78,9 +78,9 @@ export async function executePlugin(
     });
   }
 
-  // transform audit scores to 1 when they meet/exceed scoreTarget
-  const scoredAuditsWithTarget = scoreTarget
-    ? scoreAuditsWithTarget(audits, scoreTarget)
+  // transform audit scores to 1 when they meet/exceed their targets
+  const scoredAuditsWithTarget = scoreTargets
+    ? scoreAuditsWithTarget(audits, scoreTargets)
     : audits;
 
   // enrich `AuditOutputs` to `AuditReport`

packages/models/docs/models-reference.md

@@ -1297,7 +1297,7 @@ _Object containing the following properties:_
 | **`runner`** (\*) |                                                                                                                  | [RunnerConfig](#runnerconfig) _or_ [RunnerFunction](#runnerfunction)                                                       |
 | **`audits`** (\*) | List of audits maintained in a plugin                                                                            | _Array of at least 1 [Audit](#audit) items_                                                                                |
 | `groups`          | List of groups                                                                                                   | _Array of [Group](#group) items_                                                                                           |
-| `scoreTarget`     | Score targets that trigger a perfect score. Number for all audits or record { slug: target } for specific audits | `number` (_≥0, ≤1_) (_optional_) _or_ _Object with dynamic keys of type_ `string` _and values of type_ `number` (_≥0, ≤1_) |
+| `scoreTargets`    | Score targets that trigger a perfect score. Number for all audits or record { slug: target } for specific audits | `number` (_≥0, ≤1_) (_optional_) _or_ _Object with dynamic keys of type_ `string` _and values of type_ `number` (_≥0, ≤1_) |
 | `context`         | Plugin-specific context data for helpers                                                                         | [PluginContext](#plugincontext)                                                                                            |
 
 _(\*) Required._

packages/models/src/index.ts

@@ -80,7 +80,7 @@ export {
   type PluginConfig,
   type PluginContext,
   type PluginMeta,
-  type PluginScoreTarget,
+  type PluginScoreTargets,
 } from './lib/plugin-config.js';
 export {
   auditReportSchema,

packages/models/src/lib/plugin-config.ts

@@ -33,7 +33,7 @@ export const pluginMetaSchema = packageVersionSchema()
   });
 export type PluginMeta = z.infer<typeof pluginMetaSchema>;
 
-export const pluginScoreTargetSchema = z
+export const pluginScoreTargetsSchema = z
   .union([
     scoreTargetSchema,
     z.record(z.string(), scoreTargetSchema.nonoptional()),
@@ -43,13 +43,13 @@ export const pluginScoreTargetSchema = z
   )
   .optional();
 
-export type PluginScoreTarget = z.infer<typeof pluginScoreTargetSchema>;
+export type PluginScoreTargets = z.infer<typeof pluginScoreTargetsSchema>;
 
 export const pluginDataSchema = z.object({
   runner: z.union([runnerConfigSchema, runnerFunctionSchema]),
   audits: pluginAuditsSchema,
   groups: groupsSchema,
-  scoreTarget: pluginScoreTargetSchema,
+  scoreTargets: pluginScoreTargetsSchema,
   context: pluginContextSchema,
 });
 

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

@@ -3,7 +3,7 @@ import type {
   AuditReport,
   CategoryRef,
   GroupRef,
-  PluginScoreTarget,
+  PluginScoreTargets,
   Report,
 } from '@code-pushup/models';
 import { deepClone } from '../transform.js';
@@ -138,18 +138,18 @@ export function scoreAuditWithTarget(
 /**
  * Sets audit scores to 1 when targets are met.
  * @param audits audit outputs from plugin execution
- * @param scoreTarget number or { slug: target } mapping
+ * @param scoreTargets number or { slug: target } mapping
  * @returns Transformed audits with scoreTarget field
  */
 export function scoreAuditsWithTarget(
   audits: AuditOutput[],
-  scoreTarget: PluginScoreTarget,
+  scoreTargets: PluginScoreTargets,
 ): AuditOutput[] {
-  if (typeof scoreTarget === 'number') {
-    return audits.map(audit => scoreAuditWithTarget(audit, scoreTarget));
+  if (typeof scoreTargets === 'number') {
+    return audits.map(audit => scoreAuditWithTarget(audit, scoreTargets));
   }
   return audits.map(audit => {
-    const target = scoreTarget?.[audit.slug];
+    const target = scoreTargets?.[audit.slug];
     return target == null ? audit : scoreAuditWithTarget(audit, target);
   });
 }