@code-pushup/ci 0.52.0

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@code-pushup/ci",
+  "version": "0.52.0",
+  "description": "CI automation logic for Code PushUp (provider-agnostic)",
+  "dependencies": {
+    "@code-pushup/models": "0.52.0",
+    "@code-pushup/utils": "0.52.0",
+    "glob": "^10.4.5",
+    "simple-git": "^3.20.0",
+    "yaml": "^2.5.1"
+  },
+  "license": "MIT",
+  "homepage": "https://github.com/code-pushup/cli/tree/main/packages/ci#readme",
+  "bugs": {
+    "url": "https://github.com/code-pushup/cli/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/code-pushup/cli.git",
+    "directory": "packages/ci"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "main": "./index.js",
+  "types": "./src/index.d.ts"
+}

package/src/index.d.ts

@@ -0,0 +1,2 @@
+export type * from './lib/models';
+export { runInCI } from './lib/run';

package/src/lib/cli/commands/collect.d.ts

@@ -0,0 +1,3 @@
+import type { CommandContext } from '../context';
+import { type PersistedCliFiles } from '../persist';
+export declare function runCollect({ bin, config, directory, silent, project, }: CommandContext): Promise<PersistedCliFiles>;

package/src/lib/cli/commands/compare.d.ts

@@ -0,0 +1,9 @@
+import type { CommandContext } from '../context';
+import { type PersistedCliFiles } from '../persist';
+type CompareOptions = {
+    before: string;
+    after: string;
+    label?: string;
+};
+export declare function runCompare({ before, after, label }: CompareOptions, { bin, config, directory, silent, project }: CommandContext): Promise<PersistedCliFiles>;
+export {};

package/src/lib/cli/commands/merge-diffs.d.ts

@@ -0,0 +1,3 @@
+import type { CommandContext } from '../context';
+import { type PersistedCliFiles } from '../persist';
+export declare function runMergeDiffs(files: string[], { bin, config, directory, silent }: CommandContext): Promise<PersistedCliFiles<'md'>>;

package/src/lib/cli/commands/print-config.d.ts

@@ -0,0 +1,2 @@
+import type { CommandContext } from '../context';
+export declare function runPrintConfig({ bin, config, directory, silent, }: CommandContext): Promise<void>;

package/src/lib/cli/context.d.ts

@@ -0,0 +1,6 @@
+import type { Settings } from '../models';
+import type { ProjectConfig } from '../monorepo';
+export type CommandContext = Pick<Settings, 'bin' | 'config' | 'directory' | 'silent'> & {
+    project?: string;
+};
+export declare function createCommandContext(settings: Settings, project: ProjectConfig | null | undefined): CommandContext;

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

@@ -0,0 +1,6 @@
+export { runCollect } from './commands/collect';
+export { runCompare } from './commands/compare';
+export { runMergeDiffs } from './commands/merge-diffs';
+export { runPrintConfig } from './commands/print-config';
+export { createCommandContext, type CommandContext } from './context';
+export { findPersistedFiles, type PersistedCliFiles } from './persist';

package/src/lib/cli/persist.d.ts

@@ -0,0 +1,21 @@
+import { type Format } from '@code-pushup/models';
+export type PersistedCliFiles<T extends Format = Format> = PersistedCliFilesFormats<T> & {
+    artifactData: {
+        rootDir: string;
+        files: string[];
+    };
+};
+export type PersistedCliFilesFormats<T extends Format = Format> = {
+    [F in T as `${F}FilePath`]: string;
+};
+export declare function persistCliOptions({ directory, project, }: {
+    directory: string;
+    project?: string;
+}): string[];
+export declare function persistedCliFiles<TFormat extends Format = Format>({ directory, isDiff, project, formats, }: {
+    directory: string;
+    isDiff?: boolean;
+    project?: string;
+    formats?: TFormat[];
+}): PersistedCliFiles<TFormat>;
+export declare function findPersistedFiles(rootDir: string, files: string[], project?: string): PersistedCliFiles;

package/src/lib/comment.d.ts

@@ -0,0 +1,2 @@
+import type { Logger, ProviderAPIClient } from './models';
+export declare function commentOnPR(mdPath: string, api: ProviderAPIClient, logger: Logger): Promise<number>;

package/src/lib/constants.d.ts

@@ -0,0 +1,2 @@
+import type { Settings } from './models';
+export declare const DEFAULT_SETTINGS: Settings;

package/src/lib/git.d.ts

