github_analyzer 0.1.0

github_analyzer: ^0.1.0 copied to clipboard

example/example.dart

/// Example demonstrating the usage of github_analyzer package
///
/// This example shows:
/// - Basic repository analysis
/// - LLM-optimized markdown generation
/// - Custom configuration
/// - Cache control
/// - Progress tracking

import 'package:github_analyzer/github_analyzer.dart';

void main() async {
  print('🚀 GitHub Analyzer Examples\n');

  // Example 1: Quick Analysis
  await example1_quickAnalysis();

  // Example 2: LLM-Optimized Analysis with Markdown Generation
  await example2_llmOptimized();

  // Example 3: Advanced Configuration
  await example3_advancedConfig();

  // Example 4: Local Directory Analysis
  await example4_localAnalysis();

  // Example 5: Progress Tracking
  await example5_progressTracking();
}

/// Example 1: Quick analysis with minimal configuration
Future<void> example1_quickAnalysis() async {
  print('📝 Example 1: Quick Analysis\n');

  try {
    // Analyze a repository quickly
    final result = await analyzeQuick(
      'https://github.com/dart-lang/sdk',
    );

    print('✅ Analysis completed!');
    print('   Files: ${result.statistics.totalFiles}');
    print('   Lines: ${result.statistics.totalLines}');
    print('   Language: ${result.metadata.language}');
    print('   Size: ${_formatBytes(result.statistics.totalSize)}');
    print('');
  } catch (e) {
    print('❌ Error: $e\n');
  }
}

/// Example 2: Generate LLM-optimized markdown documentation
Future<void> example2_llmOptimized() async {
  print('📝 Example 2: LLM-Optimized Analysis\n');

  try {
    // Generate markdown file optimized for AI/LLM context
    final outputPath = await analyzeForLLM(
      'https://github.com/dart-lang/http',
      outputDir: './output',
      maxFiles: 50,
      markdownConfig: MarkdownConfig.compact,
    );

    print('✅ Markdown generated: $outputPath');
    print('');
  } catch (e) {
    print('❌ Error: $e\n');
  }
}

/// Example 3: Advanced configuration with cache control
Future<void> example3_advancedConfig() async {
  print('📝 Example 3: Advanced Configuration\n');

  try {
    // Create custom configuration
    final config = await GithubAnalyzerConfig.create(
      githubToken: null, // Will auto-load from .env if exists
      excludePatterns: [
        'test/**',
        'example/**',
        '*.g.dart',
      ],
      maxFileSize: 500 * 1024, // 500KB
      enableCache: true,
      maxTotalFiles: 100,
    );

    // Create analyzer instance
    final analyzer = await GithubAnalyzer.create(config: config);

    // Analyze with cache disabled (always fetch fresh data)
    final result = await analyzer.analyzeRemote(
      repositoryUrl: 'https://github.com/dart-lang/lints',
      useCache: false, // Disable cache for this request
    );

    print('✅ Analysis completed!');
    print('   Repository: ${result.metadata.fullName}');
    print('   Files analyzed: ${result.statistics.sourceFiles}');
    print('   Main files: ${result.mainFiles.join(", ")}');
    print('');

    // Don't forget to dispose
    await analyzer.dispose();
  } catch (e) {
    print('❌ Error: $e\n');
  }
}

/// Example 4: Analyze local directory
Future<void> example4_localAnalysis() async {
  print('📝 Example 4: Local Directory Analysis\n');

  try {
    // Analyze a local directory
    final result = await analyze(
      './lib', // Local path
      verbose: false,
    );

    print('✅ Local analysis completed!');
    print('   Total files: ${result.statistics.totalFiles}');
    print(
        '   Languages: ${result.statistics.languageDistribution.keys.join(", ")}');
    print('');
  } catch (e) {
    print('❌ Error: $e\n');
  }
}

/// Example 5: Track analysis progress
Future<void> example5_progressTracking() async {
  print('📝 Example 5: Progress Tracking\n');

  try {
    // Analyze with progress callback
    final result = await analyze(
      'https://github.com/flutter/samples',
      progressCallback: (progress) {
        final percentage = (progress.progress * 100).toStringAsFixed(0);
        print(
            '   ⏳ ${progress.phase.name}: $percentage% - ${progress.message}');
      },
    );

    print('✅ Analysis completed with progress tracking!');
    print('   Files: ${result.statistics.totalFiles}');
    print('');
  } catch (e) {
    print('❌ Error: $e\n');
  }
}

/// Helper function to format bytes
String _formatBytes(int bytes) {
  if (bytes < 1024) return '$bytes B';
  if (bytes < 1024 * 1024) return '${(bytes / 1024).toStringAsFixed(1)} KB';
  return '${(bytes / (1024 * 1024)).toStringAsFixed(1)} MB';
}