YewIndex

English | 简体中文

🌲 YewIndex is a Visual Studio Code extension that helps you centralize and browse your local Git repositories and VS Code Workspaces.

Say goodbye to clicking through your file explorer to find projects. YewIndex provides a clear tree view of all scanned projects in VS Code, allowing you to quickly switch projects/workspaces with a single click without leaving your editor.

---

✨ Core Features

🌳 Git Repo Explorer

• Recursive Scanning: Configure multiple root directories (e.g., ~/Projects, D:\Work), and YewIndex will recursively find all Git repositories within them.
• Smart Recognition: Automatically identifies .git directories and .git files (supports submodules and worktrees).
• Tree View: Displays your repositories in a neat, hierarchical tree structure with state persistence (remembers expanded folders).
• Repository Preview: Preview repository README without switching your current window context.
• Quick Actions:
  • Open repository in a new window or current window.
  • Add repository folder to the current workspace.
  • Open in integrated terminal.
  • Copy repository path.
• Exclude Directories: Supports excluding specific dependency/output folders (e.g., node_modules). Common folders are excluded by default, and you can customize this in the settings.

🗂️ Workspace Explorer

• Workspace Discovery: Scans for .code-workspace files in configured paths.
• Rich Preview: Click a workspace to see a read-only preview without directly opening it.
  • View included folder list.
  • Browse workspace settings.
  • Check recommended extensions.
• One-Click Open: Click to open the workspace immediately.

🔍 Quick Search

• Global Search: Press Ctrl+Alt+P (Mac: Cmd+Alt+P) to instantly search and open any repository or workspace by name or path.

🕒 Recent History

• Activity Tracking: Automatically records repositories and workspaces you've accessed through YewIndex.
• Quick Access: Quickly jump back to your most used projects in the "Recent" view.

---

🚀 Quick Start

1. Install the extension from the Visual Studio Marketplace.
2. Click the YewIndex icon in the Activity Bar on the left.
3. Follow the guidance in the Repositories and Workspaces views to configure your project folders.
4. Wait for the scan to complete and enjoy an organized project view built right into VS Code!

---

⚙️ Extension Settings

YewIndex is highly configurable to fit your workflow. You can access these settings by going to File > Preferences > Settings and searching for YewIndex.

Repository Settings

• yewindex.repo.roots: List of root directories to scan for Git repositories.
• yewindex.repo.exclude: Glob patterns for directories to exclude during scanning (defaults include .git, node_modules, dist, etc.).
• yewindex.repo.showNested: Whether to display nested Git repositories (default: false).
• yewindex.repo.itemActivation: Behavior when clicking a repo item (singleClick or doubleClick).

Workspace Settings

• yewindex.workspace.roots: List of root directories to scan for .code-workspace files.
• yewindex.workspace.exclude: Glob patterns for directories to exclude.
• yewindex.workspace.itemActivation: Behavior when clicking a workspace item (preview, open, or previewOnly).
• yewindex.workspace.preview.openIn: Where to open the preview document (active editor or beside sidebar).

General Settings

• yewindex.open.targetWindow: Default behavior when opening a repo/workspace (newWindow, currentWindow, or auto).
• yewindex.recent.maxItems: Maximum number of items to keep in the Recent history.
• yewindex.refresh.mode: Auto-refresh strategy (onOpen, onFocus, interval, manual).
• yewindex.view.rememberExpandState: Whether to restore the expanded state of tree nodes on startup (default: true).

---

⌨️ Commands

Open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P) and type YewIndex to use the following commands:

• YewIndex: Search: Quick search for repositories and workspaces (Ctrl+Alt+P).
• YewIndex: Scan Repositories: Force a re-scan of repository roots.
• YewIndex: Scan Workspaces: Force a re-scan of workspace roots.
• YewIndex: Refresh Views: Refresh all views.
• YewIndex: Manage Repo Roots: Manage repository scanning roots.
• YewIndex: Manage Workspace Roots: Manage workspace scanning roots.

YewIndex currently has no plans for development of editing features. Instead, it focuses on browsing functionality. I believe that after opening a workspace in VS Code, using the native editing features directly is a better choice, so I won't reinvent the wheel.

🛠️ Build from Source

Requirements:

• Node.js (e.g., v18+)
• pnpm

1. Clone the repository:

   git clone https://github.com/YewFence/YewIndex.git
   cd YewIndex

2. Install dependencies:

   pnpm install

3. Compile the extension:

   pnpm run compile

4. Package into a VSIX file:

   pnpm run package

   This will generate a .vsix file in the root directory, which you can install in VS Code via "Install from VSIX...".

License

MIT