@adonis0123/weekly-report 1.0.6

package/install-skill.js

@@ -0,0 +1,207 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+const os = require('os');
+
+const { getEnabledTargets,extractSkillName, detectInstallLocation } = require('./utils');
+
+function installToTarget(target, config) {
+  console.log(`\n📦 Installing to ${target.name}...`);
+
+  // Check if this is a global installation
+  const isGlobal = process.env.npm_config_global === 'true';
+
+  // Determine installation location
+  const location = detectInstallLocation(target.paths, isGlobal);
+
+  // Extract skill name from package name (remove scope prefix)
+  const skillName = extractSkillName(config.name);
+
+  const targetDir = path.join(location.base, skillName);
+
+  // Alternative path format with full package name (including scope)
+  const altTargetDir = path.join(location.base, config.name);
+
+  console.log(`  Type: ${location.type}${isGlobal ? ' (global)' : ' (project)'}`);
+  console.log(`  Directory: ${targetDir}`);
+
+  // Clean up alternative path format
+  if (fs.existsSync(altTargetDir) && altTargetDir !== targetDir) {
+    console.log(`  🧹 Cleaning up alternative path format...`);
+    fs.rmSync(altTargetDir, { recursive: true, force: true });
+    console.log(`  ✓ Removed directory: ${config.name}`);
+  }
+
+  // Create target directory
+  if (!fs.existsSync(targetDir)) {
+    fs.mkdirSync(targetDir, { recursive: true });
+  }
+
+  // Copy SKILL.md (required)
+  const skillMdSource = path.join(__dirname, 'SKILL.md');
+  if (!fs.existsSync(skillMdSource)) {
+    throw new Error('SKILL.md is required but not found');
+  }
+  fs.copyFileSync(skillMdSource, path.join(targetDir, 'SKILL.md'));
+  console.log('  ✓ Copied SKILL.md');
+
+  // Copy other files
+  if (config.files) {
+    Object.entries(config.files).forEach(([source, dest]) => {
+      const sourcePath = path.join(__dirname, source);
+      if (!fs.existsSync(sourcePath)) {
+        console.warn(`  ⚠ Warning: ${source} not found, skipping`);
+        return;
+      }
+
+      const destPath = path.join(targetDir, dest);
+
+      if (fs.statSync(sourcePath).isDirectory()) {
+        copyDir(sourcePath, destPath);
+        console.log(`  ✓ Copied directory: ${source}`);
+      } else {
+        // Ensure target directory exists
+        const destDir = path.dirname(destPath);
+        if (!fs.existsSync(destDir)) {
+          fs.mkdirSync(destDir, { recursive: true });
+        }
+        fs.copyFileSync(sourcePath, destPath);
+        console.log(`  ✓ Copied file: ${source}`);
+      }
+    });
+  }
+
+  // Update manifest
+  updateManifest(location.base, config, target.name);
+
+  // Run postinstall hooks
+  if (config.hooks && config.hooks.postinstall) {
+    console.log('  🔧 Running postinstall hook...');
+    const { execSync } = require('child_process');
+    try {
+      execSync(config.hooks.postinstall, {
+        cwd: targetDir,
+        stdio: 'pipe'
+      });
+      console.log('  ✓ Postinstall hook completed');
+    } catch (error) {
+      console.warn(`  ⚠ Warning: postinstall hook failed`);
+    }
+  }
+
+  console.log(`  ✅ Installed to ${target.name}`);
+  return targetDir;
+}
+
+function installSkill() {
+  console.log('🚀 Installing AI Coding Skill...\n');
+
+  // Read configuration
+  const configPath = path.join(__dirname, '.claude-skill.json');
+  if (!fs.existsSync(configPath)) {
+    throw new Error('.claude-skill.json not found');
+  }
+  const config = JSON.parse(fs.readFileSync(configPath, 'utf8'));
+
+  // Get enabled targets
+  const enabledTargets = getEnabledTargets(config);
+
+  if (enabledTargets.length === 0) {
+    console.warn('⚠ No targets enabled in configuration');
+    console.warn('Please enable at least one target in .claude-skill.json');
+    return;
+  }
+
+  console.log(`Installing skill "${config.name}" to ${enabledTargets.length} target(s):`);
+  enabledTargets.forEach(target => {
+    console.log(`  • ${target.name}`);
+  });
+
+  // Install to all enabled targets
+  const installedPaths = [];
+  for (const target of enabledTargets) {
+    try {
+      const installPath = installToTarget(target, config);
+      installedPaths.push({ target: target.name, path: installPath });
+    } catch (error) {
+      console.error(`\n❌ Failed to install to ${target.name}:`, error.message);
+    }
+  }
+
+  // Summary
+  console.log('\n' + '='.repeat(60));
+  console.log('✅ Installation Complete!');
+  console.log('='.repeat(60));
+
+  if (installedPaths.length > 0) {
+    console.log('\nInstalled to:');
+    installedPaths.forEach(({ target, path: installPath }) => {
+      console.log(`  • ${target}: ${installPath}`);
+    });
+
+    console.log('\n📖 Next Steps:');
+    console.log('  1. Restart your AI coding tool(s)');
+    console.log('  2. Ask: "What skills are available?"');
+    console.log('  3. Start using your skill!');
+  }
+}
+
+function copyDir(src, dest) {
+  fs.mkdirSync(dest, { recursive: true });
+  const entries = fs.readdirSync(src, { withFileTypes: true });
+
+  for (let entry of entries) {
+    const srcPath = path.join(src, entry.name);
+    const destPath = path.join(dest, entry.name);
+
+    if (entry.isDirectory()) {
+      copyDir(srcPath, destPath);
+    } else {
+      fs.copyFileSync(srcPath, destPath);
+    }
+  }
+}
+
+function updateManifest(skillsDir, config, targetName) {
+  const manifestPath = path.join(skillsDir, '.skills-manifest.json');
+  let manifest = { skills: {} };
+
+  if (fs.existsSync(manifestPath)) {
+    try {
+      manifest = JSON.parse(fs.readFileSync(manifestPath, 'utf8'));
+    } catch (error) {
+      console.warn('  Warning: Could not parse existing manifest, creating new one');
+      manifest = { skills: {} };
+    }
+  }
+
+  // Extract skill name from package name (remove scope prefix)
+  const skillName = config.name.startsWith('@') ?
+    config.name.split('/')[1] || config.name :
+    config.name;
+
+  manifest.skills[config.name] = {
+    version: config.version,
+    installedAt: new Date().toISOString(),
+    package: config.package || config.name,
+    path: path.join(skillsDir, skillName),
+    target: targetName
+  };
+
+  fs.writeFileSync(manifestPath, JSON.stringify(manifest, null, 2));
+}
+
+// Execute installation
+try {
+  installSkill();
+} catch (error) {
+  console.error('\n❌ Failed to install skill:', error.message);
+  console.error('\nTroubleshooting:');
+  console.error('- Ensure .claude-skill.json exists and is valid JSON');
+  console.error('- Ensure SKILL.md exists');
+  console.error('- Check file permissions for target directories');
+  console.error('- Verify at least one target is enabled in .claude-skill.json');
+  console.error('- Try running with sudo for global installation (if needed)');
+  process.exit(1);
+}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@adonis0123/weekly-report",
+  "version": "1.0.6",
+  "description": "Claude Code Skill - 自动读取 Git 提交记录生成周报，支持多仓库汇总和智能过滤",
+  "main": "index.js",
+  "scripts": {
+    "postinstall": "node install-skill.js",
+    "preuninstall": "node uninstall-skill.js",
+    "test": "node install-skill.js && echo 'Installation test completed. Check ~/.claude/skills/'",
+    "lint": "echo 'Add your linting commands here'"
+  },
+  "files": [
+    "SKILL.md",
+    "references/",
+    "src/",
+    "install-skill.js",
+    "uninstall-skill.js",
+    ".claude-skill.json",
+    "utils.js"
+  ],
+  "keywords": [
+    "claude-code",
+    "skill",
+    "ai-assistant",
+    "agent-skill",
+    "claude",
+    "weekly-report",
+    "git",
+    "commit-analyzer",
+    "automation"
+  ],
+  "author": "adonis",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Adonis0123/weekly-flow.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Adonis0123/weekly-flow/issues"
+  },
+  "homepage": "https://github.com/Adonis0123/weekly-flow#readme",
+  "engines": {
+    "node": ">=14.0.0"
+  }
+}