@@ -0,0 +1,23 @@
+export type ChangedFiles = Record<string, ChangedFile>;
+type ChangedFile = {
+    originalFile?: string;
+    lineChanges: LineChange[];
+};
+type LineChange = {
+    prev: {
+        line: number;
+        count: number;
+    };
+    curr: {
+        line: number;
+        count: number;
+    };
+};
+export declare function listChangedFiles(refs: {
+    base: string;
+    head: string;
+}, git?: import("simple-git").SimpleGit): Promise<ChangedFiles>;
+export declare function isFileChanged(changedFiles: ChangedFiles, file: string): boolean;
+export declare function adjustFileName(changedFiles: ChangedFiles, file: string): string;
+export declare function adjustLine(changedFiles: ChangedFiles, file: string, line: number): number;
+export {};

package/src/lib/issues.d.ts

@@ -0,0 +1,16 @@
+import type { Audit, Issue, PluginMeta, Report, ReportsDiff } from '@code-pushup/models';
+import { type ChangedFiles } from './git';
+export type SourceFileIssue = Required<Issue> & IssueContext;
+type IssueContext = {
+    audit: Pick<Audit, 'slug' | 'title'>;
+    plugin: Pick<PluginMeta, 'slug' | 'title'>;
+};
+export declare function filterRelevantIssues({ currReport, prevReport, reportsDiff, changedFiles, }: {
+    currReport: Report;
+    prevReport: Report;
+    reportsDiff: ReportsDiff;
+    changedFiles: ChangedFiles;
+}): SourceFileIssue[];
+export declare function issuesMatch(prev: SourceFileIssue, curr: SourceFileIssue, changedFiles: ChangedFiles): boolean;
+export declare function getAuditImpactValue({ audit, plugin }: IssueContext, report: Report): number;
+export {};

package/src/lib/models.d.ts

@@ -0,0 +1,102 @@
+import type { SourceFileIssue } from './issues';
+import type { MonorepoTool } from './monorepo';
+/**
+ * Customization options for {@link runInCI}
+ * @see https://github.com/code-pushup/cli/tree/main/packages/ci#options
+ */
+export type Options = {
+    monorepo?: boolean | MonorepoTool;
+    projects?: string[] | null;
+    task?: string;
+    bin?: string;
+    config?: string | null;
+    directory?: string;
+    silent?: boolean;
+    debug?: boolean;
+    detectNewIssues?: boolean;
+    logger?: Logger;
+};
+/**
+ * {@link Options} with filled-in defaults.
+ */
+export type Settings = Required<Options>;
+/**
+ * Branches/commits for {@link runInCI}
+ */
+export type GitRefs = {
+    head: GitBranch;
+    base?: GitBranch;
+};
+/**
+ * API client for {@link runInCI} - adapter for CI provider
+ * @see https://github.com/code-pushup/cli/tree/main/packages/ci#provider-api-client
+ */
+export type ProviderAPIClient = {
+    maxCommentChars: number;
+    downloadReportArtifact?: () => Promise<string | null>;
+    listComments: () => Promise<Comment[]>;
+    updateComment: (id: number, body: string) => Promise<Comment>;
+    createComment: (body: string) => Promise<Comment>;
+};
+/**
+ * PR comment from {@link ProviderAPIClient}
+ */
+export type Comment = {
+    id: number;
+    body: string;
+    url: string;
+};
+/**
+ * Git ref (e.g. 'main') and commit sha (e.g. '9d7568265bd5b17d1bb51a6eb6407e0d387058d2')
+ */
+export type GitBranch = {
+    ref: string;
+    sha: string;
+};
+/**
+ * Logger instance (e.g. `console`) for reporting progress and problems
+ */
+export type Logger = {
+    error: (message: string) => void;
+    warn: (message: string) => void;
+    info: (message: string) => void;
+    debug: (message: string) => void;
+};
+/**
+ * Resolved return value of {@link runInCI}
+ */
+export type RunResult = StandaloneRunResult | MonorepoRunResult;
+/**
+ * Resolved return value of {@link runInCI} in standalone mode
+ */
+export type StandaloneRunResult = Omit<ProjectRunResult, 'name'> & {
+    mode: 'standalone';
+    commentId?: number;
+};
+/**
+ * Resolved return value of {@link runInCI} in monorepo mode
+ */
+export type MonorepoRunResult = {
+    mode: 'monorepo';
+    projects: ProjectRunResult[];
+    commentId?: number;
+    diffArtifact?: ArtifactData;
+};
+/**
+ * Result of {@link runInCI} for a single project
+ */
+export type ProjectRunResult = {
+    name: string;
+    artifacts: {
+        report: ArtifactData;
+        diff?: ArtifactData;
+    };
+    newIssues?: SourceFileIssue[];
+};
+/**
+ * Paths to output files from {@link runInCI}, for uploading as job artifact
+ */
+export type ArtifactData = {
+    rootDir: string;
+    files: string[];
+};

