@code-pushup/js-packages-plugin 0.34.0 → 0.39.0

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@code-pushup/js-packages-plugin",
-  "version": "0.34.0",
+  "version": "0.39.0",
   "dependencies": {
-    "@code-pushup/models": "0.34.0",
-    "@code-pushup/utils": "0.34.0",
+    "@code-pushup/models": "0.39.0",
+    "@code-pushup/utils": "0.39.0",
     "zod": "^3.22.4"
   },
   "license": "MIT",

package/src/lib/config.d.ts

@@ -4,8 +4,8 @@ export declare const dependencyGroups: readonly ["prod", "dev", "optional"];
 export type DependencyGroup = (typeof dependencyGroups)[number];
 declare const packageCommandSchema: z.ZodEnum<["audit", "outdated"]>;
 export type PackageCommand = z.infer<typeof packageCommandSchema>;
-declare const packageManagerSchema: z.ZodEnum<["npm", "yarn-classic", "yarn-modern", "pnpm"]>;
-export type PackageManager = z.infer<typeof packageManagerSchema>;
+declare const packageManagerIdSchema: z.ZodEnum<["npm", "yarn-classic", "yarn-modern", "pnpm"]>;
+export type PackageManagerId = z.infer<typeof packageManagerIdSchema>;
 export declare const packageAuditLevels: readonly ["critical", "high", "moderate", "low", "info"];
 declare const packageAuditLevelSchema: z.ZodEnum<["critical", "high", "moderate", "low", "info"]>;
 export type PackageAuditLevel = z.infer<typeof packageAuditLevelSchema>;

package/src/lib/constants.d.ts

@@ -1,12 +1,7 @@
-import { IssueSeverity, MaterialIcon } from '@code-pushup/models';
-import type { DependencyGroup, PackageAuditLevel, PackageManager } from './config';
+import { IssueSeverity } from '@code-pushup/models';
+import type { DependencyGroup, PackageAuditLevel } from './config';
 import { DependencyGroupLong } from './runner/outdated/types';
 export declare const defaultAuditLevelMapping: Record<PackageAuditLevel, IssueSeverity>;
 export declare const dependencyGroupToLong: Record<DependencyGroup, DependencyGroupLong>;
-export declare const pkgManagerCommands: Record<PackageManager, string>;
-export declare const pkgManagerNames: Record<PackageManager, string>;
-export declare const pkgManagerIcons: Record<PackageManager, MaterialIcon>;
-export declare const pkgManagerDocs: Record<PackageManager, string>;
-export declare const auditDocs: Record<PackageManager, string>;
-export declare const outdatedDocs: Record<PackageManager, string>;
+export declare const dependencyGroupWeights: Record<DependencyGroup, number>;
 export declare const dependencyDocs: Record<DependencyGroup, string>;

package/src/lib/package-managers/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const COMMON_AUDIT_ARGS: string[];
+export declare const COMMON_OUTDATED_ARGS: string[];

package/src/lib/package-managers/index.d.ts

@@ -0,0 +1,2 @@
+export { packageManagers } from './package-managers';
+export { PackageManager } from './types';

package/src/lib/package-managers/npm/audit-result.d.ts

@@ -0,0 +1,5 @@
+import { AuditResult } from '../../runner/audit/types';
+import { NpmAdvisory, NpmFixInformation, NpmVulnerabilities } from './types';
+export declare function npmToAuditResult(output: string): AuditResult;
+export declare function npmToFixInformation(fixAvailable: boolean | NpmFixInformation): string;
+export declare function npmToAdvisory(name: string, vulnerabilities: NpmVulnerabilities, prevNodes?: Set<string>): NpmAdvisory | null;

package/src/lib/package-managers/npm/npm.d.ts

@@ -0,0 +1,2 @@
+import { PackageManager } from '../types';
+export declare const npmPackageManager: PackageManager;

package/src/lib/package-managers/npm/outdated-result.d.ts

@@ -0,0 +1,2 @@
+import { OutdatedResult } from '../../runner/outdated/types';
+export declare function npmToOutdatedResult(output: string): OutdatedResult;