package/references/WEEKLY_REPORT_FORMAT.md

@@ -0,0 +1,116 @@
+# 周报格式规范
+
+## 角色定义
+
+你是一位专业的技术周报总结专家，擅长从 Git commit 记录或文字描述中提炼关键工作内容，生成简洁、结构化的周报摘要。
+
+## 任务目标
+
+将一周的工作内容（Git commit 记录截图或文字描述）提炼为结构化的周报总结。
+
+## 输入来源
+
+- **文字输入**：直接提供的工作内容描述
+- **Git 提交**：一周的 Git commit 提交记录
+
+## 输出格式
+
+使用 Markdown 格式，按项目分组，采用层级列表结构：
+
+```
+项目名称
+  - 主要工作点（必须，10 字以内，最长不超过 20 字）
+    - 补充说明（可选）
+      - 更详细的补充（可选）
+
+其他
+  - 不属于特定项目的工作内容
+```
+
+## 总结原则
+
+### 必须遵守
+
+1. **事实导向**：只总结实际完成的工作，不添加虚构或修饰性内容
+2. **简洁精炼**：主要工作点控制在 10 字以内，绝对不超过 20 字
+3. **重点突出**：只保留重要内容，过滤掉琐碎的修改
+4. **按项目分组**：相同项目的工作归类到一起
+5. **层级清晰**：用缩进表示内容的从属关系
+
+### 过滤规则
+
+以下类型的 commit 通常不需要单独列出：
+
+- 纯格式化/代码风格调整（除非是大规模重构）
+- 简单的 typo 修复
+- 依赖版本小幅更新（除非涉及重大升级）
+- 重复性的相似提交（合并为一条）
+- Merge commit
+
+### 合并规则
+
+- 相关联的多个小改动合并为一个主题
+- 同一功能的多次迭代合并为一条记录
+- 问题排查和解决归为一条
+
+## 输出示例
+
+### 示例 1
+
+```
+project-frontend
+  - 构建工具升级改造及问题排查
+  - 核心功能开发流程跟进
+    - 异常处理优化
+    - 方案合理性优化
+    - 问题边界定义
+  - 对话头像渲染
+  - 脚本国际化检查优化
+
+其他
+  - 新版国际化方案讨论
+```
+
+### 示例 2
+
+```
+project-backend
+  - 自定义类型化流式消息渲染
+  - 异常状态调试优化
+    - 支持 debug 模式
+    - 原始消息结构查看
+  - device id 修复及有效期处理
+  - 断线重连流程梳理
+
+其他
+  - 全局弹窗缺陷修复
+```
+
+### 示例 3
+
+```
+project-frontend
+  - 前后端分离方案跟进
+    - 拆分服务（web/admin/server）
+    - 统一转发代理消除跨域
+  - 活动页需求设计
+    - 支持免发版管理
+    - SDK 方案调通
+  - SEO 预渲染方案
+
+project-backend
+  - 断线重连方案实现
+    - 自动重试失败后提示刷新
+  - 依赖库升级尝试
+
+其他
+  - 多媒体资源运营管理方案讨论
+```
+
+## 注意事项
+
+1. 如果输入是图片，请仔细识别 commit 信息，按时间和项目归类
+2. commit message 中的技术术语可以保留，但要确保表述通顺
+3. 如有多个项目，按工作量或重要性排序
+4. "其他"分类用于放置不属于特定项目的工作内容
+5. 如果某周工作内容较少，如实反映即可，不需要刻意扩充

