@code-pushup/js-packages-plugin 0.44.4 → 0.45.0

package/README.md

@@ -113,6 +113,7 @@ The plugin accepts the following parameters:
 - `packageManager`: The package manager you are using. Supported values: `npm`, `yarn-classic` (v1), `yarn-modern` (v2+), `pnpm`.
 - (optional) `checks`: Array of checks to be run. Supported commands: `audit`, `outdated`. Both are configured by default.
 - (optional) `dependencyGroups`: Array of dependency groups to be checked. `prod` and `dev` are configured by default. `optional` are opt-in.
+- (optional) `packageJsonPath`: File path to `package.json`. Defaults to current folder. Multiple `package.json` files are currently not supported.
 - (optional) `auditLevelMapping`: If you wish to set a custom level of issue severity based on audit vulnerability level, you may do so here. Any omitted values will be filled in by defaults. Audit levels are: `critical`, `high`, `moderate`, `low` and `info`. Issue severities are: `error`, `warn` and `info`. By default the mapping is as follows: `critical` and `high` → `error`; `moderate` and `low` → `warning`; `info` → `info`.
 
 ### Audits and group

package/bin.js

@@ -1221,7 +1221,8 @@ var jsPackagesPluginConfigSchema = z16.object({
   dependencyGroups: z16.array(dependencyGroupSchema).min(1).default(["prod", "dev"]),
   auditLevelMapping: z16.record(packageAuditLevelSchema, issueSeveritySchema, {
     description: "Mapping of audit levels to issue severity. Custom mapping or overrides may be entered manually, otherwise has a default preset."
-  }).default(defaultAuditLevelMapping).transform(fillAuditLevelMapping)
+  }).default(defaultAuditLevelMapping).transform(fillAuditLevelMapping),
+  packageJsonPath: z16.string().describe("File path to package.json. Defaults to current folder.").default("package.json")
 });
 
 // packages/plugin-js-packages/src/lib/runner/utils.ts
@@ -1255,6 +1256,15 @@ function filterAuditResult(result, key, referenceResult) {
     summary: uniqueResult.summary
   };
 }
+async function getTotalDependencies(packageJsonPath) {
+  const packageJson = await readJsonFile(packageJsonPath);
+  return objectFromEntries(
+    dependencyGroups.map((depGroup) => {
+      const deps = packageJson[dependencyGroupToLong[depGroup]];
+      return [depGroup, deps == null ? 0 : objectToKeys(deps).length];
+    })
+  );
+}
 
 // packages/plugin-js-packages/src/lib/package-managers/constants.ts
 var COMMON_AUDIT_ARGS = ["audit", "--json"];
