跳转至

可视化头脑风暴伴侣 Implementation Plan

面向智能体工作者: REQUIRED SUB-SKILL:使用 superpowers:executing-plans 逐任务实施此计划。

目标: 为 Claude 提供基于浏览器的可视化头脑风暴伴侣——在终端对话旁展示界面样稿、原型和交互选项。

架构: Claude 将 HTML 写入临时文件。本地 Node.js 服务器监视该文件,并通过自动注入的辅助库将页面提供给浏览器。用户交互通过 WebSocket 流向服务器 stdout,Claude 会在后台任务输出中看到这些交互。

Tech Stack: Node.js、Express、ws(WebSocket)、chokidar(文件监视)


任务 1:创建服务器基础

文件: - 创建:lib/brainstorm-server/index.js - 创建:lib/brainstorm-server/package.json

步骤 1:创建 package.json

{
  "name": "brainstorm-server",
  "version": "1.0.0",
  "description": "Visual brainstorming companion server for Claude Code",
  "main": "index.js",
  "dependencies": {
    "chokidar": "^3.5.3",
    "express": "^4.18.2",
    "ws": "^8.14.2"
  }
}

步骤 2:创建可启动的最小服务器

const express = require('express');
const http = require('http');
const WebSocket = require('ws');
const chokidar = require('chokidar');
const fs = require('fs');
const path = require('path');

const PORT = process.env.BRAINSTORM_PORT || 3333;
const SCREEN_FILE = process.env.BRAINSTORM_SCREEN || '/tmp/brainstorm/screen.html';
const SCREEN_DIR = path.dirname(SCREEN_FILE);

// Ensure screen directory exists
if (!fs.existsSync(SCREEN_DIR)) {
  fs.mkdirSync(SCREEN_DIR, { recursive: true });
}

// Create default screen if none exists
if (!fs.existsSync(SCREEN_FILE)) {
  fs.writeFileSync(SCREEN_FILE, `<!DOCTYPE html>
<html>
<head>
  <title>Brainstorm Companion</title>
  <style>
    body { font-family: system-ui, sans-serif; padding: 2rem; max-width: 800px; margin: 0 auto; }
    h1 { color: #333; }
    p { color: #666; }
  </style>
</head>
<body>
  <h1>Brainstorm Companion</h1>
  <p>Waiting for Claude to push a screen...</p>
</body>
</html>`);
}

const app = express();
const server = http.createServer(app);
const wss = new WebSocket.Server({ server });

// Track connected browsers for reload notifications
const clients = new Set();

wss.on('connection', (ws) => {
  clients.add(ws);
  ws.on('close', () => clients.delete(ws));

  ws.on('message', (data) => {
    // User interaction event - write to stdout for Claude
    const event = JSON.parse(data.toString());
    console.log(JSON.stringify({ type: 'user-event', ...event }));
  });
});

// Serve current screen with helper.js injected
app.get('/', (req, res) => {
  let html = fs.readFileSync(SCREEN_FILE, 'utf-8');

  // Inject helper script before </body>
  const helperScript = fs.readFileSync(path.join(__dirname, 'helper.js'), 'utf-8');
  const injection = `<script>\n${helperScript}\n</script>`;

  if (html.includes('</body>')) {
    html = html.replace('</body>', `${injection}\n</body>`);
  } else {
    html += injection;
  }

  res.type('html').send(html);
});

// Watch for screen file changes
chokidar.watch(SCREEN_FILE).on('change', () => {
  console.log(JSON.stringify({ type: 'screen-updated', file: SCREEN_FILE }));
  // Notify all browsers to reload
  clients.forEach(ws => {
    if (ws.readyState === WebSocket.OPEN) {
      ws.send(JSON.stringify({ type: 'reload' }));
    }
  });
});

server.listen(PORT, '127.0.0.1', () => {
  console.log(JSON.stringify({ type: 'server-started', port: PORT, url: `http://localhost:${PORT}` }));
});

步骤 3:运行 npm install

运行:cd lib/brainstorm-server && npm install 预期结果:依赖项已安装

步骤 4:测试服务器启动

运行:cd lib/brainstorm-server && timeout 3 node index.js || true 预期结果:看到包含 server-started 和端口信息的 JSON

步骤 5:提交

git add lib/brainstorm-server/
git commit -m "feat: add brainstorm server foundation"

任务 2:创建辅助库

文件: - 创建:lib/brainstorm-server/helper.js

步骤 1:创建带事件自动捕获功能的 helper.js

