Create Action that updates documentation

[oaustegard]

Craft an Action that will consider a commit and update the repo README with descriptions of each bookmarklet.

[oaustegard]

name: Generate File Summaries

on:
  push:
    branches: [ main ]
    paths-ignore:
      - '**/*.md'
      - '**/*.txt'
      - '.github/**'
      - 'LICENSE'
  pull_request:
    branches: [ main ]
    paths-ignore:
      - '**/*.md'
      - '**/*.txt'
      - '.github/**'
      - 'LICENSE'

jobs:
  generate-summaries:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 2

      - name: Set up Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '18'

      - name: Install dependencies
        run: npm install @anthropic-ai/sdk fs-extra glob

      - name: Generate Summaries
        env:
          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
        run: node .github/scripts/generate-summaries.js
        
      - name: Commit changes
        run: |
          git config --local user.email "github-actions[bot]@users.noreply.github.com"
          git config --local user.name "github-actions[bot]"
          git add .
          git diff --staged --quiet || git commit -m "docs: Update file summaries [skip ci]"
          git push

[oaustegard]

/* Script to generate file summaries using Claude API */
const Anthropic = require('@anthropic-ai/sdk');
const fs = require('fs-extra');
const glob = require('glob');
const path = require('path');
const { execSync } = require('child_process');

const anthropic = new Anthropic({
    apiKey: process.env.ANTHROPIC_API_KEY,
});

/* File types to ignore */
const IGNORED_EXTENSIONS = new Set([
    '.md',
    '.txt',
    '.gitignore',
    '.env',
    '.log',
    '.lock',
    '.yml',
    '.yaml',
    '.json'
]);

/* Directories to ignore */
const IGNORED_DIRS = new Set([
    '.git',
    '.github',
    'node_modules',
    'dist',
    'build'
]);

/* Get list of modified files */
function getModifiedFiles() {
    try {
        const diff = execSync('git diff --name-only HEAD HEAD~1').toString();
        return diff
            .split('\n')
            .filter(file => {
                if (!file.trim()) return false;
                
                /* Check if file is in ignored directory */
                const dirs = file.split(path.sep);
                if (dirs.some(dir => IGNORED_DIRS.has(dir))) return false;
                
                /* Check if file has ignored extension */
                const ext = path.extname(file);
                return !IGNORED_EXTENSIONS.has(ext);
            });
    } catch (error) {
        console.error('Error getting modified files:', error);
        return [];
    }
}

/* Generate summary for a single file */
async function generateSummary(filePath) {
    const content = await fs.readFile(filePath, 'utf8');
    const fileExtension = path.extname(filePath);
    
    const prompt = `Please provide a concise technical summary of this ${fileExtension} file, focusing on its purpose, key functionality, and any important dependencies. Format the response in markdown. Here's the file content:\n\n${content}`;

    try {
        const response = await anthropic.messages.create({
            model: 'claude-3-opus-20240229',
            max_tokens: 1000,
            messages: [{ role: 'user', content: prompt }],
        });

        return response.content[0].text;
    } catch (error) {
        console.error(`Error generating summary for ${filePath}:`, error);
        return null;
    }
}

/* Update or create README for a file */
async function updateReadme(filePath, summary) {
    const dirPath = path.dirname(filePath);
    const fileName = path.basename(filePath);
    const readmePath = path.join(dirPath, 'README.md');

    let readmeContent = '';
    if (await fs.pathExists(readmePath)) {
        readmeContent = await fs.readFile(readmePath, 'utf8');
    }

    /* Create or update file section in README */
    const fileSection = `## ${fileName}\n\n${summary}\n\n`;
    
    if (readmeContent.includes(`## ${fileName}`)) {
        /* Update existing section */
        const regex = new RegExp(`## ${fileName}[^#]*`);
        readmeContent = readmeContent.replace(regex, fileSection);
    } else {
        /* Add new section */
        readmeContent += fileSection;
    }

    await fs.writeFile(readmePath, readmeContent.trim() + '\n');
}

/* Main execution */
async function main() {
    const modifiedFiles = getModifiedFiles();
    
    for (const file of modifiedFiles) {
        if (file) {
            console.log(`Processing ${file}...`);
            const summary = await generateSummary(file);
            if (summary) {
                await updateReadme(file, summary);
                console.log(`Updated README for ${file}`);
            }
        }
    }
}

main().catch(console.error);

[oaustegard]

This may not be needed - instead can just hand the task to jules.google.com on some periodic basis