René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Feature Request: Refactor Configuration Architecture for Better CLI/Library Separation","articleBody":"## Summary\nRefactor the current parameter-passing approach to use a layered configuration pattern that cleanly separates CLI concerns from core analysis configuration, improving both library usability and maintainability.\n\n## Current State\nThe `Codeanalyzer` class currently accepts individual parameters in its constructor:\n```python\nwith Codeanalyzer(\n    input, analysis_level, using_codeql, rebuild_analysis, cache_dir, clear_cache\n) as analyzer:\n```\n\nThis approach has several limitations:\n- **Library users** must pass CLI-specific parameters (like `clear_cache`)\n- **Parameter explosion** as new options are added\n- **Tight coupling** between CLI and core analysis logic\n- **Hard to test** - requires mocking many individual parameters\n- **No validation** of parameter combinations\n- **No config file support** - difficult to extend\n\n## Proposed Solution\n\n### 1. Core Configuration Object\nCreate an `AnalysisOptions` class that contains only analysis-relevant settings:\n\n```python\n@dataclass\nclass AnalysisOptions:\n    input_path: Path\n    analysis_level: int = 1\n    using_codeql: bool = False\n    rebuild_analysis: bool = False\n    cache_dir: Optional[Path] = None\n    \n    def validate(self):\n        # Centralized validation logic\n        pass\n    \n    @classmethod\n    def from_dict(cls, config: dict):\n        # Support for config files\n        pass\n```\n\n### 2. CLI Configuration Layer\nCreate a `CLIOptions` class for CLI-specific concerns:\n\n```python\n@dataclass\nclass CLIOptions:\n    output_dir: Optional[Path] = None\n    output_format: OutputFormat = OutputFormat.JSON\n    verbosity: int = 0\n    clear_cache: bool = True\n    \n    def setup_logging(self):\n        # Handle CLI-specific setup\n        pass\n```\n\n### 3. Updated Core Interface\nModify `Codeanalyzer` to accept the configuration object:\n\n```python\nclass Codeanalyzer:\n    def __init__(self, options: AnalysisOptions):\n        self.options = options\n        # Clean, single source of configuration\n```\n\n## Benefits\n\n### For Library Users\n- **Clean API**: Single configuration object instead of many parameters\n- **Type Safety**: Better IDE support and validation\n- **Extensibility**: Easy to add new options without breaking existing code\n- **Testability**: Simple to create test configurations\n\n```python\n# Clean library usage\noptions = AnalysisOptions(\n    input_path=Path(\"my_project\"),\n    analysis_level=2,\n    using_codeql=True\n)\nwith Codeanalyzer(options) as analyzer:\n    results = analyzer.analyze()\n```\n\n### For CLI Users\n- **No breaking changes**: CLI interface remains the same\n- **Better error messages**: Centralized validation\n- **Future extensibility**: Config file support, presets, etc.\n\n### For Maintainers\n- **Separation of concerns**: CLI logic separate from analysis logic\n- **Easier testing**: Mock configuration objects instead of individual parameters\n- **Better validation**: Centralized parameter validation and type checking\n- **Extensibility**: Easy to add features like config files, environment variables\n\n## Backward Compatibility\n- CLI interface remains unchanged\n- Library interface change is breaking, but provides clear migration path\n- Consider deprecation warnings for old constructor signature\n\n## Testing Strategy\n- Unit tests for configuration validation\n- Integration tests for CLI/library interfaces\n- Test configuration serialization/deserialization\n- Test error handling and validation\n\n## Success Metrics\n- Reduced coupling between CLI and core analysis\n- Improved library API usability\n- Foundation for future configuration enhancements\n- Better test coverage of configuration logic\n\n## References\nSimilar patterns used successfully in:\n- MyPy (`mypy.options.Options`)\n- Black (`black.FileMode`)\n- Pylint (`pylint.config.Configuration`)\n- WALA (`AnalysisOptions`)","author":{"url":"https://github.com/rahlk","@type":"Person","name":"rahlk"},"datePublished":"2025-07-11T17:23:22.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/12/codeanalyzer-python/issues/12"}