(function() {
  const WS_URL = 'ws://' + window.location.host;
  let ws = null;
  let eventQueue = [];

  function connect() {
    ws = new WebSocket(WS_URL);

    ws.onopen = () => {
      // Send any queued events
      eventQueue.forEach(e => ws.send(JSON.stringify(e)));
      eventQueue = [];
    };

    ws.onmessage = (msg) => {
      const data = JSON.parse(msg.data);
      if (data.type === 'reload') {
        window.location.reload();
      }
    };

    ws.onclose = () => {
      // Reconnect after 1 second
      setTimeout(connect, 1000);
    };
  }

  function send(event) {
    event.timestamp = Date.now();
    if (ws && ws.readyState === WebSocket.OPEN) {
      ws.send(JSON.stringify(event));
    } else {
      eventQueue.push(event);
    }
  }

  // Auto-capture clicks on interactive elements
  document.addEventListener('click', (e) => {
    const target = e.target.closest('button, a, [data-choice], [role="button"], input[type="submit"]');
    if (!target) return;

    // Don't capture regular link navigation
    if (target.tagName === 'A' && !target.dataset.choice) return;

    e.preventDefault();

    send({
      type: 'click',
      text: target.textContent.trim(),
      choice: target.dataset.choice || null,
      id: target.id || null,
      className: target.className || null
    });
  });

  // Auto-capture form submissions
  document.addEventListener('submit', (e) => {
    e.preventDefault();
    const form = e.target;
    const formData = new FormData(form);
    const data = {};
    formData.forEach((value, key) => { data[key] = value; });

    send({
      type: 'submit',
      formId: form.id || null,
      formName: form.name || null,
      data: data
    });
  });

  // Auto-capture input changes (debounced)
  let inputTimeout = null;
  document.addEventListener('input', (e) => {
    const target = e.target;
    if (!target.matches('input, textarea, select')) return;

    clearTimeout(inputTimeout);
    inputTimeout = setTimeout(() => {
      send({
        type: 'input',
        name: target.name || null,
        id: target.id || null,
        value: target.value,
        inputType: target.type || target.tagName.toLowerCase()
      });
    }, 500); // 500ms debounce
  });

  // Expose for explicit use if needed
  window.brainstorm = {
    send: send,
    choice: (value, metadata = {}) => send({ type: 'choice', value, ...metadata })
  };

  connect();
})();

步骤 2:验证 helper.js 语法有效

运行:node -c lib/brainstorm-server/helper.js 预期:无语法错误

步骤 3:提交

git add lib/brainstorm-server/helper.js
git commit -m "feat: add browser helper library for event capture"

任务 3:为服务器编写测试

文件: - 创建:tests/brainstorm-server/server.test.js - 创建:tests/brainstorm-server/package.json

步骤 1:创建测试 package.json

{
  "name": "brainstorm-server-tests",
  "version": "1.0.0",
  "scripts": {
    "test": "node server.test.js"
  }
}

步骤 2:编写服务器测试

const { spawn } = require('child_process');
const http = require('http');
const WebSocket = require('ws');
const fs = require('fs');
const path = require('path');
const assert = require('assert');

const SERVER_PATH = path.join(__dirname, '../../lib/brainstorm-server/index.js');
const TEST_PORT = 3334;
const TEST_SCREEN = '/tmp/brainstorm-test/screen.html';

// Clean up test directory
function cleanup() {
  if (fs.existsSync(path.dirname(TEST_SCREEN))) {
    fs.rmSync(path.dirname(TEST_SCREEN), { recursive: true });
  }
}

async function sleep(ms) {
  return new Promise(resolve => setTimeout(resolve, ms));
}

async function fetch(url) {
  return new Promise((resolve, reject) => {
    http.get(url, (res) => {
      let data = '';
      res.on('data', chunk => data += chunk);
      res.on('end', () => resolve({ status: res.statusCode, body: data }));
    }).on('error', reject);
  });
}

async function runTests() {
  cleanup();

  // Start server
  const server = spawn('node', [SERVER_PATH], {
    env: { ...process.env, BRAINSTORM_PORT: TEST_PORT, BRAINSTORM_SCREEN: TEST_SCREEN }
  });

  let stdout = '';
  server.stdout.on('data', (data) => { stdout += data.toString(); });
  server.stderr.on('data', (data) => { console.error('Server stderr:', data.toString()); });

  await sleep(1000); // Wait for server to start

  try {
    // Test 1: Server starts and outputs JSON
    console.log('Test 1: Server startup message');
    assert(stdout.includes('server-started'), 'Should output server-started');
    assert(stdout.includes(TEST_PORT.toString()), 'Should include port');
    console.log('  PASS');

    // Test 2: GET / returns HTML with helper injected
    console.log('Test 2: Serves HTML with helper injected');
    const res = await fetch(`http://localhost:${TEST_PORT}/`);
    assert.strictEqual(res.status, 200);
    assert(res.body.includes('brainstorm'), 'Should include brainstorm content');
    assert(res.body.includes('WebSocket'), 'Should have helper.js injected');
    console.log('  PASS');

    // Test 3: WebSocket connection and event relay
    console.log('Test 3: WebSocket relays events to stdout');
    stdout = ''; // Reset stdout capture
    const ws = new WebSocket(`ws://localhost:${TEST_PORT}`);
    await new Promise(resolve => ws.on('open', resolve));

    ws.send(JSON.stringify({ type: 'click', text: 'Test Button' }));
    await sleep(100);

    assert(stdout.includes('user-event'), 'Should relay user events');
    assert(stdout.includes('Test Button'), 'Should include event data');
    ws.close();
    console.log('  PASS');

    // Test 4: File change triggers reload notification
    console.log('Test 4: File change notifies browsers');
    const ws2 = new WebSocket(`ws://localhost:${TEST_PORT}`);
    await new Promise(resolve => ws2.on('open', resolve));

    let gotReload = false;
    ws2.on('message', (data) => {
      const msg = JSON.parse(data.toString());
      if (msg.type === 'reload') gotReload = true;
    });

    // Modify the screen file
    fs.writeFileSync(TEST_SCREEN, '<html><body>Updated</body></html>');
    await sleep(500);

    assert(gotReload, 'Should send reload message on file change');
    ws2.close();
    console.log('  PASS');

    console.log('\nAll tests passed!');

  } finally {
    server.kill();
    cleanup();
  }
}