package/src/lib/package-managers/npm/types.d.ts

@@ -0,0 +1,38 @@
+import { PackageAuditLevel } from '../../config';
+import { AuditSummary } from '../../runner/audit/types';
+import { DependencyGroupLong } from '../../runner/outdated/types';
+export type NpmAdvisory = {
+    title: string;
+    url: string;
+};
+export type NpmFixInformation = {
+    name: string;
+    version: string;
+    isSemVerMajor: boolean;
+};
+export type NpmVulnerability = {
+    name: string;
+    severity: PackageAuditLevel;
+    isDirect: boolean;
+    effects: string[];
+    via: NpmAdvisory[] | string[];
+    range: string;
+    fixAvailable: boolean | NpmFixInformation;
+};
+export type NpmVulnerabilities = Record<string, NpmVulnerability>;
+export type NpmAuditResultJson = {
+    vulnerabilities: NpmVulnerabilities;
+    metadata: {
+        vulnerabilities: AuditSummary;
+    };
+};
+export type NpmVersionOverview = {
+    current?: string;
+    latest: string;
+    type: DependencyGroupLong;
+    homepage?: string;
+};
+export type NpmNormalizedOverview = Omit<NpmVersionOverview, 'current'> & {
+    current: string;
+};
+export type NpmOutdatedResultJson = Record<string, NpmVersionOverview>;

package/src/lib/package-managers/package-managers.d.ts

@@ -0,0 +1,3 @@
+import { PackageManagerId } from '../config';
+import { PackageManager } from './types';
+export declare const packageManagers: Record<PackageManagerId, PackageManager>;

package/src/lib/package-managers/pnpm/audit-result.d.ts

@@ -0,0 +1,3 @@
+import { AuditResult } from '../../runner/audit/types';
+export declare function pnpmToAuditResult(output: string): AuditResult;
+export declare function pnpmToDirectDependency(path: string): string | true;

package/src/lib/package-managers/pnpm/outdated-result.d.ts

@@ -0,0 +1,2 @@
+import { OutdatedResult } from '../../runner/outdated/types';
+export declare function pnpmToOutdatedResult(output: string): OutdatedResult;

package/src/lib/package-managers/pnpm/pnpm.d.ts

@@ -0,0 +1,2 @@
+import { PackageManager } from '../types';
+export declare const pnpmPackageManager: PackageManager;

package/src/lib/package-managers/pnpm/types.d.ts

@@ -0,0 +1,26 @@
+import { PackageAuditLevel } from '../../config';
+import { DependencyGroupLong } from '../../runner/outdated/types';
+export type PnpmAuditAdvisory = {
+    module_name: string;
+    id: number;
+    severity: PackageAuditLevel;
+    vulnerable_versions: string;
+    recommendation: string;
+    title: string;
+    url: string;
+    findings: {
+        paths: string[];
+    }[];
+};
+export type PnpmAuditResultJson = {
+    advisories: Record<string, PnpmAuditAdvisory>;
+    metadata: {
+        vulnerabilities: Record<PackageAuditLevel, number>;
+    };
+};
+export type PnpmVersionOverview = {
+    current: string;
+    latest: string;
+    dependencyType: DependencyGroupLong;
+};
+export type PnpmOutdatedResultJson = Record<string, PnpmVersionOverview>;

package/src/lib/package-managers/types.d.ts

@@ -0,0 +1,26 @@
+import type { MaterialIcon } from '@code-pushup/models';
+import { DependencyGroup, PackageManagerId } from '../config';
+import { AuditResult } from '../runner/audit/types';
+import { OutdatedResult } from '../runner/outdated/types';
+export type PackageManager = {
+    slug: PackageManagerId;
+    name: string;
+    command: string;
+    icon: MaterialIcon;
+    docs: {
+        homepage: string;
+        audit: string;
+        outdated: string;
+    };
+    audit: {
+        getCommandArgs: (groupDep: DependencyGroup) => string[];
+        ignoreExitCode?: boolean;
+        supportedDepGroups?: DependencyGroup[];
+        unifyResult: (output: string) => AuditResult;
+        postProcessResult?: (result: Record<DependencyGroup, AuditResult>) => Record<DependencyGroup, AuditResult>;
+    };
+    outdated: {
+        commandArgs: string[];
+        unifyResult: (output: string) => OutdatedResult;
+    };
+};

