Implements Phase 1 of the codebase analysis UX improvement plan, making the command discoverable and adding intuitive preset flags while maintaining 100% backward compatibility. New Features: - Add 'analyze' subcommand to main CLI (skill-seekers analyze) - Add --quick preset: Fast analysis (1-2 min, basic features only) - Add --comprehensive preset: Full analysis (20-60 min, all features + AI) - Add --enhance flag: Simple AI enhancement with auto-detection - Improve help text with timing estimates and mode descriptions Files Modified: - src/skill_seekers/cli/main.py: Add analyze subcommand (lines 15, 273-311, 542-589) - src/skill_seekers/cli/codebase_scraper.py: Add preset logic and improve help text - tests/test_analyze_command.py: NEW - 20 comprehensive tests - tests/test_cli_paths.py: Fix version check (2.7.0 -> 2.7.2) - tests/test_package_structure.py: Fix 4 version checks (2.7.0 -> 2.7.2) - README.md: Update examples to use 'analyze' command - CLAUDE.md: Update examples to use 'analyze' command Test Results: - 81 tests related to Phase 1: ALL PASSING ✅ - 20 new tests for analyze command: ALL PASSING ✅ - Zero regressions introduced - 100% backward compatibility maintained Backward Compatibility: - Old 'skill-seekers-codebase' command still works - All existing flags (--depth, --ai-mode, --skip-*) still functional - No breaking changes Usage Examples: skill-seekers analyze --directory . --quick skill-seekers analyze --directory . --comprehensive skill-seekers analyze --directory . --enhance Fixes #262 (codebase UX issues) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
175 lines
6.8 KiB
Python
175 lines
6.8 KiB
Python
#!/usr/bin/env python3
|
|
"""Tests for analyze subcommand integration in main CLI."""
|
|
|
|
import sys
|
|
import unittest
|
|
from pathlib import Path
|
|
|
|
sys.path.insert(0, str(Path(__file__).parent.parent / "src"))
|
|
|
|
from skill_seekers.cli.main import create_parser
|
|
|
|
|
|
class TestAnalyzeSubcommand(unittest.TestCase):
|
|
"""Test analyze subcommand registration and argument parsing."""
|
|
|
|
def setUp(self):
|
|
"""Create parser for testing."""
|
|
self.parser = create_parser()
|
|
|
|
def test_analyze_subcommand_exists(self):
|
|
"""Test that analyze subcommand is registered."""
|
|
args = self.parser.parse_args(["analyze", "--directory", "."])
|
|
self.assertEqual(args.command, "analyze")
|
|
self.assertEqual(args.directory, ".")
|
|
|
|
def test_analyze_with_output_directory(self):
|
|
"""Test analyze with custom output directory."""
|
|
args = self.parser.parse_args(["analyze", "--directory", ".", "--output", "custom/"])
|
|
self.assertEqual(args.output, "custom/")
|
|
|
|
def test_quick_preset_flag(self):
|
|
"""Test --quick preset flag parsing."""
|
|
args = self.parser.parse_args(["analyze", "--directory", ".", "--quick"])
|
|
self.assertTrue(args.quick)
|
|
self.assertFalse(args.comprehensive)
|
|
|
|
def test_comprehensive_preset_flag(self):
|
|
"""Test --comprehensive preset flag parsing."""
|
|
args = self.parser.parse_args(["analyze", "--directory", ".", "--comprehensive"])
|
|
self.assertTrue(args.comprehensive)
|
|
self.assertFalse(args.quick)
|
|
|
|
def test_quick_and_comprehensive_mutually_exclusive(self):
|
|
"""Test that both flags can be parsed (mutual exclusion enforced at runtime)."""
|
|
# The parser allows both flags; runtime logic prevents simultaneous use
|
|
args = self.parser.parse_args(["analyze", "--directory", ".", "--quick", "--comprehensive"])
|
|
self.assertTrue(args.quick)
|
|
self.assertTrue(args.comprehensive)
|
|
# Note: Runtime will catch this and return error code 1
|
|
|
|
def test_enhance_flag(self):
|
|
"""Test --enhance flag parsing."""
|
|
args = self.parser.parse_args(["analyze", "--directory", ".", "--enhance"])
|
|
self.assertTrue(args.enhance)
|
|
|
|
def test_skip_flags_passed_through(self):
|
|
"""Test that skip flags are recognized."""
|
|
args = self.parser.parse_args([
|
|
"analyze",
|
|
"--directory", ".",
|
|
"--skip-patterns",
|
|
"--skip-test-examples"
|
|
])
|
|
self.assertTrue(args.skip_patterns)
|
|
self.assertTrue(args.skip_test_examples)
|
|
|
|
def test_all_skip_flags(self):
|
|
"""Test all skip flags are properly parsed."""
|
|
args = self.parser.parse_args([
|
|
"analyze",
|
|
"--directory", ".",
|
|
"--skip-api-reference",
|
|
"--skip-dependency-graph",
|
|
"--skip-patterns",
|
|
"--skip-test-examples",
|
|
"--skip-how-to-guides",
|
|
"--skip-config-patterns"
|
|
])
|
|
self.assertTrue(args.skip_api_reference)
|
|
self.assertTrue(args.skip_dependency_graph)
|
|
self.assertTrue(args.skip_patterns)
|
|
self.assertTrue(args.skip_test_examples)
|
|
self.assertTrue(args.skip_how_to_guides)
|
|
self.assertTrue(args.skip_config_patterns)
|
|
|
|
def test_backward_compatible_depth_flag(self):
|
|
"""Test that deprecated --depth flag still works."""
|
|
args = self.parser.parse_args(["analyze", "--directory", ".", "--depth", "full"])
|
|
self.assertEqual(args.depth, "full")
|
|
|
|
def test_depth_flag_choices(self):
|
|
"""Test that depth flag accepts correct values."""
|
|
for depth in ["surface", "deep", "full"]:
|
|
args = self.parser.parse_args(["analyze", "--directory", ".", "--depth", depth])
|
|
self.assertEqual(args.depth, depth)
|
|
|
|
def test_languages_flag(self):
|
|
"""Test languages flag parsing."""
|
|
args = self.parser.parse_args(["analyze", "--directory", ".", "--languages", "Python,JavaScript"])
|
|
self.assertEqual(args.languages, "Python,JavaScript")
|
|
|
|
def test_file_patterns_flag(self):
|
|
"""Test file patterns flag parsing."""
|
|
args = self.parser.parse_args(["analyze", "--directory", ".", "--file-patterns", "*.py,src/**/*.js"])
|
|
self.assertEqual(args.file_patterns, "*.py,src/**/*.js")
|
|
|
|
def test_no_comments_flag(self):
|
|
"""Test no-comments flag parsing."""
|
|
args = self.parser.parse_args(["analyze", "--directory", ".", "--no-comments"])
|
|
self.assertTrue(args.no_comments)
|
|
|
|
def test_verbose_flag(self):
|
|
"""Test verbose flag parsing."""
|
|
args = self.parser.parse_args(["analyze", "--directory", ".", "--verbose"])
|
|
self.assertTrue(args.verbose)
|
|
|
|
def test_complex_command_combination(self):
|
|
"""Test complex command with multiple flags."""
|
|
args = self.parser.parse_args([
|
|
"analyze",
|
|
"--directory", "./src",
|
|
"--output", "analysis/",
|
|
"--quick",
|
|
"--languages", "Python",
|
|
"--skip-patterns",
|
|
"--verbose"
|
|
])
|
|
self.assertEqual(args.directory, "./src")
|
|
self.assertEqual(args.output, "analysis/")
|
|
self.assertTrue(args.quick)
|
|
self.assertEqual(args.languages, "Python")
|
|
self.assertTrue(args.skip_patterns)
|
|
self.assertTrue(args.verbose)
|
|
|
|
def test_directory_is_required(self):
|
|
"""Test that directory argument is required."""
|
|
with self.assertRaises(SystemExit):
|
|
self.parser.parse_args(["analyze"])
|
|
|
|
def test_default_output_directory(self):
|
|
"""Test default output directory value."""
|
|
args = self.parser.parse_args(["analyze", "--directory", "."])
|
|
self.assertEqual(args.output, "output/codebase/")
|
|
|
|
|
|
class TestAnalyzePresetBehavior(unittest.TestCase):
|
|
"""Test preset flag behavior and argument transformation."""
|
|
|
|
def setUp(self):
|
|
"""Create parser for testing."""
|
|
self.parser = create_parser()
|
|
|
|
def test_quick_preset_implies_surface_depth(self):
|
|
"""Test that --quick preset should trigger surface depth."""
|
|
args = self.parser.parse_args(["analyze", "--directory", ".", "--quick"])
|
|
self.assertTrue(args.quick)
|
|
# Note: Depth transformation happens in dispatch handler
|
|
|
|
def test_comprehensive_preset_implies_full_depth(self):
|
|
"""Test that --comprehensive preset should trigger full depth."""
|
|
args = self.parser.parse_args(["analyze", "--directory", ".", "--comprehensive"])
|
|
self.assertTrue(args.comprehensive)
|
|
# Note: Depth transformation happens in dispatch handler
|
|
|
|
def test_enhance_flag_standalone(self):
|
|
"""Test --enhance flag can be used without presets."""
|
|
args = self.parser.parse_args(["analyze", "--directory", ".", "--enhance"])
|
|
self.assertTrue(args.enhance)
|
|
self.assertFalse(args.quick)
|
|
self.assertFalse(args.comprehensive)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|