package/src/lib/monorepo/detect-tool.d.ts

@@ -0,0 +1,2 @@
+import type { MonorepoHandlerOptions, MonorepoTool } from './tools';
+export declare function detectMonorepoTool(options: MonorepoHandlerOptions): Promise<MonorepoTool | null>;

package/src/lib/monorepo/handlers/index.d.ts

@@ -0,0 +1,3 @@
+import type { MonorepoTool, MonorepoToolHandler } from '../tools';
+export declare const MONOREPO_TOOL_HANDLERS: MonorepoToolHandler[];
+export declare function getToolHandler(tool: MonorepoTool): MonorepoToolHandler;

package/src/lib/monorepo/handlers/npm.d.ts

@@ -0,0 +1,2 @@
+import type { MonorepoToolHandler } from '../tools';
+export declare const npmHandler: MonorepoToolHandler;

package/src/lib/monorepo/handlers/nx.d.ts

@@ -0,0 +1,2 @@
+import type { MonorepoToolHandler } from '../tools';
+export declare const nxHandler: MonorepoToolHandler;

package/src/lib/monorepo/handlers/pnpm.d.ts

@@ -0,0 +1,2 @@
+import type { MonorepoToolHandler } from '../tools';
+export declare const pnpmHandler: MonorepoToolHandler;

package/src/lib/monorepo/handlers/turbo.d.ts

@@ -0,0 +1,2 @@
+import type { MonorepoToolHandler } from '../tools';
+export declare const turboHandler: MonorepoToolHandler;

package/src/lib/monorepo/handlers/yarn.d.ts

@@ -0,0 +1,2 @@
+import type { MonorepoToolHandler } from '../tools';
+export declare const yarnHandler: MonorepoToolHandler;

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

@@ -0,0 +1,2 @@
+export { listMonorepoProjects } from './list-projects';
+export { MONOREPO_TOOLS, type MonorepoTool, type ProjectConfig } from './tools';

package/src/lib/monorepo/list-projects.d.ts

@@ -0,0 +1,3 @@
+import type { Settings } from '../models';
+import type { ProjectConfig } from './tools';
+export declare function listMonorepoProjects(settings: Settings): Promise<ProjectConfig[]>;

package/src/lib/monorepo/packages.d.ts

@@ -0,0 +1,17 @@
+import type { PackageJson } from 'type-fest';
+type WorkspacePackage = {
+    name: string;
+    directory: string;
+    packageJson: PackageJson;
+};
+export declare function listPackages(cwd: string, patterns?: string[]): Promise<WorkspacePackage[]>;
+export declare function listWorkspaces(cwd: string): Promise<{
+    workspaces: WorkspacePackage[];
+    rootPackageJson: PackageJson;
+}>;
+export declare function hasWorkspacesEnabled(cwd: string): Promise<boolean>;
+export declare function readRootPackageJson(cwd: string): Promise<PackageJson>;
+export declare function hasDependency(packageJson: PackageJson, name: string): boolean;
+export declare function hasScript(packageJson: PackageJson, script: string): boolean;
+export declare function hasCodePushUpDependency(packageJson: PackageJson): boolean;
+export {};

package/src/lib/monorepo/tools.d.ts

@@ -0,0 +1,18 @@
+import type { ProcessObserver } from '@code-pushup/utils';
+export declare const MONOREPO_TOOLS: readonly ["nx", "turbo", "yarn", "pnpm", "npm"];
+export type MonorepoTool = (typeof MONOREPO_TOOLS)[number];
+export type MonorepoToolHandler = {
+    tool: MonorepoTool;
+    isConfigured: (options: MonorepoHandlerOptions) => Promise<boolean>;
+    listProjects: (options: MonorepoHandlerOptions) => Promise<ProjectConfig[]>;
+};
+export type MonorepoHandlerOptions = {
+    task: string;
+    cwd: string;
+    observer?: ProcessObserver;
+};
+export type ProjectConfig = {
+    name: string;
+    bin: string;
+    directory?: string;
+};

package/src/lib/run.d.ts

@@ -0,0 +1,11 @@
+import { type SimpleGit } from 'simple-git';
+import type { GitRefs, Options, ProviderAPIClient, RunResult } from './models';
+/**
+ * Runs Code PushUp in CI environment.
+ * @param refs Git branches (head and optional base)
+ * @param api API client for given provider
+ * @param options Additional options (e.g. monorepo mode)
+ * @param git instance of simple-git - useful for testing
+ * @returns result of run (standalone or monorepo)
+ */
+export declare function runInCI(refs: GitRefs, api: ProviderAPIClient, options?: Options, git?: SimpleGit): Promise<RunResult>;