snipe-pr 1.0.0

package/jest.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testMatch: ['**/__tests__/**/*.test.ts'],
+};

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "snipe-pr",
+  "version": "1.0.0",
+  "description": "AI-powered PR descriptions that write themselves",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "tsc && ncc build lib/index.js -o dist",
+    "test": "jest",
+    "all": "npm run build && npm test"
+  },
+  "dependencies": {
+    "@actions/core": "^1.11.1",
+    "@actions/github": "^6.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "@vercel/ncc": "^0.38.3",
+    "typescript": "^5.7.0",
+    "jest": "^29.7.0",
+    "@types/jest": "^29.5.0",
+    "ts-jest": "^29.2.0"
+  },
+  "license": "MIT"
+}

package/src/ai.ts

@@ -0,0 +1,60 @@
+import { FileChange } from './analyzer';
+
+const SNIPELINK_API = 'https://snipelink.com/api/snipe-pr/generate';
+
+export interface AIDescriptionRequest {
+  title: string;
+  diff: string;
+  files: FileChange[];
+  repo: string;
+}
+
+export interface AIDescriptionResponse {
+  ok: boolean;
+  description?: string;
+  error?: string;
+  code?: string;
+}
+
+export async function generateAIDescription(
+  request: AIDescriptionRequest,
+  apiKey: string
+): Promise<AIDescriptionResponse> {
+  try {
+    const response = await fetch(SNIPELINK_API, {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+        Authorization: `Bearer ${apiKey}`,
+      },
+      body: JSON.stringify({
+        title: request.title,
+        diff: request.diff.substring(0, 15000),
+        files: request.files.map((f) => ({
+          filename: f.filename,
+          status: f.status,
+          additions: f.additions,
+          deletions: f.deletions,
+        })),
+        repo: request.repo,
+      }),
+    });
+
+    if (!response.ok) {
+      const body = (await response.json().catch(() => ({}))) as Record<string, string>;
+      return {
+        ok: false,
+        error: body.error || `API returned ${response.status}`,
+        code: body.code,
+      };
+    }
+
+    const data = (await response.json()) as { description: string };
+    return { ok: true, description: data.description };
+  } catch (err) {
+    return {
+      ok: false,
+      error: err instanceof Error ? err.message : 'Unknown error calling SnipeLink API',
+    };
+  }
+}

package/src/analyzer.ts

