Colin McDonnell
bf68e0d915
GitHub markdown needs a blank line between </details> and subsequent HTML elements. Without it, the footer renders inside the collapsed section. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
77 lines
2.8 KiB
TypeScript
77 lines
2.8 KiB
TypeScript
import { modelAliases } from "../models.ts";
|
||
|
||
export const PULLFROG_DIVIDER = "<!-- PULLFROG_DIVIDER_DO_NOT_REMOVE_PLZ -->";
|
||
|
||
const FROG_LOGO = `<a href="https://pullfrog.com"><picture><source media="(prefers-color-scheme: dark)" srcset="https://pullfrog.com/logos/frog-white-full-18px.png"><img src="https://pullfrog.com/logos/frog-green-full-18px.png" width="9px" height="9px" style="vertical-align: middle; " alt="Pullfrog"></picture></a>`;
|
||
|
||
export interface WorkflowRunFooterInfo {
|
||
owner: string;
|
||
repo: string;
|
||
runId: number;
|
||
/** optional job ID - if provided, will append /job/{jobId} to the workflow run URL */
|
||
jobId?: string | undefined;
|
||
}
|
||
|
||
export interface BuildPullfrogFooterParams {
|
||
/** add "Triggered by Pullfrog" link */
|
||
triggeredBy?: boolean;
|
||
/** add "View workflow run" link */
|
||
workflowRun?: WorkflowRunFooterInfo | undefined;
|
||
/** alternative: just pass a pre-built URL directly (for shortlinks etc.) */
|
||
workflowRunUrl?: string | undefined;
|
||
/** arbitrary custom parts (e.g., action links) */
|
||
customParts?: string[] | undefined;
|
||
/** model slug from payload (e.g., "anthropic/claude-opus"). shown in footer as "Using `Model Name`" */
|
||
model?: string | undefined;
|
||
}
|
||
|
||
function formatModelLabel(slug: string): string {
|
||
const alias = modelAliases.find((a) => a.slug === slug);
|
||
if (!alias) return `\`${slug}\``;
|
||
return alias.isFree ? `\`${alias.displayName}\` (free)` : `\`${alias.displayName}\``;
|
||
}
|
||
|
||
/**
|
||
* build a pullfrog footer with configurable parts
|
||
* always includes: frog logo at start and X link at end
|
||
* order: action links (customParts) > workflow run > model > attribution > reference links
|
||
*/
|
||
export function buildPullfrogFooter(params: BuildPullfrogFooterParams): string {
|
||
const parts: string[] = [];
|
||
|
||
if (params.customParts) {
|
||
parts.push(...params.customParts);
|
||
}
|
||
|
||
if (params.workflowRunUrl) {
|
||
parts.push(`[View workflow run](${params.workflowRunUrl})`);
|
||
} else if (params.workflowRun) {
|
||
const baseUrl = `https://github.com/${params.workflowRun.owner}/${params.workflowRun.repo}/actions/runs/${params.workflowRun.runId}`;
|
||
const url = params.workflowRun.jobId ? `${baseUrl}/job/${params.workflowRun.jobId}` : baseUrl;
|
||
parts.push(`[View workflow run](${url})`);
|
||
}
|
||
|
||
if (params.triggeredBy) {
|
||
parts.push("Triggered by [Pullfrog](https://pullfrog.com)");
|
||
}
|
||
|
||
if (params.model) {
|
||
parts.push(`Using ${formatModelLabel(params.model)}`);
|
||
}
|
||
|
||
const allParts = [...parts, "[𝕏](https://x.com/pullfrogai)"];
|
||
|
||
return `\n\n${PULLFROG_DIVIDER}\n<sup>${FROG_LOGO} ｜ ${allParts.join(" ｜ ")}</sup>`;
|
||
}
|
||
|
||
/**
|
||
* strip any existing pullfrog footer from a comment body
|
||
*/
|
||
export function stripExistingFooter(body: string): string {
|
||
const dividerIndex = body.indexOf(PULLFROG_DIVIDER);
|
||
if (dividerIndex === -1) {
|
||
return body;
|
||
}
|
||
return body.substring(0, dividerIndex).trimEnd();
|
||
}
|