explore-module

Module Explorer

Please help me deeply understand this module: $MODULE_PATH

Exploration depth: ${DEPTH:-3} Focus areas: ${FOCUS:-all aspects}

Module Analysis

1. Get module overview:

   # Show module structure
   ch ctx focus "$MODULE_PATH" ${DEPTH:-3}
   
   # List all files
   find "$MODULE_PATH" -type f -name "*.${EXT:-js|ts|py}" | head -20
   

2. Understand module boundaries:

   # Find entry points
   chs find-file "index.*" "$MODULE_PATH"
   
   # Look for main exports
   chs find-code "export|module.exports" "$MODULE_PATH"
   

3. Trace dependencies:

   # What does this module import?
   ch cr imports-of "$MODULE_PATH/index.${EXT:-js}"
   
   # Generate dependency tree
   ch cr dependency-tree "$MODULE_PATH"
   
   # Check for circular dependencies
   ch cr circular "$MODULE_PATH"
   

4. Find who uses this module:

   # Who imports this module?
   ch cr imported-by "$MODULE_PATH"
   
   # Search for direct references
   MODULE_NAME=$(basename "$MODULE_PATH")
   chs find-code "from.*$MODULE_NAME|import.*$MODULE_NAME"
   

5. Locate tests:

   # Find test files
   chs find-file "*.test.*|*.spec.*" "$MODULE_PATH"
   
   # Find tests in other locations
   chs find-code "$MODULE_NAME" --include "*.test.*"
   

6. Check documentation:

   # Find docs
   chs find-file "*.md" "$MODULE_PATH"
   
   # Look for inline documentation
   chs find-code "^\\s*\\*|^\\s*/\\*\\*|@param|@returns" "$MODULE_PATH"
   

7. Analyze code quality:

   # Check complexity
   ch cq large-files 200 "$MODULE_PATH"
   
   # Find TODOs
   ch cq todos "$MODULE_PATH"
   

Key Questions

1. Architecture:

   • What is the module's primary responsibility?
   • How does it fit into the overall architecture?
   • Are there clear boundaries and interfaces?

2. Dependencies:

   • What are the external dependencies?
   • Are there any concerning coupling issues?
   • Could this module be easily extracted/reused?