Project Auto Explorer 🚀
Project Auto Explorer is a VS Code and Cursor extension that automatically browses workspace files with human-like natural reading behaviors. Perfect for demos, live presentations, video recordings, display monitors, or passive code reviews.
✨ Features
- Automatic Workspace Browsing: Opens and explores files across your active workspace seamlessly.
- Smart Priority Ranking: Automatically prioritizes high-impact files first:
README.mdpackage.jsontsconfig.json.env.example- Key source directories (
src/*, app/*, components/*, lib/*)
- Dynamic File Queue Shuffling: Slightly randomizes files within priority tiers so exploration never feels static or identical.
- Natural Human Reading Behaviors:
- Variable Speed Scrolling: Smooth downward scrolling with natural speed variations.
- Random Reading Pauses: Pauses for 2–10 seconds at interesting code blocks.
- Micro Scroll-Ups: Occasionally steps up a few lines as if re-reading complex code.
- Section Jumps: Jumps to symbol signatures, function declarations, or Markdown headings mid-file.
- Dwell Time: Pauses at the bottom of a file before transitioning to the next.
- Smart Exclusion Rules: Automatically skips binary files, images, videos, node_modules, build output, git internal folders, and lockfiles.
- Full Playback Controls: Start, Pause, Resume, and Stop anytime via Command Palette or Status Bar.
- Live Status Bar Indicator: Displays current state (
Running, Paused, Stopped) and the active file name.
- Resource Efficient: Uses cancellation tokens and async timers to guarantee zero CPU/memory overhead when idle or stopped.
🎮 How to Use
Command Palette & Shortcuts
Open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P) or use the default keybinding:
Alt+Y: Toggle Auto Explore (Quickly pause or resume exploration at any moment)Project Auto Explorer: Start Auto ExploreProject Auto Explorer: Pause Auto ExploreProject Auto Explorer: Resume Auto ExploreProject Auto Explorer: Stop Auto ExploreProject Auto Explorer: Toggle Auto Explore (Pause/Resume)
Pause Preservation: When paused (via Alt+Y or status bar), your current file, exact line/cursor position, visible scroll location, and remaining file queue are preserved intact. Resuming (Alt+Y) continues scanning from the exact line without restarting or reloading!
Status Bar Control
Look at the bottom left of your VS Code status bar:
- Click
$(play) Auto Explore to start browsing.
- Click
$(sync~spin) Auto Explore: src/index.ts to pause.
- Click
$(pause) Auto Explore: Paused to resume.
⚙️ Configuration Settings
Customize Project Auto Explorer behavior in your VS Code settings.json or Extension Settings UI (Ctrl+,):
| Setting |
Type |
Default |
Description |
projectAutoExplorer.scrollSpeed |
string |
"normal" |
Base scrolling speed ("slow", "normal", "fast", "lightning"). |
projectAutoExplorer.pauseDurationMin |
number |
2 |
Minimum reading pause duration in seconds. |
projectAutoExplorer.pauseDurationMax |
number |
8 |
Maximum reading pause duration in seconds. |
projectAutoExplorer.maxTimePerFile |
number |
0 |
Max seconds per file before moving to next file (0 for full scroll). |
projectAutoExplorer.randomness |
number |
50 |
Jitter/micro-scroll/jump probability percentage (0-100). |
projectAutoExplorer.loopWorkspace |
boolean |
true |
Restart file queue automatically after completing all files. |
projectAutoExplorer.priorityPatterns |
array |
[...] |
Glob patterns of priority files/directories to visit first. |
projectAutoExplorer.excludePatterns |
array |
[...] |
Glob patterns of files/directories to skip completely. |
Project Auto Explorer adheres strictly to VS Code Extension API guidelines:
- All timers utilize
CancellationToken patterns.
- Calling Stop or closing VS Code immediately disposes all async loops and frees memory.
- No external native dependencies or third-party binary scripts.
🛠️ Local Packaging & Installation
To automatically compile, package into .vsix, and force-install the extension into your local VS Code instance:
npm run install-ext
📄 License
MIT License.
| |