@@ -0,0 +1,273 @@
+export interface FileChange {
+  filename: string;
+  status: string;
+  additions: number;
+  deletions: number;
+  patch?: string;
+}
+
+export interface AnalysisResult {
+  summary: string;
+  changeType: ChangeType;
+  categories: CategoryGroup[];
+  stats: ChangeStats;
+  highlights: string[];
+}
+
+export interface CategoryGroup {
+  name: string;
+  emoji: string;
+  files: string[];
+}
+
+export interface ChangeStats {
+  filesChanged: number;
+  additions: number;
+  deletions: number;
+  netLines: number;
+}
+
+export type ChangeType =
+  | 'feature'
+  | 'bugfix'
+  | 'refactor'
+  | 'docs'
+  | 'test'
+  | 'config'
+  | 'style'
+  | 'mixed';
+
+const FILE_CATEGORIES: Record<string, { name: string; emoji: string; patterns: RegExp[] }> = {
+  test: {
+    name: 'Tests',
+    emoji: '🧪',
+    patterns: [
+      /\.(test|spec)\.[jt]sx?$/,
+      /__(tests|mocks)__\//,
+      /test[s]?\//i,
+      /\.test\./,
+    ],
+  },
+  docs: {
+    name: 'Documentation',
+    emoji: '📝',
+    patterns: [/\.md$/i, /docs?\//i, /README/i, /CHANGELOG/i, /LICENSE/i],
+  },
+  config: {
+    name: 'Configuration',
+    emoji: '⚙️',
+    patterns: [
+      /\.(json|ya?ml|toml|ini|env)$/,
+      /\.config\.[jt]s$/,
+      /Dockerfile/,
+      /docker-compose/,
+      /\.github\//,
+      /\.eslint/,
+      /\.prettier/,
+      /tsconfig/,
+    ],
+  },
+  style: {
+    name: 'Styling',
+    emoji: '🎨',
+    patterns: [/\.(css|scss|sass|less|styled)\b/, /tailwind/, /\.svg$/],
+  },
+  migration: {
+    name: 'Database',
+    emoji: '🗄️',
+    patterns: [/migrat/i, /schema/i, /seed/i, /\.sql$/],
+  },
+  ci: {
+    name: 'CI/CD',
+    emoji: '🔄',
+    patterns: [/\.github\/workflows/, /\.gitlab-ci/, /Jenkinsfile/, /\.circleci/],
+  },
+  deps: {
+    name: 'Dependencies',
+    emoji: '📦',
+    patterns: [/package(-lock)?\.json$/, /yarn\.lock$/, /pnpm-lock/, /Gemfile/, /requirements.*\.txt$/, /go\.(mod|sum)$/],
+  },
+  api: {
+    name: 'API',
+    emoji: '🔌',
+    patterns: [/routes?\//i, /api\//i, /controllers?\//i, /handlers?\//i, /endpoints?\//i],
+  },
+  ui: {
+    name: 'UI Components',
+    emoji: '🖼️',
+    patterns: [/components?\//i, /pages?\//i, /views?\//i, /\.[jt]sx$/],
+  },
+  core: {
+    name: 'Core Logic',
+    emoji: '🔧',
+    patterns: [/src\//, /lib\//, /\.[jt]s$/],
+  },
+};
+
+function categorizeFile(filename: string): string {
+  for (const [key, cat] of Object.entries(FILE_CATEGORIES)) {
+    if (cat.patterns.some((p) => p.test(filename))) {
+      return key;
+    }
+  }
+  return 'core';
+}
+
+function detectChangeType(files: FileChange[], patches: string): ChangeType {
+  const categories = new Set(files.map((f) => categorizeFile(f.filename)));
+
+  if (categories.size === 1 && categories.has('test')) return 'test';
+  if (categories.size === 1 && categories.has('docs')) return 'docs';
+  if (categories.size === 1 && categories.has('config')) return 'config';
+  if (categories.size === 1 && categories.has('style')) return 'style';
+
+  const lowerPatch = patches.toLowerCase();
+  const bugSignals = ['fix', 'bug', 'patch', 'hotfix', 'issue', 'error', 'crash', 'broken'];
+  const featureSignals = ['feat', 'add', 'new', 'implement', 'create', 'introduce'];
+  const refactorSignals = ['refactor', 'rename', 'move', 'extract', 'simplify', 'clean'];
+
+  const bugScore = bugSignals.filter((s) => lowerPatch.includes(s)).length;
+  const featureScore = featureSignals.filter((s) => lowerPatch.includes(s)).length;
+  const refactorScore = refactorSignals.filter((s) => lowerPatch.includes(s)).length;
+
+  const maxScore = Math.max(bugScore, featureScore, refactorScore);
+  if (maxScore === 0) return 'mixed';
+  if (bugScore === maxScore) return 'bugfix';
+  if (featureScore === maxScore) return 'feature';
+  if (refactorScore === maxScore) return 'refactor';
+
+  return 'mixed';
+}
+
+function extractHighlights(files: FileChange[]): string[] {
+  const highlights: string[] = [];
+
+  const newFiles = files.filter((f) => f.status === 'added');
+  const deletedFiles = files.filter((f) => f.status === 'removed');
+  const renamedFiles = files.filter((f) => f.status === 'renamed');
+
+  if (newFiles.length > 0) {
+    highlights.push(
+      `Added ${newFiles.length} new file${newFiles.length > 1 ? 's' : ''}: ${newFiles
+        .slice(0, 3)
+        .map((f) => `\`${f.filename.split('/').pop()}\``)
+        .join(', ')}${newFiles.length > 3 ? ` and ${newFiles.length - 3} more` : ''}`
+    );
+  }
+
+  if (deletedFiles.length > 0) {
+    highlights.push(
+      `Removed ${deletedFiles.length} file${deletedFiles.length > 1 ? 's' : ''}`
+    );
+  }
+
+  if (renamedFiles.length > 0) {
+    highlights.push(
+      `Renamed ${renamedFiles.length} file${renamedFiles.length > 1 ? 's' : ''}`
+    );
+  }
+
+  const bigChanges = files
+    .filter((f) => f.additions + f.deletions > 100)
+    .sort((a, b) => b.additions + b.deletions - (a.additions + a.deletions));
+
+  if (bigChanges.length > 0) {
+    const top = bigChanges[0];
+    highlights.push(
+      `Largest change: \`${top.filename.split('/').pop()}\` (+${top.additions}/-${top.deletions})`
+    );
+  }
+
+  return highlights;
+}
+
+const CHANGE_TYPE_LABELS: Record<ChangeType, { emoji: string; label: string }> = {
+  feature: { emoji: '✨', label: 'New Feature' },
+  bugfix: { emoji: '🐛', label: 'Bug Fix' },
+  refactor: { emoji: '♻️', label: 'Refactor' },
+  docs: { emoji: '📝', label: 'Documentation' },
+  test: { emoji: '🧪', label: 'Tests' },
+  config: { emoji: '⚙️', label: 'Configuration' },
+  style: { emoji: '🎨', label: 'Styling' },
+  mixed: { emoji: '🔀', label: 'Mixed Changes' },
+};
+
+export function analyzeChanges(files: FileChange[], diff: string): AnalysisResult {
+  const stats: ChangeStats = {
+    filesChanged: files.length,
+    additions: files.reduce((sum, f) => sum + f.additions, 0),
+    deletions: files.reduce((sum, f) => sum + f.deletions, 0),
+    netLines: files.reduce((sum, f) => sum + f.additions - f.deletions, 0),
+  };
+
+  const changeType = detectChangeType(files, diff);
+  const highlights = extractHighlights(files);
+
+  // Group files by category
+  const groups = new Map<string, string[]>();
+  for (const file of files) {
+    const cat = categorizeFile(file.filename);
+    if (!groups.has(cat)) groups.set(cat, []);
+    groups.get(cat)!.push(file.filename);
+  }
+
+  const categories: CategoryGroup[] = [];
+  for (const [key, filenames] of groups) {
+    const catDef = FILE_CATEGORIES[key];
+    if (catDef) {
+      categories.push({ name: catDef.name, emoji: catDef.emoji, files: filenames });
+    }
+  }
+
+  // Sort: largest groups first
+  categories.sort((a, b) => b.files.length - a.files.length);
+
+  const typeInfo = CHANGE_TYPE_LABELS[changeType];
+  const summary = `${typeInfo.emoji} **${typeInfo.label}** — ${stats.filesChanged} file${stats.filesChanged !== 1 ? 's' : ''} changed (+${stats.additions}/-${stats.deletions})`;
+
+  return { summary, changeType, categories, stats, highlights };
+}
+
+export function formatDescription(analysis: AnalysisResult, prTitle: string): string {
+  const lines: string[] = [];
+
+  lines.push(`## ${analysis.summary}`);
+  lines.push('');
+
+  // Highlights
+  if (analysis.highlights.length > 0) {
+    lines.push('### Highlights');
+    for (const h of analysis.highlights) {
+      lines.push(`- ${h}`);
+    }
+    lines.push('');
+  }
+
+  // File categories
+  lines.push('### Changes');
+  for (const cat of analysis.categories) {
+    const fileList = cat.files
+      .slice(0, 8)
+      .map((f) => `\`${f}\``)
+      .join(', ');
+    const more = cat.files.length > 8 ? ` and ${cat.files.length - 8} more` : '';
+    lines.push(`- ${cat.emoji} **${cat.name}**: ${fileList}${more}`);
+  }
+  lines.push('');
+
+  // Stats bar
+  const total = analysis.stats.additions + analysis.stats.deletions;
+  const addPct = total > 0 ? Math.round((analysis.stats.additions / total) * 20) : 0;
+  const delPct = 20 - addPct;
+  const bar = '🟩'.repeat(addPct) + '🟥'.repeat(delPct);
+  lines.push(`<sub>${bar} +${analysis.stats.additions} / -${analysis.stats.deletions} (net ${analysis.stats.netLines >= 0 ? '+' : ''}${analysis.stats.netLines})</sub>`);
+  lines.push('');
+
+  // Footer
+  lines.push('---');
+  lines.push(
+    '<sub>Generated by <a href="https://snipelink.com">Snipe PR</a> — auto PR descriptions for your team | <a href="https://snipelink.com/tools">Get AI-powered descriptions →</a></sub>'
+  );
+
+  return lines.join('\n');
+}

package/src/index.ts

@@ -0,0 +1,156 @@
+import * as core from '@actions/core';
+import * as github from '@actions/github';
+import { analyzeChanges, formatDescription, FileChange } from './analyzer';
+import { generateAIDescription } from './ai';
+
+const COMMENT_MARKER = '<!-- snipe-pr-description -->';
+
+async function run(): Promise<void> {
+  try {
+    const token = core.getInput('github-token', { required: true });
+    const snipelinkKey = core.getInput('snipelink-key');
+    const mode = core.getInput('mode') || 'comment';
+    const includeStats = core.getInput('include-stats') !== 'false';
+    const maxDiffSize = parseInt(core.getInput('max-diff-size') || '10000', 10);
+
+    const octokit = github.getOctokit(token);
+    const { owner, repo } = github.context.repo;
+    const pr = github.context.payload.pull_request;
+
+    if (!pr) {
+      core.setFailed('This action only runs on pull_request events.');
+      return;
+    }
+
+    const pullNumber = pr.number;
+    const prTitle = pr.title || '';
+
+    core.info(`Analyzing PR #${pullNumber}: ${prTitle}`);
+
+    // Fetch diff
+    const { data: diffData } = await octokit.rest.pulls.get({
+      owner,
+      repo,
+      pull_number: pullNumber,
+      mediaType: { format: 'diff' },
+    });
+    const diff = (typeof diffData === 'string' ? diffData : String(diffData)).substring(
+      0,
+      maxDiffSize
+    );
+
+    // Fetch changed files
+    const allFiles: FileChange[] = [];
+    let page = 1;
+    while (true) {
+      const { data: filesPage } = await octokit.rest.pulls.listFiles({
+        owner,
+        repo,
+        pull_number: pullNumber,
+        per_page: 100,
+        page,
+      });
+      if (filesPage.length === 0) break;
+      for (const f of filesPage) {
+        allFiles.push({
+          filename: f.filename,
+          status: f.status,
+          additions: f.additions,
+          deletions: f.deletions,
+          patch: f.patch,
+        });
+      }
+      if (filesPage.length < 100) break;
+      page++;
+    }
+
+    core.info(`Found ${allFiles.length} changed files`);
+
+    let description: string;
+
+    // Try AI-powered description if SnipeLink key provided
+    if (snipelinkKey) {
+      core.info('SnipeLink API key detected — generating AI-powered description...');
+      const aiResult = await generateAIDescription(
+        { title: prTitle, diff, files: allFiles, repo: `${owner}/${repo}` },
+        snipelinkKey
+      );
+
+      if (aiResult.ok && aiResult.description) {
+        description = aiResult.description;
+        description += '\n\n---';
+        description +=
+          '\n<sub>AI-powered by <a href="https://snipelink.com">Snipe PR Pro</a> — smarter PR descriptions for your team</sub>';
+        core.info('AI description generated successfully');
+      } else {
+        core.warning(
+          `AI generation failed (${aiResult.error}), falling back to template-based description`
+        );
+        const analysis = analyzeChanges(allFiles, diff);
+        description = formatDescription(analysis, prTitle);
+      }
+    } else {
+      // Free tier: template-based analysis
+      const analysis = analyzeChanges(allFiles, diff);
+      description = formatDescription(analysis, prTitle);
+    }
+
+    // Prepend marker for idempotent updates
+    const body = `${COMMENT_MARKER}\n${description}`;
+
+    if (mode === 'body') {
+      // Update PR body
+      await octokit.rest.pulls.update({
+        owner,
+        repo,
+        pull_number: pullNumber,
+        body: body,
+      });
+      core.info('Updated PR body with generated description');
+    } else {
+      // Post or update comment
+      const { data: comments } = await octokit.rest.issues.listComments({
+        owner,
+        repo,
+        issue_number: pullNumber,
+        per_page: 100,
+      });
+
+      const existing = comments.find(
+        (c) =>
+          c.user?.login === 'github-actions[bot]' && c.body?.includes(COMMENT_MARKER)
+      );
+
+      if (existing) {
+        await octokit.rest.issues.updateComment({
+          owner,
+          repo,
+          comment_id: existing.id,
+          body,
+        });
+        core.info(`Updated existing comment (ID: ${existing.id})`);
+        core.setOutput('comment-id', existing.id.toString());
+      } else {
+        const { data: newComment } = await octokit.rest.issues.createComment({
+          owner,
+          repo,
+          issue_number: pullNumber,
+          body,
+        });
+        core.info(`Posted new comment (ID: ${newComment.id})`);
+        core.setOutput('comment-id', newComment.id.toString());
+      }
+    }
+
+    core.setOutput('description', description);
+    core.info('Snipe PR completed successfully');
+  } catch (error) {
+    if (error instanceof Error) {
+      core.setFailed(error.message);
+    } else {
+      core.setFailed('An unexpected error occurred');
+    }
+  }
+}
+
+run();

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "commonjs",
+    "lib": ["ES2022"],
+    "outDir": "./lib",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "lib", "__tests__"]
+}