@@ -1793,7 +1803,7 @@ var outdatedSeverity = {
 var RELEASE_TYPES = objectToKeys(outdatedSeverity);
 
 // packages/plugin-js-packages/src/lib/runner/outdated/transform.ts
-function outdatedResultToAuditOutput(result, packageManager, depGroup) {
+function outdatedResultToAuditOutput(result, packageManager, depGroup, totalDeps) {
   const relevantDependencies = result.filter(
     (dep) => dep.type === dependencyGroupToLong[depGroup]
   );
@@ -1817,10 +1827,7 @@ function outdatedResultToAuditOutput(result, packageManager, depGroup) {
   const issues = outdatedDependencies.length === 0 ? [] : outdatedToIssues(outdatedDependencies);
   return {
     slug: `${packageManager}-outdated-${depGroup}`,
-    score: calculateOutdatedScore(
-      outdatedStats.major,
-      relevantDependencies.length
-    ),
+    score: calculateOutdatedScore(outdatedStats.major, totalDeps),
     value: outdatedDependencies.length,
     displayValue: outdatedToDisplayValue(outdatedStats),
     details: { issues }
@@ -1865,15 +1872,16 @@ async function executeRunner() {
     packageManager,
     checks,
     auditLevelMapping,
+    packageJsonPath,
     dependencyGroups: depGroups
   } = await readJsonFile(PLUGIN_CONFIG_PATH);
-  const auditResults = checks.includes("audit") ? await processAudit(packageManager, auditLevelMapping, depGroups) : [];
-  const outdatedResults = checks.includes("outdated") ? await processOutdated(packageManager, depGroups) : [];
+  const auditResults = checks.includes("audit") ? await processAudit(packageManager, depGroups, auditLevelMapping) : [];
+  const outdatedResults = checks.includes("outdated") ? await processOutdated(packageManager, depGroups, packageJsonPath) : [];
   const checkResults = [...auditResults, ...outdatedResults];
   await ensureDirectoryExists(dirname(RUNNER_OUTPUT_PATH));
   await writeFile(RUNNER_OUTPUT_PATH, JSON.stringify(checkResults));
 }
-async function processOutdated(id, depGroups) {
+async function processOutdated(id, depGroups, packageJsonPath) {
   const pm = packageManagers[id];
   const { stdout } = await executeProcess({
     command: pm.command,
@@ -1882,12 +1890,18 @@ async function processOutdated(id, depGroups) {
     ignoreExitCode: true
     // outdated returns exit code 1 when outdated dependencies are found
   });
+  const depTotals = await getTotalDependencies(packageJsonPath);
   const normalizedResult = pm.outdated.unifyResult(stdout);
   return depGroups.map(
-    (depGroup) => outdatedResultToAuditOutput(normalizedResult, id, depGroup)
+    (depGroup) => outdatedResultToAuditOutput(
+      normalizedResult,
+      id,
+      depGroup,
+      depTotals[depGroup]
+    )
   );
 }
-async function processAudit(id, auditLevelMapping, depGroups) {
+async function processAudit(id, depGroups, auditLevelMapping) {
   const pm = packageManagers[id];
   const supportedAuditDepGroups = pm.audit.supportedDepGroups ?? dependencyGroups;
   const compatibleAuditDepGroups = depGroups.filter(

package/index.js

@@ -4,7 +4,7 @@ import { fileURLToPath } from "node:url";
 
 // packages/plugin-js-packages/package.json
 var name = "@code-pushup/js-packages-plugin";
-var version = "0.44.4";
+var version = "0.45.0";
 
 // packages/plugin-js-packages/src/lib/config.ts
 import { z as z16 } from "zod";
@@ -764,7 +764,8 @@ var jsPackagesPluginConfigSchema = z16.object({
   dependencyGroups: z16.array(dependencyGroupSchema).min(1).default(["prod", "dev"]),
   auditLevelMapping: z16.record(packageAuditLevelSchema, issueSeveritySchema, {
     description: "Mapping of audit levels to issue severity. Custom mapping or overrides may be entered manually, otherwise has a default preset."
-  }).default(defaultAuditLevelMapping).transform(fillAuditLevelMapping)
+  }).default(defaultAuditLevelMapping).transform(fillAuditLevelMapping),
+  packageJsonPath: z16.string().describe("File path to package.json. Defaults to current folder.").default("package.json")
 });
 
 // packages/utils/src/lib/text-formats/constants.ts

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@code-pushup/js-packages-plugin",
-  "version": "0.44.4",
+  "version": "0.45.0",
   "dependencies": {
-    "@code-pushup/models": "0.44.4",
-    "@code-pushup/utils": "0.44.4",
+    "@code-pushup/models": "0.45.0",
+    "@code-pushup/utils": "0.45.0",
     "semver": "^7.6.0",
     "zod": "^3.22.4"
   },

package/src/lib/config.d.ts

@@ -16,16 +16,19 @@ export declare const jsPackagesPluginConfigSchema: z.ZodObject<{
     packageManager: z.ZodEnum<["npm", "yarn-classic", "yarn-modern", "pnpm"]>;
     dependencyGroups: z.ZodDefault<z.ZodArray<z.ZodEnum<["prod", "dev", "optional"]>, "many">>;
     auditLevelMapping: z.ZodEffects<z.ZodDefault<z.ZodRecord<z.ZodEnum<["critical", "high", "moderate", "low", "info"]>, z.ZodEnum<["info", "warning", "error"]>>>, AuditSeverity, Partial<Record<"info" | "critical" | "high" | "moderate" | "low", "error" | "info" | "warning">> | undefined>;
+    packageJsonPath: z.ZodDefault<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     checks: ("audit" | "outdated")[];
     packageManager: "npm" | "pnpm" | "yarn-classic" | "yarn-modern";
     dependencyGroups: ("prod" | "dev" | "optional")[];
     auditLevelMapping: AuditSeverity;
+    packageJsonPath: string;
 }, {
     packageManager: "npm" | "pnpm" | "yarn-classic" | "yarn-modern";
     checks?: ("audit" | "outdated")[] | undefined;
     dependencyGroups?: ("prod" | "dev" | "optional")[] | undefined;
     auditLevelMapping?: Partial<Record<"info" | "critical" | "high" | "moderate" | "low", "error" | "info" | "warning">> | undefined;
+    packageJsonPath?: string | undefined;
 }>;
 export type JSPackagesPluginConfig = z.input<typeof jsPackagesPluginConfigSchema>;
 export type FinalJSPackagesPluginConfig = z.infer<typeof jsPackagesPluginConfigSchema>;

package/src/lib/runner/outdated/transform.d.ts

@@ -2,7 +2,7 @@ import { ReleaseType } from 'semver';
 import type { AuditOutput, Issue } from '@code-pushup/models';
 import { DependencyGroup, PackageManagerId } from '../../config';
 import { OutdatedResult } from './types';
-export declare function outdatedResultToAuditOutput(result: OutdatedResult, packageManager: PackageManagerId, depGroup: DependencyGroup): AuditOutput;
+export declare function outdatedResultToAuditOutput(result: OutdatedResult, packageManager: PackageManagerId, depGroup: DependencyGroup, totalDeps: number): AuditOutput;
 export declare function calculateOutdatedScore(majorOutdated: number, totalDeps: number): number;
 export declare function outdatedToDisplayValue(stats: Record<ReleaseType, number>): string;
 export declare function outdatedToIssues(dependencies: OutdatedResult): Issue[];

package/src/lib/runner/outdated/types.d.ts

@@ -1,6 +1,9 @@
 import type { ReleaseType } from 'semver';
 export type PackageVersion = Record<ReleaseType, number>;
-export type DependencyGroupLong = 'dependencies' | 'devDependencies' | 'optionalDependencies';
+export declare const dependencyGroupLong: readonly ["dependencies", "devDependencies", "optionalDependencies"];
+export type DependencyGroupLong = (typeof dependencyGroupLong)[number];
+type PackageJsonDependencies = Record<string, string>;
+export type PackageJson = Partial<Record<DependencyGroupLong, PackageJsonDependencies>>;
 export type OutdatedDependency = {
     name: string;
     current: string;
@@ -9,3 +12,4 @@ export type OutdatedDependency = {
     url?: string;
 };
 export type OutdatedResult = OutdatedDependency[];
+export {};

package/src/lib/runner/utils.d.ts

@@ -1,2 +1,3 @@
 import { AuditResult, Vulnerability } from './audit/types';
 export declare function filterAuditResult(result: AuditResult, key: keyof Vulnerability, referenceResult?: AuditResult): AuditResult;
+export declare function getTotalDependencies(packageJsonPath: string): Promise<Record<"prod" | "dev" | "optional", number>>;