@code-pushup/js-packages-plugin 0.26.1

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@code-pushup/js-packages-plugin",
+  "version": "0.26.1",
+  "dependencies": {
+    "@code-pushup/models": "*",
+    "@code-pushup/utils": "*",
+    "zod": "^3.22.4"
+  },
+  "license": "MIT",
+  "homepage": "https://github.com/code-pushup/cli#readme",
+  "bugs": {
+    "url": "https://github.com/code-pushup/cli/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/code-pushup/cli.git",
+    "directory": "packages/plugin-js-packages"
+  },
+  "contributors": [
+    {
+      "name": "Igor Katsuba",
+      "email": "igor@katsuba.dev",
+      "url": "https://katsuba.dev"
+    },
+    {
+      "name": "Kateřina Pilátová",
+      "email": "katerina.pilatova@flowup.cz",
+      "url": "https://github.com/Tlacenka"
+    },
+    {
+      "name": "Matěj Chalk",
+      "email": "matej.chalk@flowup.cz",
+      "url": "https://github.com/matejchalk"
+    },
+    {
+      "name": "Michael Hladky",
+      "email": "michael.hladky@push-based.io",
+      "url": "https://push-based.io"
+    },
+    {
+      "name": "Michael Seredenko",
+      "email": "misha.seredenko@push-based.io",
+      "url": "https://github.com/MishaSeredenkoPushBased"
+    }
+  ],
+  "type": "module",
+  "main": "./index.js",
+  "types": "./src/index.d.ts"
+}

package/src/bin.d.ts

@@ -0,0 +1 @@
+export {};

package/src/index.d.ts

@@ -0,0 +1,3 @@
+import { jsPackagesPlugin } from './lib/js-packages-plugin';
+export default jsPackagesPlugin;
+export type { JSPackagesPluginConfig } from './lib/config';

package/src/lib/config.d.ts

@@ -0,0 +1,28 @@
+import { z } from 'zod';
+import { IssueSeverity } from '@code-pushup/models';
+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>;
+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>;
+export declare function fillAuditLevelMapping(mapping: Partial<Record<PackageAuditLevel, IssueSeverity>>): Record<PackageAuditLevel, IssueSeverity>;
+export declare const jsPackagesPluginConfigSchema: z.ZodObject<{
+    checks: z.ZodDefault<z.ZodArray<z.ZodEnum<["audit", "outdated"]>, "many">>;
+    packageManager: z.ZodEnum<["npm", "yarn-classic", "yarn-modern", "pnpm"]>;
+    auditLevelMapping: z.ZodEffects<z.ZodDefault<z.ZodRecord<z.ZodEnum<["critical", "high", "moderate", "low", "info"]>, z.ZodEnum<["info", "warning", "error"]>>>, Record<"info" | "critical" | "high" | "moderate" | "low", "error" | "info" | "warning">, Partial<Record<"info" | "critical" | "high" | "moderate" | "low", "error" | "info" | "warning">> | undefined>;
+}, "strip", z.ZodTypeAny, {
+    checks: ("audit" | "outdated")[];
+    packageManager: "npm" | "pnpm" | "yarn-classic" | "yarn-modern";
+    auditLevelMapping: Record<"info" | "critical" | "high" | "moderate" | "low", "error" | "info" | "warning">;
+}, {
+    packageManager: "npm" | "pnpm" | "yarn-classic" | "yarn-modern";
+    checks?: ("audit" | "outdated")[] | undefined;
+    auditLevelMapping?: Partial<Record<"info" | "critical" | "high" | "moderate" | "low", "error" | "info" | "warning">> | undefined;
+}>;
+export type JSPackagesPluginConfig = z.input<typeof jsPackagesPluginConfigSchema>;
+export type FinalJSPackagesPluginConfig = z.infer<typeof jsPackagesPluginConfigSchema>;
+export {};

package/src/lib/constants.d.ts

@@ -0,0 +1,9 @@
+import { IssueSeverity, MaterialIcon } from '@code-pushup/models';
+import type { DependencyGroup, PackageAuditLevel, PackageManager } from './config';
+export declare const defaultAuditLevelMapping: Record<PackageAuditLevel, IssueSeverity>;
+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 dependencyDocs: Record<DependencyGroup, string>;

package/src/lib/js-packages-plugin.d.ts

@@ -0,0 +1,19 @@
+import type { PluginConfig } from '@code-pushup/models';
+import { JSPackagesPluginConfig } from './config';
+/**
+ * Instantiates Code PushUp JS packages plugin for core config.
+ *
+ * @example
+ * import jsPackagesPlugin from '@code-pushup/js-packages-plugin'
+ *
+ * export default {
+ *   // ... core config ...
+ *   plugins: [
+ *     // ... other plugins ...
+ *     await jsPackagesPlugin({ packageManager: 'npm' })
+ *   ]
+ * }
+ *
+ * @returns Plugin configuration.
+ */
+export declare function jsPackagesPlugin(config: JSPackagesPluginConfig): Promise<PluginConfig>;

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

