frameshot-mcp 0.7.0 → 0.9.7

package/README.md

@@ -2,7 +2,7 @@
 
 [![npm version](https://img.shields.io/npm/v/frameshot-mcp)](https://www.npmjs.com/package/frameshot-mcp) [![npm downloads](https://img.shields.io/npm/dm/frameshot-mcp)](https://www.npmjs.com/package/frameshot-mcp) [![GitHub stars](https://img.shields.io/github/stars/kamegoro/frameshot)](https://github.com/kamegoro/frameshot) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-**Give your AI agent eyes.** Render any component — with real imports, Tailwind, and CSS Modules resolved via Vite — directly in your terminal or AI chat. No stories. No config. Just point at a file.
+**Give your AI agent eyes.** Render components with real Vite imports, Tailwind, and CSS Modules — right in your terminal or AI chat. No story files required.
 
 <p align="center">
   <img src="docs/demo.gif" alt="frameshot demo" width="720" />
@@ -32,70 +32,118 @@ claude mcp add frameshot -- npx frameshot-mcp@latest
 
 ---
 
-## Using with Claude
+## Watch mode — live AI feedback loop
 
-Once installed, just tell Claude what you want:
+The AI edits a file, saves it, and immediately sees how it looks — without you calling anything.
 
 ```
-"Render src/components/PricingCard.tsx and check the layout looks right"
-"Refactor the dashboard to use CSS grid — render it before and after and make sure nothing broke"
-"Show me all components in src/components/ as screenshots"
+watch_start({ patterns: ["src/components/Button.tsx"] })
+→ renders on every save → call watch_get_latest("watch-1") to see it
 ```
 
-Claude will automatically call `render_file`, `diff_component`, or `render_catalog` as needed. No manual tool calls required.
+The agent fixes → saves → sees → fixes again. You just watch.
 
 ---
 
-## Render
+## GitHub Action — free Chromatic alternative
 
-Point to a file. Get a screenshot. All imports resolved.
+Two lines. Auto-detects changed components. Posts before/after/diff screenshots directly in the PR comment.
 
-```
-render_file("src/components/Dashboard.tsx")
+```yaml
+- uses: actions/checkout@v7
+  with:
+    fetch-depth: 0
+- uses: kamegoro/frameshot@v0.8.0
 ```
 
 <p align="center">
-  <img src="docs/example-output.png" alt="Rendered PricingCard with full Tailwind styling" width="280" />
+  <img src="docs/diff-before.png" alt="Before" width="210" />
+  &nbsp;
+  <img src="docs/diff-after.png" alt="After" width="210" />
+  &nbsp;
+  <img src="docs/diff-result.png" alt="Diff" width="210" />
 </p>
 
-Real Tailwind. Real CSS Modules. Real dependencies — not a CDN polyfill.
+Changed `.tsx`, `.jsx`, `.vue`, `.svelte`, `.astro`, `.mdx` files detected automatically. No Storybook. No signup. Free forever.
+
+<details>
+<summary>Options</summary>
+
+```yaml
+- uses: kamegoro/frameshot@v0.8.0
+  with:
+    paths: "./src/components/*.tsx"       # default: auto-detect
+    extensions: ".jsx,.tsx,.vue"          # default: .jsx,.tsx,.vue,.svelte,.astro,.mdx
+    exclude: "*.test.*,*.spec.*"          # default: *.test.*,*.spec.*,*.stories.*
+```
+
+</details>
 
 ---
 
-## Visual diff
+## Render any component
 
-Catch regressions before you ship. Before / after / changed pixels — all at once.
+Point to a file. Get a screenshot. Full Vite pipeline.
+
+```
+render_file("src/components/Dashboard.tsx")
+```
 
 <p align="center">
-  <img src="docs/diff-before.png" alt="Before" width="210" />
-  &nbsp;
-  <img src="docs/diff-after.png" alt="After" width="210" />
-  &nbsp;
-  <img src="docs/diff-result.png" alt="Diff" width="210" />
+  <img src="docs/example-output.png" alt="Rendered PricingCard with full Tailwind styling" width="280" />
 </p>
 
+Resolves your project's real imports, Tailwind config, CSS Modules, and path aliases — not a CDN polyfill.
+
+---
+
+## Using with Claude
+
+After installing, just describe what you want:
+
 ```
-diff_component("src/components/MetricCard.tsx")
-→ 0.7% changed
+"Render src/components/PricingCard.tsx — does it look right?"
+"Refactor the layout to CSS grid and show me before/after"
+"Watch Button.tsx while I edit — tell me when something looks off"
 ```
 
+Claude calls `render_file`, `diff_component`, `watch_start`, or any other tool automatically.
+
+---
+
+## Try it without an AI client
+
+Works standalone on any React / Vue / Svelte project:
+
+```bash
+npx frameshot render src/components/Button.tsx
+npx frameshot diff src/components/Header.tsx
+npx frameshot catalog src/components/ --recursive
+```
+
+Images display inline in iTerm2, Kitty, and Sixel terminals. Saved to `.frameshot/` by default.
+
+> First run installs Playwright's Chromium (~150MB). Subsequent renders are fast.
+
 ---
 
 ## Tools
 
 | Tool | What it does |
 |------|-------------|
-| `render_file` | **Render a file via Vite** — full dep resolution, props support |
-| `render_component` | Render a self-contained snippet (React / Vue / Svelte / HTML) |
+| `render_file` | Render a file via Vite — real imports, Tailwind, CSS Modules |
+| `diff_component` | Pixel diff before/after — % changed, highlighted pixels |
+| `watch_start` | Watch files — auto-render on every save |
+| `watch_get_latest` | Get the latest render from a watch session |
+| `render_catalog` | Render every component in a directory at once |
 | `screenshot_url` | Screenshot any URL — localhost, staging, prod |
-| `diff_component` | Pixel diff before/after with % changed |
 | `render_responsive` | Mobile + tablet + desktop in one call |
 | `render_theme` | Light + dark mode side by side |
-| `audit_a11y` | axe-core accessibility audit (WCAG) |
-| `render_catalog` | Render every component in a directory |
+| `audit_a11y` | axe-core accessibility audit (WCAG violations) |
+| `render_component` | Render a self-contained code snippet |
 
 <details>
-<summary>All 18 tools</summary>
+<summary>All 22 tools</summary>
 
 | Tool | What it does |
 |------|-------------|
@@ -117,52 +165,17 @@ diff_component("src/components/MetricCard.tsx")
 | `snapshot_save` | Save a render as named baseline |
 | `snapshot_check` | Compare current render against saved baseline |
 | `snapshot_list` | List all saved snapshots |
+| `watch_start` | Start watching files — renders on every save |
+| `watch_stop` | Stop a watch session |
+| `watch_get_latest` | Get the latest rendered screenshot from a session |
+| `watch_list` | List active watch sessions |
 
 </details>
 
 ---
 
-## CLI
-
-No AI client required. Use frameshot standalone:
-
-```bash
-npx frameshot render src/components/Button.tsx
-npx frameshot render src/Card.tsx --props '{"title":"Hello"}'
-npx frameshot catalog src/components/ --recursive
-npx frameshot diff src/components/Header.tsx
-```
-
-Images display inline in iTerm2, Kitty, and Sixel terminals. Saved to `.frameshot/` by default.
-
----
-
-## GitHub Action
-
-Free Chromatic alternative. Auto-posts before/after screenshots with diff on every PR:
-
-```yaml
-# .github/workflows/visual-preview.yml
-name: Visual Preview
-on: [pull_request]
-jobs:
-  preview:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - uses: kamegoro/frameshot@main
-        with:
-          paths: "./src/components/*.tsx"
-```
-
----
-
 ## Performance
 
-Typical measured times (varies by machine and project size):
-
 | Scenario | Time |
 |----------|------|
 | Warm render (Vite server cached) | **~200–500ms** |
@@ -181,9 +194,10 @@ Vite server is cached per project root. Browser pool stays warm between MCP call
 | Setup | Stories + config | SaaS signup | Browser install | **`npx` — done** |
 | Speed | Dev server startup | Cloud round-trip | 2–5s | **~200ms warm** |
 | Cost | Free (labor cost) | $149–800+/mo | Free | **Free forever** |
-| Stories needed | Yes | Yes | No | **No** |
-| Real imports | Via Storybook | Via Storybook | No | **Via Vite** |
+| Story files needed | Yes | Yes | No | **No** |
+| Real imports resolved | Via Storybook | Via Storybook | No | **Via Vite** |
 | Works offline | Yes | No | Yes | **Yes** |
+| Watch mode | No | No | No | **Yes** |
 | AI-native (MCP) | No | No | Full-page only | **Component-level** |
 
 ---

package/action.yml

@@ -6,8 +6,17 @@ branding:
 
 inputs:
   paths:
-    description: "Glob patterns for component files to render (newline or comma separated)"
-    required: true
+    description: "Glob patterns for component files to render. Leave empty to auto-detect changed component files."
+    required: false
+    default: ""
+  extensions:
+    description: "Comma-separated file extensions to treat as components. Default covers React, Vue, Svelte, Astro, MDX."
+    required: false
+    default: ".jsx,.tsx,.vue,.svelte,.astro,.mdx"
+  exclude:
+    description: "Patterns to exclude (comma-separated). Matches against full file path."
+    required: false
+    default: "*.test.*,*.spec.*,*.stories.*,*.story.*"
   width:
     description: "Viewport width in px. Leave empty for auto-fit (recommended)."
     required: false
@@ -35,22 +44,51 @@ runs:
 
     - name: Install frameshot
       shell: bash
-      run: npm install -g frameshot-mcp@latest
+      run: |
+        cd "${{ github.action_path }}"
+        # Install frameshot from the action's own checked-out source (this repo)
+        # so users get exactly the version pinned by their `uses:` tag,
+        # regardless of npm publish state.
+        if [ -f package.json ] && [ -d src ]; then
+          npm install --prefer-offline --no-audit --no-fund
+          npm run build
+        else
+          npm install --prefer-offline --no-audit --no-fund frameshot-mcp@latest
+        fi
 
     - name: Install Playwright Chromium
       shell: bash
-      run: npx playwright install chromium
+      run: |
+        cd "${{ github.action_path }}"
+        npx playwright install chromium
+
+    - name: Install project dependencies (for Vite pipeline)
+      shell: bash
+      run: |
+        # Install deps in any directory that has a package.json with a build framework
+        # Supports Vite, Next.js, Nuxt, SvelteKit, Astro, etc.
+        for pkg in $(find "$GITHUB_WORKSPACE" -name "package.json" -not -path "*/node_modules/*" -maxdepth 3); do
+          dir=$(dirname "$pkg")
+          if grep -qE '"vite"|"next"|"nuxt"|"@sveltejs/kit"|"astro"' "$pkg" 2>/dev/null; then
+            echo "Installing deps in $dir"
+            cd "$dir" && npm install --legacy-peer-deps 2>/dev/null || true
+            cd "$GITHUB_WORKSPACE"
+          fi
+        done
 
     - name: Render changed components
       id: render
       shell: bash
       env:
         INPUT_PATHS: ${{ inputs.paths }}
+        INPUT_EXTENSIONS: ${{ inputs.extensions }}
+        INPUT_EXCLUDE: ${{ inputs.exclude }}
         INPUT_WIDTH: ${{ inputs.width }}
         INPUT_HEIGHT: ${{ inputs.height }}
         INPUT_BASE_REF: ${{ github.event.pull_request.base.sha }}
       run: |
-        node "${{ github.action_path }}/scripts/render-changed.mjs"
+        cd "${{ github.action_path }}"
+        node scripts/render-changed.mjs
 
     - name: Comment on PR
       if: inputs.comment == 'true' && github.event_name == 'pull_request'
@@ -81,9 +119,60 @@ runs:
             return;
           }
 
-          let body = '## 📸 frameshot — Visual Preview\n\n';
+          // Store image in repo on a dedicated branch and return raw URL.
+          // Uses a special orphan branch "frameshot-previews" as image storage.
+          async function uploadImageToGitHub(filePath) {
+            const bytes = fs.readFileSync(filePath);
+            const base64 = bytes.toString('base64');
+            const filename = `pr-${context.issue.number}-${path.basename(filePath)}-${Date.now()}.png`;
+            const BRANCH = 'frameshot-previews';
+
+            // Ensure branch exists
+            try {
+              await github.rest.repos.getBranch({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                branch: BRANCH,
+              });
+            } catch {
+              // Branch doesn't exist — create it from main
+              try {
+                const { data: ref } = await github.rest.git.getRef({
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  ref: 'heads/main',
+                });
+                await github.rest.git.createRef({
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  ref: `refs/heads/${BRANCH}`,
+                  sha: ref.object.sha,
+                });
+              } catch (e) {
+                console.log('Failed to create branch:', e.message);
+                return null;
+              }
+            }
+
+            // Commit the image file
+            try {
+              await github.rest.repos.createOrUpdateFileContents({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                path: filename,
+                message: `Add PR #${context.issue.number} preview image`,
+                content: base64,
+                branch: BRANCH,
+              });
+              return `https://raw.githubusercontent.com/${context.repo.owner}/${context.repo.repo}/${BRANCH}/${filename}`;
+            } catch (e) {
+              console.log('Failed to commit image:', e.message);
+              return null;
+            }
+          }
 
           const hasBeforeAfter = manifest.some(m => m.hasBefore);
