Vscode - Telescope

Vscode - Telescope is a Visual Studio Code extension that provides a fast, interactive, and live file content search experience, inspired by Telescope for Neovim. It uses the power of ripgrep to deliver instant results and presents them in a clean, two-panel webview UI with a live code preview.

Features

• Live Search: Results appear as you type.
• Fast & Efficient: Powered by ripgrep for high-performance searching.
• Interactive UI:
  • A dedicated webview panel for searching.
  • A list of results showing the file, line number, and matching text.
  • A resizable preview panel with syntax highlighting that matches your current theme.
• Keyboard & Mouse Navigation:
  • Use ArrowUp/ArrowDown to navigate results and Enter to open the file.
  • Click an item to preview it, click it again to open.
• Syntax Highlighting: The preview panel uses shiki to provide accurate and theme-aware syntax highlighting.

Prerequisites

This extension requires the command-line tool ripgrep to be installed on your system and available in your system's PATH. ripgrep is the engine that powers the search functionality.

Installing ripgrep

• macOS (via Homebrew):

  brew install ripgrep
  

• Windows (via Chocolatey or Scoop):

  # Using Chocolatey
  choco install ripgrep
  
  # Using Scoop
  scoop install ripgrep
  

• Linux (Debian/Ubuntu):

  sudo apt-get install ripgrep
  

• Other Platforms: Please see the official ripgrep installation instructions.

To verify the installation, open a terminal and run rg --version. You should see the version number printed.

Installation

1. Open Visual Studio Code.
2. Go to the Extensions view (Ctrl+Shift+X or Cmd+Shift+X).
3. Search for "Vscode - Telescope".
4. Click "Install".

Alternatively, you can install it from the VS Code Marketplace. (Note: You will need to publish the extension to the marketplace for this link to work.)

Usage

1. Usage methods for VsCode - Telescope:

   • Press the keyboard shortcut: Ctrl+Alt+T (Windows/Linux) or Cmd+Alt+T (macOS).
   • Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P) and type "Telescope: Open Telescope Panel".

2. The "Telescope Search" panel will open. Start typing in the search box at the bottom.

3. Results will appear in the left panel as you type.

4. Navigate the results with your mouse or arrow keys to see a live preview in the right panel.

5. Press Enter or double-click a result to open the file and jump to the corresponding line.

Development & Testing

If you wish to contribute to the development of this extension, you can set up a local development environment.

Setup

1. Clone the repository:

   git clone https://github.com/TalhaAksoy/Telescope-Search
   cd TelescopeSearch
   

2. Install dependencies using yarn (as defined by the .yarnrc file):

   yarn install
   

Running the Extension Locally

1. Open the project folder in VS Code.
2. Press F5 to open a new Extension Development Host window with the extension running.
3. In the new window, open a project folder and use the "Telescope: Open Telescope Panel" command to test the extension.