snipe-pr 1.0.0

package/.github/workflows/snipe-pr.yml

@@ -0,0 +1,15 @@
+name: Snipe PR
+on:
+  pull_request:
+    types: [opened, synchronize]
+
+permissions:
+  pull-requests: write
+
+jobs:
+  describe:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: klawgulp-ship-it/snipe-pr@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 SnipeLink LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,85 @@
+# Snipe PR ⚡
+
+**Auto-generated PR descriptions that actually make sense.**
+
+Snipe PR analyzes your pull request diffs and generates structured, readable descriptions — so your team spends less time writing and more time shipping.
+
+## Quick Start
+
+Add to `.github/workflows/snipe-pr.yml`:
+
+```yaml
+name: Snipe PR
+on:
+  pull_request:
+    types: [opened, synchronize]
+
+jobs:
+  describe:
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+      - uses: klawgulp-ship-it/snipe-pr@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+```
+
+That's it. Every PR gets an auto-generated description with:
+- Change type detection (feature, bugfix, refactor, docs, etc.)
+- Smart file categorization (API, UI, Tests, Config, etc.)
+- Visual stats bar showing additions vs deletions
+- Key highlights (new files, large changes, renames)
+
+## Example Output
+
+> ## ✨ **New Feature** — 5 files changed (+120/-15)
+>
+> ### Highlights
+> - Added 2 new files: `UserService.ts`, `types.ts`
+> - Largest change: `UserService.ts` (+80/-0)
+>
+> ### Changes
+> - 🔌 **API**: `src/routes/users.ts`, `src/controllers/auth.ts`
+> - 🖼️ **UI Components**: `src/components/UserCard.tsx`
+> - 🧪 **Tests**: `src/__tests__/users.test.ts`
+> - ⚙️ **Configuration**: `tsconfig.json`
+>
+> 🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟥🟥 +120 / -15 (net +105)
+
+## Options
+
+| Input | Description | Default |
+|-------|-------------|---------|
+| `github-token` | GitHub token for API access | `${{ github.token }}` |
+| `snipelink-key` | SnipeLink API key for AI-powered descriptions | — |
+| `mode` | `comment` (PR comment) or `body` (update PR body) | `comment` |
+| `include-stats` | Include file change statistics | `true` |
+| `max-diff-size` | Max diff characters to analyze | `10000` |
+
+## AI-Powered Descriptions (Pro)
+
+Want smarter, context-aware descriptions? Add a SnipeLink API key:
+
+```yaml
+- uses: klawgulp-ship-it/snipe-pr@v1
+  with:
+    github-token: ${{ secrets.GITHUB_TOKEN }}
+    snipelink-key: ${{ secrets.SNIPELINK_KEY }}
+```
+
+Get your API key at [snipelink.com/tools](https://snipelink.com/tools)
+
+## How It Works
+
+1. PR is opened or updated
+2. Snipe PR reads the diff and changed files
+3. Files are categorized by type (API, UI, Tests, etc.)
+4. Change type is detected from diff content
+5. A structured description is generated and posted
+
+No external API calls needed for the free tier — everything runs locally in the GitHub Action.
+
+## License
+
+MIT — by [SnipeLink LLC](https://snipelink.com)

package/__tests__/analyzer.test.ts

@@ -0,0 +1,107 @@
+import { analyzeChanges, formatDescription, FileChange } from '../src/analyzer';
+
+describe('analyzeChanges', () => {
+  it('detects feature changes', () => {
+    const files: FileChange[] = [
+      { filename: 'src/newFeature.ts', status: 'added', additions: 50, deletions: 0 },
+      { filename: 'src/index.ts', status: 'modified', additions: 5, deletions: 2 },
+    ];
+    const diff = 'add new feature implement create';
+    const result = analyzeChanges(files, diff);
+
+    expect(result.changeType).toBe('feature');
+    expect(result.stats.filesChanged).toBe(2);
+    expect(result.stats.additions).toBe(55);
+    expect(result.stats.deletions).toBe(2);
+  });
+
+  it('detects bugfix changes', () => {
+    const files: FileChange[] = [
+      { filename: 'src/auth.ts', status: 'modified', additions: 3, deletions: 5 },
+    ];
+    const diff = 'fix bug error crash issue';
+    const result = analyzeChanges(files, diff);
+
+    expect(result.changeType).toBe('bugfix');
+  });
+
+  it('detects test-only changes', () => {
+    const files: FileChange[] = [
+      { filename: 'src/__tests__/auth.test.ts', status: 'added', additions: 40, deletions: 0 },
+      { filename: 'src/auth.spec.ts', status: 'modified', additions: 10, deletions: 5 },
+    ];
+    const result = analyzeChanges(files, '');
+
+    expect(result.changeType).toBe('test');
+  });
+
+  it('detects docs-only changes', () => {
+    const files: FileChange[] = [
+      { filename: 'README.md', status: 'modified', additions: 20, deletions: 5 },
+      { filename: 'docs/setup.md', status: 'added', additions: 50, deletions: 0 },
+    ];
+    const result = analyzeChanges(files, '');
+
+    expect(result.changeType).toBe('docs');
+  });
+
+  it('categorizes files correctly', () => {
+    const files: FileChange[] = [
+      { filename: 'src/components/Button.tsx', status: 'modified', additions: 10, deletions: 5 },
+      { filename: 'src/api/routes/users.ts', status: 'added', additions: 30, deletions: 0 },
+      { filename: 'package.json', status: 'modified', additions: 2, deletions: 1 },
+      { filename: 'src/__tests__/button.test.tsx', status: 'added', additions: 20, deletions: 0 },
+    ];
+    const result = analyzeChanges(files, '');
+
+    const categoryNames = result.categories.map((c) => c.name);
+    expect(categoryNames).toContain('Tests');
+    expect(categoryNames).toContain('Configuration');
+  });
+
+  it('highlights new files', () => {
+    const files: FileChange[] = [
+      { filename: 'src/newService.ts', status: 'added', additions: 100, deletions: 0 },
+      { filename: 'src/types.ts', status: 'added', additions: 30, deletions: 0 },
+    ];
+    const result = analyzeChanges(files, '');
+
+    expect(result.highlights.some((h) => h.includes('Added 2 new files'))).toBe(true);
+  });
+
+  it('highlights large changes', () => {
+    const files: FileChange[] = [
+      { filename: 'src/bigRefactor.ts', status: 'modified', additions: 200, deletions: 150 },
+    ];
+    const result = analyzeChanges(files, '');
+
+    expect(result.highlights.some((h) => h.includes('Largest change'))).toBe(true);
+  });
+});
+
+describe('formatDescription', () => {
+  it('generates valid markdown', () => {
+    const files: FileChange[] = [
+      { filename: 'src/index.ts', status: 'modified', additions: 10, deletions: 5 },
+    ];
+    const analysis = analyzeChanges(files, 'fix a bug in auth');
+    const md = formatDescription(analysis, 'Fix auth bug');
+
+    expect(md).toContain('##');
+    expect(md).toContain('Changes');
+    expect(md).toContain('Snipe PR');
+    expect(md).toContain('snipelink.com');
+  });
+
+  it('includes stats bar', () => {
+    const files: FileChange[] = [
+      { filename: 'src/a.ts', status: 'modified', additions: 50, deletions: 10 },
+    ];
+    const analysis = analyzeChanges(files, '');
+    const md = formatDescription(analysis, 'Test');
+
+    expect(md).toContain('🟩');
+    expect(md).toContain('+50');
+    expect(md).toContain('-10');
+  });
+});

package/action.yml

@@ -0,0 +1,39 @@
+name: 'Snipe PR — AI PR Descriptions'
+author: 'SnipeLink LLC'
+description: 'Auto-generates smart PR descriptions from your diffs. Free tier included, AI-powered with SnipeLink Pro.'
+
+inputs:
+  github-token:
+    description: 'GitHub token for API access (usually secrets.GITHUB_TOKEN)'
+    required: true
+    default: ${{ github.token }}
+  snipelink-key:
+    description: 'SnipeLink API key for AI-powered descriptions (optional, get one at snipelink.com)'
+    required: false
+    default: ''
+  mode:
+    description: 'Output mode: "comment" posts a PR comment, "body" updates the PR body'
+    required: false
+    default: 'comment'
+  include-stats:
+    description: 'Include file change statistics'
+    required: false
+    default: 'true'
+  max-diff-size:
+    description: 'Max diff characters to analyze (larger = more detail)'
+    required: false
+    default: '10000'
+
+outputs:
+  description:
+    description: 'The generated PR description'
+  comment-id:
+    description: 'ID of the posted comment (if mode=comment)'
+
+runs:
+  using: 'node20'
+  main: 'dist/index.js'
+
+branding:
+  icon: 'zap'
+  color: 'green'