@@ -0,0 +1,2 @@
+import { PackageAuditLevel } from '../../config';
+export declare const auditScoreModifiers: Record<PackageAuditLevel, number>;

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

@@ -0,0 +1,7 @@
+import type { AuditOutput, Issue, IssueSeverity } from '@code-pushup/models';
+import { DependencyGroup, PackageAuditLevel } from '../../config';
+import { NpmAuditResultJson, Vulnerabilities } from './types';
+export declare function auditResultToAuditOutput(result: NpmAuditResultJson, dependenciesType: DependencyGroup, auditLevelMapping: Record<PackageAuditLevel, IssueSeverity>): AuditOutput;
+export declare function calculateAuditScore(stats: Record<PackageAuditLevel | 'total', number>): number;
+export declare function vulnerabilitiesToDisplayValue(vulnerabilities: Record<PackageAuditLevel | 'total', number>): string;
+export declare function vulnerabilitiesToIssues(vulnerabilities: Vulnerabilities, auditLevelMapping: Record<PackageAuditLevel, IssueSeverity>): Issue[];

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

@@ -0,0 +1,27 @@
+import type { PackageAuditLevel } from '../../config';
+type Advisory = {
+    title: string;
+    url: string;
+};
+type FixInformation = {
+    name: string;
+    version: string;
+    isSemVerMajor: boolean;
+};
+export type Vulnerability = {
+    name: string;
+    severity: PackageAuditLevel;
+    via: Advisory[] | string[];
+    range: string;
+    fixAvailable: boolean | FixInformation;
+};
+export type Vulnerabilities = {
+    [key: string]: Vulnerability;
+};
+export type NpmAuditResultJson = {
+    vulnerabilities: Vulnerabilities;
+    metadata: {
+        vulnerabilities: Record<PackageAuditLevel | 'total', number>;
+    };
+};
+export {};

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

@@ -0,0 +1,3 @@
+export declare const WORKDIR: string;
+export declare const RUNNER_OUTPUT_PATH: string;
+export declare const PLUGIN_CONFIG_PATH: string;

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

@@ -0,0 +1,4 @@
+import type { RunnerConfig } from '@code-pushup/models';
+import { FinalJSPackagesPluginConfig } from '../config';
+export declare function createRunnerConfig(scriptPath: string, config: FinalJSPackagesPluginConfig): Promise<RunnerConfig>;
+export declare function executeRunner(): Promise<void>;

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

@@ -0,0 +1,3 @@
+import { IssueSeverity } from '@code-pushup/models';
+import { VersionType } from './types';
+export declare const outdatedSeverity: Record<VersionType, IssueSeverity>;

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

@@ -0,0 +1,29 @@
+import { Issue } from '@code-pushup/models';
+import { DependencyGroup } from '../../config';
+import { NormalizedOutdatedEntries, NpmOutdatedResultJson, PackageVersion, VersionType } from './types';
+export declare function outdatedResultToAuditOutput(result: NpmOutdatedResultJson, dependenciesType: DependencyGroup): {
+    details?: {
+        issues: {
+            message: string;
+            severity: "error" | "info" | "warning";
+            source?: {
+                file: string;
+                position?: {
+                    startLine: number;
+                    startColumn?: number | undefined;
+                    endLine?: number | undefined;
+                    endColumn?: number | undefined;
+                } | undefined;
+            } | undefined;
+        }[];
+    } | undefined;
+    slug: string;
+    score: number;
+    value: number;
+    displayValue: string;
+};
+export declare function calculateOutdatedScore(majorOutdated: number, totalDeps: number): number;
+export declare function outdatedToDisplayValue(majorOutdated: number, totalOutdated: number): string;
+export declare function outdatedToIssues(dependencies: NormalizedOutdatedEntries): Issue[];
+export declare function getOutdatedLevel(currentFullVersion: string, wantedFullVersion: string): VersionType;
+export declare function splitPackageVersion(fullVersion: string): PackageVersion;

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

@@ -0,0 +1,15 @@
+export type VersionType = 'major' | 'minor' | 'patch';
+export type PackageVersion = Record<VersionType, number>;
+export type VersionOverview = {
+    current?: string;
+    wanted: string;
+    type: 'dependencies' | 'devDependencies' | 'optionalDependencies';
+    homepage?: string;
+};
+export type NormalizedVersionOverview = Omit<VersionOverview, 'current'> & {
+    current: string;
+};
+export type NormalizedOutdatedEntries = [string, NormalizedVersionOverview][];
+export type NpmOutdatedResultJson = {
+    [key: string]: VersionOverview;
+};