package/src/lib/package-managers/yarn-classic/audit-result.d.ts

@@ -0,0 +1,2 @@
+import { AuditResult } from '../../runner/audit/types';
+export declare function yarnv1ToAuditResult(output: string): AuditResult;

package/src/lib/package-managers/yarn-classic/outdated-result.d.ts

@@ -0,0 +1,2 @@
+import { OutdatedResult } from '../../runner/outdated/types';
+export declare function yarnv1ToOutdatedResult(output: string): OutdatedResult;

package/src/lib/package-managers/yarn-classic/types.d.ts

@@ -0,0 +1,49 @@
+import { PackageAuditLevel } from '../../config';
+import { DependencyGroupLong } from '../../runner/outdated/types';
+export type Yarnv1AuditAdvisory = {
+    type: 'auditAdvisory';
+    data: {
+        resolution: {
+            id: number;
+            path: string;
+        };
+        advisory: {
+            module_name: string;
+            severity: PackageAuditLevel;
+            vulnerable_versions: string;
+            recommendation: string;
+            title: string;
+            url: string;
+        };
+    };
+};
+export type Yarnv1AuditSummary = {
+    type: 'auditSummary';
+    data: {
+        vulnerabilities: Record<PackageAuditLevel, number>;
+    };
+};
+export type Yarnv1AuditResultJson = [
+    ...Yarnv1AuditAdvisory[],
+    Yarnv1AuditSummary
+];
+export type Yarnv1VersionOverview = [
+    string,
+    string,
+    string,
+    string,
+    string,
+    DependencyGroupLong,
+    string
+];
+type Yarnv1Info = {
+    type: 'info';
+};
+type Yarnv1Table = {
+    type: 'table';
+    data: {
+        body: Yarnv1VersionOverview[];
+    };
+};
+export type Yarnv1OutdatedResultJson = [Yarnv1Info, Yarnv1Table];
+export {};

package/src/lib/package-managers/yarn-classic/yarn-classic.d.ts

@@ -0,0 +1,2 @@
+import { PackageManager } from '../types';
+export declare const yarnv1PackageManager: PackageManager;

package/src/lib/package-managers/yarn-modern/audit-result.d.ts

@@ -0,0 +1,2 @@
+import { AuditResult } from '../../runner/audit/types';
+export declare function yarnv2ToAuditResult(output: string): AuditResult;

package/src/lib/package-managers/yarn-modern/outdated-result.d.ts

@@ -0,0 +1,2 @@
+import { OutdatedResult } from '../../runner/outdated/types';
+export declare function yarnv2ToOutdatedResult(output: string): OutdatedResult;

package/src/lib/package-managers/yarn-modern/types.d.ts

@@ -0,0 +1,26 @@
+import { PackageAuditLevel } from '../../config';
+import { DependencyGroupLong } from '../../runner/outdated/types';
+export type Yarnv2AuditAdvisory = {
+    module_name: string;
+    severity: PackageAuditLevel;
+    vulnerable_versions: string;
+    recommendation: string;
+    title: string;
+    url: string;
+    findings: {
+        paths: string[];
+    }[];
+};
+export type Yarnv2AuditResultJson = {
+    advisories: Record<string, Yarnv2AuditAdvisory>;
+    metadata: {
+        vulnerabilities: Record<PackageAuditLevel, number>;
+    };
+};
+export type Yarnv2VersionOverview = {
+    current: string;
+    latest: string;
+    name: string;
+    type: DependencyGroupLong;
+};
+export type Yarnv2OutdatedResultJson = Yarnv2VersionOverview[];

package/src/lib/package-managers/yarn-modern/yarn-modern.d.ts

@@ -0,0 +1,2 @@
+import { PackageManager } from '../types';
+export declare const yarnv2PackageManager: PackageManager;

package/src/lib/runner/audit/constants.d.ts