runTests().catch(err => {
  console.error('Test failed:', err);
  process.exit(1);
});

步骤 3:运行测试

运行:cd tests/brainstorm-server && npm install ws && node server.test.js 预期:所有测试通过

步骤 4:提交

git add tests/brainstorm-server/
git commit -m "test: add brainstorm server integration tests"

任务 4:为头脑风暴技能添加视觉伴侣

文件: - 修改:skills/brainstorming/SKILL.md - 创建:skills/brainstorming/visual-companion.md(支持文档)

步骤 1:创建支持文档

创建 skills/brainstorming/visual-companion.md:

# Visual Companion Reference

## Starting the Server

Run as a background job:

```bash
node ${PLUGIN_ROOT}/lib/brainstorm-server/index.js

Tell the user: "I've started a visual companion at http://localhost:3333 - open it in a browser."

Pushing Screens

Write HTML to /tmp/brainstorm/screen.html. The server watches this file and auto-refreshes the browser.

Reading User Responses

Check the background task output for JSON events:

{"type":"user-event","type":"click","text":"Option A","choice":"optionA","timestamp":1234567890}
{"type":"user-event","type":"submit","data":{"notes":"My feedback"},"timestamp":1234567891}

Event types: - click: User clicked button or data-choice element - submit: User submitted form (includes all form data) - input: User typed in field (debounced 500ms)

HTML Patterns

Choice Cards

<div class="options">
  <button data-choice="optionA">
    <h3>Option A</h3>
    <p>Description</p>
  </button>
  <button data-choice="optionB">
    <h3>Option B</h3>
    <p>Description</p>
  </button>
</div>

Interactive Mockup

<div class="mockup">
  <header data-choice="header">App Header</header>
  <nav data-choice="nav">Navigation</nav>
  <main data-choice="main">Content</main>
</div>

Form with Notes

<form>
  <label>Priority: <input type="range" name="priority" min="1" max="5"></label>
  <textarea name="notes" placeholder="Additional thoughts..."></textarea>
  <button type="submit">Submit</button>
</form>

Explicit JavaScript

<button onclick="brainstorm.choice('custom', {extra: 'data'})">Custom</button>
**步骤 2:为头脑风暴技能添加视觉伴侣部分**

在 `skills/brainstorming/SKILL.md` 中的“Key Principles”之后添加:

```markdown

## Visual Companion (Optional)

When brainstorming involves visual elements - UI mockups, wireframes, interactive prototypes - use the browser-based visual companion.

**When to use:**
- Presenting UI/UX options that benefit from visual comparison
- Showing wireframes or layout options
- Gathering structured feedback (ratings, forms)
- Prototyping click interactions

**How it works:**
1. Start the server as a background job
2. Tell user to open http://localhost:3333
3. Write HTML to `/tmp/brainstorm/screen.html` (auto-refreshes)
4. Check background task output for user interactions

The terminal remains the primary conversation interface. The browser is a visual aid.

**Reference:** See `visual-companion.md` in this skill directory for HTML patterns and API details.

步骤 3:验证编辑

运行:grep -A5 "Visual Companion" skills/brainstorming/SKILL.md 预期:显示新部分。

步骤 4:提交

git add skills/brainstorming/
git commit -m "feat: add visual companion to brainstorming skill"

任务 5:将服务器添加到插件忽略(可选清理)

文件: - 检查 .gitignore 是否需要为 lib/brainstorm-server 添加 node_modules 排除项。

步骤 1:检查当前 gitignore

运行:cat .gitignore 2>/dev/null || echo "No .gitignore"

步骤 2:如有需要,添加 node_modules

如果尚未存在,请添加:

lib/brainstorm-server/node_modules/

步骤 3:如有更改则提交

git add .gitignore
git commit -m "chore: ignore brainstorm-server node_modules"

总结

完成所有任务后:

  1. 服务器位于 lib/brainstorm-server/:一个 Node.js 服务器,用于监视 HTML 文件并转发事件。
  2. 辅助库自动注入——捕获点击、表单和输入。
  3. 测试位于 tests/brainstorm-server/:验证服务器行为。
  4. 头脑风暴技能已更新,新增视觉伴侣部分和 visual-companion.md 参考文档。

使用方法: 1. 以后台任务方式启动服务器:node lib/brainstorm-server/index.js & 2. 告知用户打开 http://localhost:3333 3. 将 HTML 写入 /tmp/brainstorm/screen.html 4. 在任务输出中检查用户事件

本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 su/superpowers