package/src/__init__.py

@@ -0,0 +1,3 @@
+"""Weekly Flow - Git 提交记录周报生成工具"""
+
+__version__ = "1.0.0"

package/src/config_manager.py

@@ -0,0 +1,171 @@
+"""配置管理模块
+
+管理周报工具的配置，包括仓库列表等。
+"""
+
+import json
+from pathlib import Path
+from typing import Any, Dict, List, Optional, Tuple
+
+
+# 默认配置
+DEFAULT_CONFIG: Dict[str, Any] = {
+    "repos": [],
+    "default_author": "auto",
+    "output_format": "markdown",
+}
+
+
+def get_config_path(base_dir: Optional[Path] = None) -> Path:
+    """获取配置文件路径
+
+    Args:
+        base_dir: 基础目录，默认为 ~/.weekly-reports
+
+    Returns:
+        配置文件路径
+    """
+    if base_dir is None:
+        base_dir = Path.home() / ".weekly-reports"
+
+    return base_dir / "config.json"
+
+
+def load_config(config_path: Optional[Path] = None) -> Dict[str, Any]:
+    """加载配置文件
+
+    Args:
+        config_path: 配置文件路径，默认为 ~/.weekly-reports/config.json
+
+    Returns:
+        配置字典
+    """
+    if config_path is None:
+        config_path = get_config_path()
+
+    if not config_path.exists():
+        return DEFAULT_CONFIG.copy()
+
+    try:
+        with open(config_path, "r", encoding="utf-8") as f:
+            config = json.load(f)
+            # 合并默认配置，确保所有字段都存在
+            return {**DEFAULT_CONFIG, **config}
+    except (json.JSONDecodeError, OSError):
+        return DEFAULT_CONFIG.copy()
+
+
+def save_config(
+    config: Dict[str, Any],
+    config_path: Optional[Path] = None,
+) -> None:
+    """保存配置文件
+
+    Args:
+        config: 配置字典
+        config_path: 配置文件路径
+    """
+    if config_path is None:
+        config_path = get_config_path()
+
+    # 确保父目录存在
+    config_path.parent.mkdir(parents=True, exist_ok=True)
+
+    with open(config_path, "w", encoding="utf-8") as f:
+        json.dump(config, f, indent=2, ensure_ascii=False)
+
+
+def add_repo(
+    config: Dict[str, Any],
+    name: str,
+    path: str,
+) -> Dict[str, Any]:
+    """添加仓库到配置
+
+    Args:
+        config: 配置字典
+        name: 仓库名称
+        path: 仓库路径
+
+    Returns:
+        更新后的配置
+    """
+    repos = config.get("repos", [])
+
+    # 检查是否已存在
+    for repo in repos:
+        if repo["name"] == name:
+            # 更新路径
+            repo["path"] = path
+            return config
+
+    # 添加新仓库
+    repos.append({"name": name, "path": path})
+    config["repos"] = repos
+
+    return config
+
+
+def remove_repo(config: Dict[str, Any], name: str) -> Dict[str, Any]:
+    """从配置中移除仓库
+
+    Args:
+        config: 配置字典
+        name: 仓库名称
+
+    Returns:
+        更新后的配置
+    """
+    repos = config.get("repos", [])
+    config["repos"] = [r for r in repos if r["name"] != name]
+    return config
+
+
+def get_repos(config: Dict[str, Any]) -> List[Dict[str, str]]:
+    """获取仓库列表
+
+    Args:
+        config: 配置字典
+
+    Returns:
+        仓库列表
+    """
+    return config.get("repos", [])
+
+
+def validate_repo(path: Path) -> Tuple[bool, Optional[str]]:
+    """验证仓库路径是否有效
+
+    Args:
+        path: 仓库路径
+
+    Returns:
+        (is_valid, error_message)
+    """
+    if isinstance(path, str):
+        path = Path(path)
+
+    if not path.exists():
+        return False, f"路径不存在: {path}"
+
+    if not path.is_dir():
+        return False, f"路径不是目录: {path}"
+
+    git_dir = path / ".git"
+    if not git_dir.exists():
+        return False, f"不是有效的 Git 仓库: {path}"
+
+    return True, None
+
+
+def get_repo_paths(config: Dict[str, Any]) -> List[Path]:
+    """获取所有仓库路径
+
+    Args:
+        config: 配置字典
+
+    Returns:
+        仓库路径列表
+    """
+    repos = get_repos(config)
+    return [Path(r["path"]) for r in repos]