@@ -1,6 +1,2 @@
-import { DependencyGroup, PackageAuditLevel, PackageManager } from '../../config';
-import { AuditResult } from './types';
+import { PackageAuditLevel } from '../../config';
 export declare const auditScoreModifiers: Record<PackageAuditLevel, number>;
-export declare const normalizeAuditMapper: Record<PackageManager, (output: string) => AuditResult>;
-export declare const postProcessingAuditMapper: Partial<Record<PackageManager, (result: Record<DependencyGroup, AuditResult>) => Record<DependencyGroup, AuditResult>>>;
-export declare const auditArgs: (groupDep: DependencyGroup) => Record<PackageManager, string[]>;

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

@@ -1,7 +1,7 @@
 import type { AuditOutput, Issue } from '@code-pushup/models';
-import { AuditSeverity, DependencyGroup, PackageManager } from '../../config';
+import { AuditSeverity, DependencyGroup, PackageManagerId } from '../../config';
 import { AuditResult, AuditSummary, Vulnerability } from './types';
-export declare function auditResultToAuditOutput(result: AuditResult, packageManager: PackageManager, dependenciesType: DependencyGroup, auditLevelMapping: AuditSeverity): AuditOutput;
+export declare function auditResultToAuditOutput(result: AuditResult, id: PackageManagerId, depGroup: DependencyGroup, auditLevelMapping: AuditSeverity): AuditOutput;
 export declare function calculateAuditScore(stats: AuditSummary): number;
 export declare function summaryToDisplayValue(summary: AuditSummary): string;
 export declare function vulnerabilitiesToIssues(vulnerabilities: Vulnerability[], auditLevelMapping: AuditSeverity): Issue[];

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

@@ -14,90 +14,3 @@ export type AuditResult = {
     vulnerabilities: Vulnerability[];
     summary: AuditSummary;
 };
-export type NpmAdvisory = {
-    title: string;
-    url: string;
-};
-export type NpmFixInformation = {
-    name: string;
-    version: string;
-    isSemVerMajor: boolean;
-};
-export type NpmVulnerability = {
-    name: string;
-    severity: PackageAuditLevel;
-    isDirect: boolean;
-    effects: string[];
-    via: NpmAdvisory[] | string[];
-    range: string;
-    fixAvailable: boolean | NpmFixInformation;
-};
-export type NpmVulnerabilities = Record<string, NpmVulnerability>;
-export type NpmAuditResultJson = {
-    vulnerabilities: NpmVulnerabilities;
-    metadata: {
-        vulnerabilities: AuditSummary;
-    };
-};
-export type Yarnv1AuditAdvisory = {
-    type: 'auditAdvisory';
-    data: {
-        resolution: {
-            id: number;
-            path: string;
-        };
-        advisory: {
-            module_name: string;
-            severity: PackageAuditLevel;
-            vulnerable_versions: string;
-            recommendation: string;
-            title: string;
-            url: string;
-        };
-    };
-};
-export type Yarnv1AuditSummary = {
-    type: 'auditSummary';
-    data: {
-        vulnerabilities: Record<PackageAuditLevel, number>;
-    };
-};
-export type Yarnv1AuditResultJson = [
-    ...Yarnv1AuditAdvisory[],
-    Yarnv1AuditSummary
-];
-export type Yarnv2AuditAdvisory = {
-    module_name: string;
-    severity: PackageAuditLevel;
-    vulnerable_versions: string;
-    recommendation: string;
-    title: string;
-    url: string;
-    findings: {
-        paths: string[];
-    }[];
-};
-export type Yarnv2AuditResultJson = {
-    advisories: Record<string, Yarnv2AuditAdvisory>;
-    metadata: {
-        vulnerabilities: Record<PackageAuditLevel, number>;
-    };
-};
-export type PnpmAuditAdvisory = {
-    module_name: string;
-    id: number;
-    severity: PackageAuditLevel;
-    vulnerable_versions: string;
-    recommendation: string;
-    title: string;
-    url: string;
-    findings: {
-        paths: string[];
-    }[];
-};
-export type PnpmAuditResultJson = {
-    advisories: Record<string, PnpmAuditAdvisory>;
-    metadata: {
-        vulnerabilities: Record<PackageAuditLevel, number>;
-    };
-};

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

