git-yike-logger-hook/example.js

A TypeScript Git hook plugin for automatically generating commit logs with TODO/WIP comment scanning

#!/usr/bin/env node

/**
 * 使用示例：演示如何使用 Git Logger Hook
 */

const { GitLogger } = require('./dist/index.js');

async function example() {
  console.log('🚀 Git Logger Hook 使用示例');
  console.log('===============================');

  try {
    // 创建日志记录器实例
    const logger = new GitLogger({
      logDir: '.git-logs',
      includeUnstaged: false,
      includeUntracked: false
    });

    // 生成日志
    console.log('📝 正在生成提交日志...');
    await logger.generateLog();

    // 读取所有日志
    console.log('📊 读取所有日志文件...');
    const logs = await logger.getAllLogs();
    console.log(`找到 ${logs.length} 个日志文件`);

    if (logs.length > 0) {
      console.log('\n📋 最新的提交日志:');
      console.log(JSON.stringify(logs[0], null, 2));
    }

    // 清理旧日志
    console.log('\n🧹 清理旧日志文件...');
    await logger.cleanupLogs(5); // 只保留最近5个

    console.log('\n✅ 示例执行完成！');
  } catch (error) {
    console.error('❌ 示例执行失败:', error);
  }
}

// 运行示例
if (require.main === module) {
  example();
}