+          let body = '## 📸 frameshot — Visual Preview\n\n';
 
           if (hasBeforeAfter) {
             body += '| Component | Before | After | Diff |\n|---|---|---|---|\n';
@@ -95,23 +184,32 @@ runs:
             const afterFile = path.join(dir, `${entry.name}_after.png`);
             if (!fs.existsSync(afterFile)) continue;
 
-            const afterData = fs.readFileSync(afterFile, 'base64');
-
             if (hasBeforeAfter) {
               const beforeFile = path.join(dir, `${entry.name}_before.png`);
               const diffFile = path.join(dir, `${entry.name}_diff.png`);
 
-              const beforeImg = fs.existsSync(beforeFile)
-                ? `<img src="data:image/png;base64,${fs.readFileSync(beforeFile, 'base64')}" width="250" />`
-                : '*(new)*';
-
-              const diffImg = fs.existsSync(diffFile) && entry.diffPercentage > 0
-                ? `<img src="data:image/png;base64,${fs.readFileSync(diffFile, 'base64')}" width="250" /><br/>${entry.diffPercentage.toFixed(1)}% changed`
+              // Upload sequentially to avoid commit conflicts
+              const afterUrl = await uploadImageToGitHub(afterFile);
+              const beforeUrl = fs.existsSync(beforeFile) ? await uploadImageToGitHub(beforeFile) : null;
+              const diffUrl = fs.existsSync(diffFile) ? await uploadImageToGitHub(diffFile) : null;
+
+              const beforeCell = beforeUrl
+                ? `<img src="${beforeUrl}" width="240" />`
+                : entry.hasBefore ? '*(before unavailable)*' : '*(new)*';
+              const afterCell = afterUrl
+                ? `<img src="${afterUrl}" width="240" />`
+                : '*(after unavailable)*';
+              const diffCell = diffUrl && entry.diffPercentage > 0
+                ? `<img src="${diffUrl}" width="240" /><br/>${entry.diffPercentage.toFixed(1)}% changed`
                 : entry.hasBefore ? '✅ No change' : '—';
 
-              body += `| \`${entry.name}\` | ${beforeImg} | <img src="data:image/png;base64,${afterData}" width="250" /> | ${diffImg} |\n`;
+              body += `| \`${entry.label ?? entry.name}\` | ${beforeCell} | ${afterCell} | ${diffCell} |\n`;
             } else {
-              body += `| \`${entry.name}\` | <img src="data:image/png;base64,${afterData}" width="400" /> |\n`;
+              const afterUrl = await uploadImageToGitHub(afterFile);
+              const afterCell = afterUrl
+                ? `<img src="${afterUrl}" width="360" />`
+                : '*(unavailable)*';
+              body += `| \`${entry.label ?? entry.name}\` | ${afterCell} |\n`;
             }
           }