@@ -0,0 +1,2 @@
+import { PackageAuditLevel } from '../../config';
+export declare function getVulnerabilitiesTotal(summary: Record<PackageAuditLevel, number>): number;

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

@@ -1,6 +1,3 @@
-import { IssueSeverity } from '@code-pushup/models';
-import { PackageManager } from '../../config';
-import { OutdatedResult, VersionType } from './types';
+import type { IssueSeverity } from '@code-pushup/models';
+import { VersionType } from './types';
 export declare const outdatedSeverity: Record<VersionType, IssueSeverity>;
-export declare const normalizeOutdatedMapper: Record<PackageManager, (output: string) => OutdatedResult>;
-export declare const outdatedArgs: Record<PackageManager, string[]>;

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

@@ -1,7 +1,7 @@
 import { Issue } from '@code-pushup/models';
-import { DependencyGroup, PackageManager } from '../../config';
+import { DependencyGroup, PackageManagerId } from '../../config';
 import { OutdatedResult, PackageVersion, VersionType } from './types';
-export declare function outdatedResultToAuditOutput(result: OutdatedResult, packageManager: PackageManager, dependencyGroup: DependencyGroup): {
+export declare function outdatedResultToAuditOutput(result: OutdatedResult, packageManager: PackageManagerId, depGroup: DependencyGroup): {
     details?: {
         issues: {
             message: string;

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

@@ -9,46 +9,3 @@ export type OutdatedResult = {
     type: DependencyGroupLong;
     url?: string;
 }[];
-export type NpmVersionOverview = {
-    current?: string;
-    latest: string;
-    type: DependencyGroupLong;
-    homepage?: string;
-};
-export type NpmNormalizedOverview = Omit<NpmVersionOverview, 'current'> & {
-    current: string;
-};
-export type NpmOutdatedResultJson = Record<string, NpmVersionOverview>;
-export type Yarnv1VersionOverview = [
-    string,
-    string,
-    string,
-    string,
-    string,
-    DependencyGroupLong,
-    string
-];
-type Yarnv1Info = {
-    type: 'info';
-};
-type Yarnv1Table = {
-    type: 'table';
-    data: {
-        body: Yarnv1VersionOverview[];
-    };
-};
-export type Yarnv1OutdatedResultJson = [Yarnv1Info, Yarnv1Table];
-export type Yarnv2VersionOverview = {
-    current: string;
-    latest: string;
-    name: string;
-    type: DependencyGroupLong;
-};
-export type Yarnv2OutdatedResultJson = Yarnv2VersionOverview[];
-export type PnpmVersionOverview = {
-    current: string;
-    latest: string;
-    dependencyType: DependencyGroupLong;
-};
-export type PnpmOutdatedResultJson = Record<string, PnpmVersionOverview>;
-export {};

package/src/lib/runner/audit/unify-type.d.ts

@@ -1,8 +0,0 @@
-import { AuditResult, NpmAdvisory, NpmFixInformation, NpmVulnerabilities } from './types';
-export declare function npmToAuditResult(output: string): AuditResult;
-export declare function npmToFixInformation(fixAvailable: boolean | NpmFixInformation): string;
-export declare function npmToAdvisory(name: string, vulnerabilities: NpmVulnerabilities, prevNodes?: Set<string>): NpmAdvisory | null;
-export declare function yarnv1ToAuditResult(output: string): AuditResult;
-export declare function yarnv2ToAuditResult(output: string): AuditResult;
-export declare function pnpmToAuditResult(output: string): AuditResult;
-export declare function pnpmToDirectDependency(path: string): string | true;

package/src/lib/runner/outdated/unify-type.d.ts

@@ -1,5 +0,0 @@
-import { OutdatedResult } from './types';
-export declare function npmToOutdatedResult(output: string): OutdatedResult;
-export declare function yarnv1ToOutdatedResult(output: string): OutdatedResult;
-export declare function yarnv2ToOutdatedResult(output: string): OutdatedResult;
-export declare function pnpmToOutdatedResult(output: string): OutdatedResult;